diff options
Diffstat (limited to 'user/rsb/commands.rst')
| -rw-r--r-- | user/rsb/commands.rst | 121 |
1 files changed, 81 insertions, 40 deletions
diff --git a/user/rsb/commands.rst b/user/rsb/commands.rst index b85692d..4048568 100644 --- a/user/rsb/commands.rst +++ b/user/rsb/commands.rst @@ -199,22 +199,22 @@ The ``arguments`` are a list of build sets to build. Path to the configuration directory. This overrides the built in defaults. ``--builddir path``: - Path to the build directory. This overrides the default of +build+. + Path to the build directory. This overrides the default of `build`. ``--sourcedir path``: - Path to the source directory. This overrides the default of +source+. + Path to the source directory. This overrides the default of `source`. ``--patchdir path``: - Path to the patches directory. This overrides the default of +patches+. + Path to the patches directory. This overrides the default of `patches`. ``--tmppath path``: - Path to the temporary directory. This overrides the default of +tmp+. + Path to the temporary directory. This overrides the default of `tmp`. ``--macros files``: Macro files to load. The configuration directory path is searched. ``--log file``: - Log all the output from the build process. The output is directed to +stdout+ + Log all the output from the build process. The output is directed to `stdout` if no log file is provided. ``--url url``: @@ -296,42 +296,83 @@ The ``arguments`` are a list of build sets to build. 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. -Set Builder (sb-builder) -^^^^^^^^^^^^^^^^^^^^^^^^ +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. -This command builds a configuration as described in a configuration -file. Configuration files have the extension of ``.cfg``: +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 - $ ./source-builder/sb-builder --help - sb-builder: [options] [args] - RTEMS Source Builder, an RTEMS Tools Project (c) 2012 Chris Johns - Options and arguments: - --force : Force the build to proceed - --quiet : Quiet output (not used) - --trace : Trace the execution - --dry-run : Do everything but actually run the build - --warn-all : Generate warnings - --no-clean : Do not clean up the build tree - --always-clean : Always clean the build tree, even with an error - --jobs : Run with specified number of jobs, default: num CPUs. - --host : Set the host triplet - --build : Set the build triplet - --target : Set the target triplet - --prefix path : Tools build prefix, ie where they are installed - --topdir path : Top of the build tree, default is $PWD - --configdir path : Path to the configuration directory, default: ./config - --builddir path : Path to the build directory, default: ./build - --sourcedir path : Path to the source directory, default: ./source - --patchdir path : Path to the patches directory, default: ./patches - --tmppath path : Path to the temp directory, default: ./tmp - --macros file[,[file] : Macro format files to load after the defaults - --log file : Log file where all build out is written too - --url url[,url] : URL to look for source - --targetcflags flags : List of C flags for the target code - --targetcxxflags flags : List of C++ flags for the target code - --libstdcxxflags flags : List of C++ flags to build the target libstdc++ code - --with-<label> : Add the --with-<label> to the build - --without-<label> : Add the --without-<label> to the build - --list-configs : List available configurations + +-- 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. |