diff options
author | Chris Johns <chrisj@rtems.org> | 2020-08-11 13:40:41 +1000 |
---|---|---|
committer | Chris Johns <chrisj@rtems.org> | 2020-08-12 11:09:44 +1000 |
commit | 967999b99660dcb40f943da0e0da7791e764edbe (patch) | |
tree | b317c1575d75fdfc1a71e08c41b33d1cf2f0cd74 /user/rsb/commands.rst | |
parent | user, README: Add Python script host set up information (diff) | |
download | rtems-docs-967999b99660dcb40f943da0e0da7791e764edbe.tar.bz2 |
user: Add the RSB sb-track command
Updates #4036
Diffstat (limited to '')
-rw-r--r-- | user/rsb/commands.rst | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/user/rsb/commands.rst b/user/rsb/commands.rst index 04d3cea..4048568 100644 --- a/user/rsb/commands.rst +++ b/user/rsb/commands.rst @@ -295,3 +295,84 @@ The ``arguments`` are a list of build sets to build. ``--list-deps``: Print a list of dependent files used by a build set. Dependent files have a ``dep[?]` prefix where ``?`` is a number. The files are listed alphabetically. + +Track (sb-track) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This command checks build sets and configurations reporting any errors, the +dependencies and which files are referenced. The command can list all the +configuration files not referenced. If this option is used when checking all +build set files a list of all configuration files not referenced can be +found. The list can be used to purge the RSB of old and unused configurations. + +The check runs a build set through a number of host configurations. This +checks any logic that is specific to a host. + +The command reports a dependency tree for a build set in the output +report. For example the dependency tree for the ``database/sqlite`` build set +is: + +.. code-block:: none + + +-- rtems/config/databases/sqlite.bset + +-- rtems/config/databases/sqlite-3.31.1-1.cfg + +-- rtems/config/rtems-bsp.cfg + +-- source-builder/config/sqlite-3-1.cfg + +-- rtems/config/rtems-package.bset + +-- rtems/config/rtems-urls.bset + +-- rtems/config/rtems-version.bset + +The comnmand is: + +.. code-block:: none + + $ ../source-builder/sb-track --help + usage: sb-dep-check [-h] [--rtems-version RTEMS_VERSION] [--list-hosts] + [--list-bsets] [--output OUTPUT] [--log LOG] [--trace] + [--not-referenced] + [bsets [bsets ...]] + + RTEMS Track Dependencies a build set has for all hosts. + + positional arguments: + bsets Build sets. + + optional arguments: + -h, --help show this help message and exit + --rtems-version RTEMS_VERSION + Set the RTEMS version. + --list-hosts List the hosts. + --list-bsets List the hosts. + --output OUTPUT Output file. + --log LOG Log file. + --trace Enable trace logging for debugging. + --not-referenced Write out the list of config files not referenced. + +The ``bsets`` are a list of build sets to check. If none are provided all +build sets are checked. + +**Options**: + +``-h, --help``: + The command's help. + +``--rtems-version``: + Set the RTEMS version number. + +``--list-hosts``: + List the hosts each build set of check against. + +``--list-bsets``: + List all the build set files. + +``--output``: + Write the report to the output file. + +``--log``: + The log file the build set check processing is written too. + +``--trace``: + Enable trace debugging. + +``--not-referenced``: + List the configration files not referenced by a build set in the output. |