user/rsb: describe how to create configuration reports

Closes #3629.
This commit is contained in:
Gedare Bloom 2020-04-04 22:39:13 -06:00
parent c9cb173eb7
commit cbdfde035a

View File

@ -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.
Report Mailing
^^^^^^^^^^^^^^
Configuration Reports
^^^^^^^^^^^^^^^^^^^^^
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:
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
~~~~~~~~~~~~~~
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