Changeset 5a546fa in rtems-source-builder


Ignore:
Timestamp:
Apr 30, 2013, 3:22:44 AM (6 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.10, 4.11, 4.9, master
Children:
a48a478
Parents:
fbb39e7
Message:

Add mail and personal macros.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/source-builder.txt

    rfbb39e7 r5a546fa  
    827827map setting of the macro file including the other macro files does not change.
    828828
     829Personal Macros
     830^^^^^^^^^^^^^^^
     831
     832When the tools start to run they will load personal macros. Personal macros are
     833in the standard format for macros in a file. There are two places personal
     834macros can be configured. The first is the environment variable
     835`RSB_MACROS`. If presentthe macros from the file the environment variable
     836points to are loaded. The second is a file called `.rsb_macros` in your home
     837directory. You need to have the environment variable `HOME` defined for this
     838work.
     839
     840Report Mailing
     841~~~~~~~~~~~~~~
     842
     843The build reports can be mailed to a specific email address to logging and
     844monitoring. Mailing requires a number of parameters to function. These are:
     845
     846. To mail address
     847. From mail address
     848. SMTP host
     849
     850.To Mail Address
     851
     852The +to+ mail address is taken from the macro `%{_mail_tools_to}` and the
     853default is _rtems-tooltestresults at rtems.org_. You can override the default
     854with a personal or user macro file or via the command line option _--mail-to_.
     855
     856.From Mail Address
     857
     858The +from+ mail address is taken from:
     859
     860. GIT configuration
     861. User `.mailrc` file
     862. Command line
     863
     864If you have configured an email and name in git it will be used used. If you do
     865not a check is made for a `.mailrc` file. The environment variable _MAILRC_ is
     866used if present else your home directory is check. If found the file is scanned
     867for the `from` setting:
     868
     869  set from="Foo Bar <foo@bar>"
     870
     871You can also support a from address on the command line with the _--mail-from_
     872option.
     873
     874.SMTP Host
     875
     876The SMTP host is taken from the macro `%{_mail_smtp_host}` and the default is
     877`localhost`. You can override the default with a personal or user macro file or
     878via the command line option _--smtp-host_.
     879
    829880Build Set Files
    830881~~~~~~~~~~~~~~~
     
    17801831--no-clean             : Do not clean up the build tree
    17811832--always-clean         : Always clean the build tree, even with an error
    1782 --jobs                 : Run with specified number of jobs, default: num CPUs.
     1833--regression           : Set --no-install, --keep-going and --always-clean
     1834---jobs                 : Run with specified number of jobs, default: num CPUs.
    17831835--host                 : Set the host triplet
    17841836--build                : Set the build triplet
     
    17941846--url url[,url]        : URL to look for source
    17951847--no-download          : Disable the source downloader
     1848--no-install           : Do not install the packages to the prefix
    17961849--targetcflags flags   : List of C flags for the target code
    17971850--targetcxxflags flags : List of C++ flags for the target code
     
    17991852--with-<label>         : Add the --with-<label> to the build
    18001853--without-<label>      : Add the --without-<label> to the build
     1854--mail-from            : Email address the report is from.
     1855--mail-to              : Email address to send the email too.
     1856--mail                 : Send email report or results.
     1857--smtp-host            : SMTP host to send via.
     1858--no-report            : Do not create a package report.
     1859--report-format        : The report format (text, html, asciidoc).
    18011860--bset-tar-file        : Create a build set tar file
    1802 --no-report            : Do not create a package report.
     1861--pkg-tar-files        : Create package tar files
     1862--list-bsets           : List available build sets
    18031863--list-configs         : List available configurations
    1804 --report-format        : The report format (text, html, asciidoc).
    1805 --list-bsets           : List available build sets
    1806 --no-install           : Do not install the packages to the prefix.
    18071864--list-deps            : List the dependent files.
    1808 --pkg-tar-files        : Create package tar files
    1809 --regression           : Set --no-install, --keep-going and --always-clean
    18101865-------------------------------------------------------------
    18111866
     
    18851940Add the --without-<label> to the build. This can be tested for in a script with
    18861941the +%bconf_without+ macro.
    1887 +--list-bsets+;;
    1888 List available build sets.
    1889 +--list-configs+;;
    1890 List available configurations.
     1942+--mail-from+;;
     1943Set the from mail address if report mailing is enabled.
     1944+--mail-to+;;
     1945Set the to mail address if report mailing is enabled. The report is mailed to
     1946this address.
     1947+--mail+;;
     1948Mail the build report to the mail to address.
     1949+--smtp-host+;;
     1950The SMTP host to use to send the email. The default is +localhost+.
     1951+--no-report+;;
     1952Do not create a report format.
     1953+--report-format format+;;
     1954The report format can be 'text' or 'html'. The default is 'html'.
    18911955+--keep-going+;;
    18921956Do not stop on error. This is useful if your build sets performs a large number
    18931957of testing related builds and there are errors.
     1958+--always-clean+.
     1959Always clean the build tree even with a failure.
    18941960+--no-install+;;
    18951961Do not install the packages to the prefix. Use this if you are only after the
    18961962tar files.
     1963+--regression+;;
     1964A convenience option which is the same as +--no-install+, +--keep-going+ and
    18971965+--bset-tar-file+;;
    18981966Create a build set tar file. This is a single tar file of all the packages in
     
    19011969Create package tar files. A tar file will be created for each package built in
    19021970a build set.
     1971+--list-bsets+;;
     1972List available build sets.
     1973+--list-configs+;;
     1974List available configurations.
    19031975+--list-deps+;;
    19041976Print a list of dependent files used by a build set. Dependent files have a
    19051977'dep[?]' prefix where '?' is a number. The files are listed alphabetically.
    1906 +--report-format format+;;
    1907 The report format can be 'text' or 'html'. The default is 'html'.
    1908 +--regression+;;
    1909 A convenience option which is the same as +--no-install+, +--keep-going+ and
    1910 +--always-clean+.
    19111978
    19121979Set Builder (sb-builder)
Note: See TracChangeset for help on using the changeset viewer.