summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGedare Bloom <gedare@rtems.org>2020-04-04 22:39:13 -0600
committerGedare Bloom <gedare@rtems.org>2020-04-05 14:54:27 -0600
commitcbdfde035ac9073e503bb2744ccb580f8f126a64 (patch)
tree679759291e3483ccdaab20a6db8be27b4974a446
parentc9cb173eb798238ce614cddd53b0fdf5a0cf0a05 (diff)
downloadrtems-docs-cbdfde035ac9073e503bb2744ccb580f8f126a64.tar.bz2
user/rsb: describe how to create configuration reports
Closes #3629.
-rw-r--r--user/rsb/configuration.rst21
1 files changed, 18 insertions, 3 deletions
diff --git a/user/rsb/configuration.rst b/user/rsb/configuration.rst
index 8d0ac14..6e4d3b9 100644
--- a/user/rsb/configuration.rst
+++ b/user/rsb/configuration.rst
@@ -365,11 +365,26 @@ points to are loaded. The second is a file called ``.rsb_macros`` in your home
directory. You need to have the environment variable ``HOME`` defined for this
work.
+Configuration Reports
+^^^^^^^^^^^^^^^^^^^^^
+
+A configuration report detailing a build configuration is generated by the
+``sb-set-builder`` command. The report can also be generated separately from
+the build process by invoking the ``sb-report`` command on the build set used
+for the build, for example:
+
+.. code-block:: shell
+
+ cd rtems
+ ../source-builder/sb-reports 5/rtems-sparc
+ less 5-rtems-sparc.txt
+
Report Mailing
-^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~
-The build reports can be mailed to a specific email address to logging and
-monitoring. Mailing requires a number of parameters to function. These are:
+Configuration reports from a build can be mailed to a specific email address
+for logging and monitoring. Mailing requires a number of parameters to
+function. These are:
- To mail address