Update for issue #1722 (#1849)

Documentation clean-up and ensuring packchk tool documentation is visible for the end user.

Author: KeilChris

tools/README.md

@@ -3,56 +3,24 @@
 These command-line tools provide the foundation for Open-CMSIS-Pack-based software development flows and are part of
 the [**CMSIS-Toolbox**](https://github.com/Open-CMSIS-Pack/cmsis-toolbox).
 
-**Package creation and validation**:
+## SVD file validation
 
-- [**packgen**](./packgen): create a software pack from a `CMake` based software repository.
-- [**packchk**](./packchk): semantic validation of a software pack description and the archive content.
+- [**svdconv**](https://open-cmsis-pack.github.io/svd-spec/main/svd_SVDConv_pg.html) validates CMSIS-SVD files and
+  generates CMSIS-compliant device header files.
 
-**Package management** including discovery of components, devices, boards and examples:
+## Package creation and validation
 
-- [**cpackget**](./cpackget): download, add, and remove packs and local repositories.
+- [**packgen**](./packgen/README.md) creates a software pack from a `CMake` based software repository.
+- [**packchk**](./packchk/README.md) validates a software pack description and the archive content.
+- [**gen-pack**](https://github.com/Open-CMSIS-Pack/gen-pack) is a library with helper function to assemble a
+  `gen_pack.sh` script that creates a Open-CMSIS-Pack.
 
-**Project management** for constructing projects from local files and software components:
+## Project management
 
-- [**csolution**](projmgr/docs/Manual/Overview.md): manage complex applications with `*.yaml` user input files and
-  content from CMSIS-Packs; output `*.cprj` files for reproducible builds using [**cbuild**](./buildmgr/cbuild) in
-  IDEs and CI environments.
+- [**csolution**](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/build-tools.md#csolution-invocation)
+  creates build information for embedded applications that consist of one or more related projects.
 
-**Build management** to compile and generate executable program images:
+## Build management
 
-- [**cbuild**](./buildmgr/cbuild) (aka CMSIS-Build): convert a `*.cprj` file that describes a single target and
-  configuration of a project to a `CMake` input; start the build process.
-
-## CMSIS-Toolbox - Download and Install
-
-The **CMSIS-Toolbox** is currently under development but supports already a wide range of use cases.
-
-- [**Download CMSIS-Toolbox**](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/releases)
-- [**Setup and Installation**](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/installation.md)
-- [**Implementation Progress**](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/progress.md)
-
-## Development Cycle - Create Applications
-
-The tools of the CMSIS-Toolbox provide a command-line interface for creating application projects that are based on
-software packs. An IDE that supports import and export of
-`*.cprj` project files is included for completeness.
-
-Discover packs for an application by using a [*catalog of software packs*](https://www.keil.com/dd2/pack). These packs
-may be installed using [**cpackget**](./cpackget) and by
-[**csolution**](projmgr/docs/Manual/Overview.md), for example to list devices or software components. Along with user
-code, these items are used to describe the application project in `*.csolution.yml` and `cproject.yml` format and
-convert it with [**csolution**](projmgr/docs/Manual/Overview.md) into `*.cprj` files.
-
-These `*.cprj` files describe a reproducible build and are the input for [**cbuild**](./buildmgr/cbuild). Using
-different `target-types` at the `*.csolution.yml`-level allows to create applications that run on  hardware boards or
-simulation models (Arm Virtual Hardware).
-
-## Development Cycle - Software Packs
-
-CMSIS software packs may be created from a CMake based repository with [**packgen**](./packgen) or
-directly described in the `*.PDSC` format. These packs should be verified for consistency with
-[**packchk**](./packchk) before publishing in a vendor index (`*.vidx`) file.
-
-Once the pack is published, it can be listed in a [*catalog of software packs*](https://www.keil.com/dd2/pack) for being
-discovered by developers. With [**cpackget**](./cpackget) these packs can be installed local and used to
-create the application program as described above.
+- [**cbuild**](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/build-tools.md#cbuild-invocation)
+  orchestrates the overall build steps utilizing the various tools of the CMSIS-Toolbox and a CMake-based compilation process.

tools/buildmgr/README.md

@@ -6,11 +6,12 @@ the [CMSIS-Toolbox](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/d
 
 `packchk` performs the following operations:
 
+- Checks the `*.pdsc` file against the PACK.xsd schema file in the installation path.
 - Reads the content of the specified `*.pdsc` file. The path to this `*.pdsc`  file is considered as root directory of
   the Software Pack.
 - Verifies the existence of all files in the Software Pack that are referenced  in the `*.pdsc` file.
 - Checks for presence and correctness of mandatory elements such as `<vendor>`,  `<version>`, etc. - Optionally, reads
-  other PDSC files to resolve dependencies on `<apis>`,  `<boards>`, and `<conditions>`.
+  other `*.pdsc` files to resolve dependencies on `<apis>`,  `<boards>`, and `<conditions>`.
 - Optionally, verifies the element `<url>`.
 - Optionally, composes the versioned pack ID from the information contained in the PDSC:
   `package:vendor.package:name.release.latest:version`
@@ -21,25 +22,26 @@ the [CMSIS-Toolbox](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/d
 ## Usage
 
 ```bash
- packchk [-V] [--version] [-h] [--help]
-          [OPTIONS...] <PDSC file>
-
- packchk options:
-  -i, --include arg           PDSC file(s) as dependency reference
-  -b, --log arg               Log file
-  -x, --diag-suppress arg     Suppress Messages
-  -s, --xsd arg               Specify PACK.xsd path.
-  -v, --verbose               Verbose mode. Prints extra process information
-  -w, --warning arg           Warning level [0|1|2|3|all] (default: all)
-  -u, --url arg               Verifies that the specified URL matches with the <url>
-                              element in the *.PDSC file (default: "")
-  -n, --name arg              Text file for pack file name (default: "")
-  -V, --version               Print version
-  -h, --help                  Print usage
-      --disable-validation    Disable the pdsc validation against the PACK.xsd
-      --allow-suppress-error  Allow to suppress error messages
-      --break                 Debug halt after start
-      --ignore-other-pdsc     Ignores other PDSC files in working folder
+packchk [-V] [--version] [-h] [--help]
+         [OPTIONS...] <PDSC file>
+
+packchk options:
+ -i, --include arg           PDSC file(s) as dependency reference
+ -b, --log arg               Log file
+ -x, --diag-suppress arg     Suppress Messages
+ -s, --xsd arg               Specify PACK.xsd path.
+ -v, --verbose               Verbose mode. Prints extra process information
+ -w, --warning arg           Warning level [0|1|2|3|all] (default: all)
+ -u, --url arg               Verifies that the specified URL matches with the 
+                             <url> element in the *.PDSC file (default: "")
+ -n, --name arg              Text file for pack file name (default: "")
+ -V, --version               Print version
+ -h, --help                  Print usage
+     --disable-validation    Disable the pdsc validation against the PACK.xsd.
+     --allow-suppress-error  Allow to suppress error messages
+     --break                 Debug halt after start
+     --ignore-other-pdsc     Ignores other PDSC files in working folder
+     --pedantic              Return with error value on warning
 ```
 
 ## Quick Start
@@ -55,8 +57,8 @@ pack required for integration tests.
 
 ### Usage Examples
 
-Run `packchk` on the package description file called MyVendor.MyPack.pdsc.
-It verifies the file against the Software Pack that is located in the same directory.
+Run `packchk` on the package description file called `MyVendor.MyPack.pdsc`.
+It runs a schema check and verifies the file against the Software Pack that is located in the same directory.
 
 ```bash
 packchk MyVendor.MyPack.pdsc

tools/packchk/README.md

@@ -17,11 +17,11 @@ the [CMSIS-Toolbox](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/d
  dependencies have been installed. It is a requirement to be able to
  successfully run the CMake generation step in the current environment.
 
-For validating and compressing pack files, the `packchk` and `7z` utilities
+For validating and compressing pack files, the `packchk` and `7-zip` utilities
 shall be in the `PATH` system environment variable:
 
-- packchk: <https://github.com/Open-CMSIS-Pack/devtools/releases/tag/tools/packchk/1.3.96>
-- 7z: <https://www.7-zip.org/>
+- [packchk](https://github.com/Open-CMSIS-Pack/devtools/releases/tag/tools%2Fpackchk%2F1.4.1)
+- [7-zip](https://www.7-zip.org/)
 
 ## Usage
 

tools/packgen/README.md

@@ -1,3 +1,4 @@
+
 # csolution: Proposals (on hold)
 
 <!-- markdownlint-disable MD013 -->