source: rtems-docs/user/rsb/commands.rst @ 60ed99d

5
Last change on this file since 60ed99d was 60ed99d, checked in by Sebastian Huber <sebastian.huber@…>, on 01/11/19 at 09:20:08

user: Add RSB content as a chapter

Remove the separate RSB manual.

  • Property mode set to 100644
File size: 14.2 KB
Line 
1.. SPDX-License-Identifier: CC-BY-SA-4.0
2
3.. Copyright (C) 2012, 2016 Chris Johns <chrisj@rtems.org>
4
5Commands
6========
7
8Checker (sb-check)
9------------------
10
11This commands checks your system is set up correctly. Most options are ignored::
12
13    $ ../source-builder/sb-check --help
14    sb-check: [options] [args]
15    RTEMS Source Builder, an RTEMS Tools Project (c) 2012-2013 Chris Johns
16    Options and arguments:
17    --force                : Force the build to proceed
18    --quiet                : Quiet output (not used)
19    --trace                : Trace the execution
20    --dry-run              : Do everything but actually run the build
21    --warn-all             : Generate warnings
22    --no-clean             : Do not clean up the build tree
23    --always-clean         : Always clean the build tree, even with an error
24    --jobs                 : Run with specified number of jobs, default: num CPUs.
25    --host                 : Set the host triplet
26    --build                : Set the build triplet
27    --target               : Set the target triplet
28    --prefix path          : Tools build prefix, ie where they are installed
29    --topdir path          : Top of the build tree, default is $PWD
30    --configdir path       : Path to the configuration directory, default: ./config
31    --builddir path        : Path to the build directory, default: ./build
32    --sourcedir path       : Path to the source directory, default: ./source
33    --patchdir path        : Path to the patches directory, default: ./patches
34    --tmppath path         : Path to the temp directory, default: ./tmp
35    --macros file[,[file]  : Macro format files to load after the defaults
36    --log file             : Log file where all build out is written too
37    --url url[,url]        : URL to look for source
38    --no-download          : Disable the source downloader
39    --targetcflags flags   : List of C flags for the target code
40    --targetcxxflags flags : List of C++ flags for the target code
41    --libstdcxxflags flags : List of C++ flags to build the target libstdc++ code
42    --with-<label>         : Add the --with-<label> to the build
43    --without-<label>      : Add the --without-<label> to the build
44    --regression           : Set --no-install, --keep-going and --always-clean
45    $ ../source-builder/sb-check
46    RTEMS Source Builder - Check, v0.2.0
47    Environment is ok
48
49Defaults (sb-defaults)
50----------------------
51
52This commands outputs and the default macros for your when given no
53arguments. Most options are ignored::
54
55    $ ../source-builder/sb-defaults --help
56    sb-defaults: [options] [args]
57    RTEMS Source Builder, an RTEMS Tools Project (c) 2012-2013 Chris Johns
58    Options and arguments:
59    --force                : Force the build to proceed
60    --quiet                : Quiet output (not used)
61    --trace                : Trace the execution
62    --dry-run              : Do everything but actually run the build
63    --warn-all             : Generate warnings
64    --no-clean             : Do not clean up the build tree
65    --always-clean         : Always clean the build tree, even with an error
66    --jobs                 : Run with specified number of jobs, default: num CPUs.
67    --host                 : Set the host triplet
68    --build                : Set the build triplet
69    --target               : Set the target triplet
70    --prefix path          : Tools build prefix, ie where they are installed
71    --topdir path          : Top of the build tree, default is $PWD
72    --configdir path       : Path to the configuration directory, default: ./config
73    --builddir path        : Path to the build directory, default: ./build
74    --sourcedir path       : Path to the source directory, default: ./source
75    --patchdir path        : Path to the patches directory, default: ./patches
76    --tmppath path         : Path to the temp directory, default: ./tmp
77    --macros file[,[file]  : Macro format files to load after the defaults
78    --log file             : Log file where all build out is written too
79    --url url[,url]        : URL to look for source
80    --no-download          : Disable the source downloader
81    --targetcflags flags   : List of C flags for the target code
82    --targetcxxflags flags : List of C++ flags for the target code
83    --libstdcxxflags flags : List of C++ flags to build the target libstdc++ code
84    --with-<label>         : Add the --with-<label> to the build
85    --without-<label>      : Add the --without-<label> to the build
86    --regression           : Set --no-install, --keep-going and --always-clean
87
88Set Builder (sb-set-builder)
89----------------------------
90
91This command builds a set::
92
93    $ ../source-builder/sb-set-builder --help
94    RTEMS Source Builder, an RTEMS Tools Project (c) 2012-2013 Chris Johns
95    Options and arguments:
96    --force                : Force the build to proceed
97    --quiet                : Quiet output (not used)
98    --trace                : Trace the execution
99    --dry-run              : Do everything but actually run the build
100    --warn-all             : Generate warnings
101    --no-clean             : Do not clean up the build tree
102    --always-clean         : Always clean the build tree, even with an error
103    --regression           : Set --no-install, --keep-going and --always-clean
104    ---jobs                 : Run with specified number of jobs, default: num CPUs.
105    --host                 : Set the host triplet
106    --build                : Set the build triplet
107    --target               : Set the target triplet
108    --prefix path          : Tools build prefix, ie where they are installed
109    --topdir path          : Top of the build tree, default is $PWD
110    --configdir path       : Path to the configuration directory, default: ./config
111    --builddir path        : Path to the build directory, default: ./build
112    --sourcedir path       : Path to the source directory, default: ./source
113    --patchdir path        : Path to the patches directory, default: ./patches
114    --tmppath path         : Path to the temp directory, default: ./tmp
115    --macros file[,[file]  : Macro format files to load after the defaults
116    --log file             : Log file where all build out is written too
117    --url url[,url]        : URL to look for source
118    --no-download          : Disable the source downloader
119    --no-install           : Do not install the packages to the prefix
120    --targetcflags flags   : List of C flags for the target code
121    --targetcxxflags flags : List of C++ flags for the target code
122    --libstdcxxflags flags : List of C++ flags to build the target libstdc++ code
123    --with-<label>         : Add the --with-<label> to the build
124    --without-<label>      : Add the --without-<label> to the build
125    --mail-from            : Email address the report is from.
126    --mail-to              : Email address to send the email too.
127    --mail                 : Send email report or results.
128    --smtp-host            : SMTP host to send via.
129    --no-report            : Do not create a package report.
130    --report-format        : The report format (text, html, asciidoc).
131    --bset-tar-file        : Create a build set tar file
132    --pkg-tar-files        : Create package tar files
133    --list-bsets           : List available build sets
134    --list-configs         : List available configurations
135    --list-deps            : List the dependent files.
136
137The ``arguments`` are a list of build sets to build.
138
139**Options**:
140
141``--force``:
142  Force the build to proceed even if the host check fails. Typically this
143  happens if executable files are found in the path at a different location to
144  the host defaults.
145
146``--trace``:
147  Trace enable printing of debug information to stdout. It is really only of
148  use to RTEMS Source Builder's developers.
149
150``--dry-run``:
151  Do everything but actually run the build commands. This is useful when
152  checking a new configuration parses cleanly.
153
154``--warn-all``:
155  Generate warnings.
156
157``--no-clean``:
158  Do not clean up the build tree during the cleaning phase of the build. This
159  leaves the source and the build output on disk so you can make changes, or
160  amend or generate new patches. It also allows you to review configure type
161  output such as ``config.log``.
162
163``--always-clean``:
164  Clean away the results of a build even if the build fails. This is normally
165  used with ``--keep-going`` when regression testing to see which build sets
166  fail to build. It keeps the disk usage down.
167
168``--jobs``:
169  Control the number of jobs make is given. The jobs can be ``none`` for only 1
170  job, ``half`` so the number of jobs is half the number of detected cores, a
171  fraction such as ``0.25`` so the number of jobs is a quarter of the number of
172  detected cores and a number such as ``25`` which forces the number of jobs to
173  that number.
174
175``--host``:
176  Set the host triplet value. Be careful with this option.
177
178``--build``:
179  Set the build triplet. Be careful with this option.
180
181``--target``:
182  Set the target triplet. Be careful with this option. This is useful if you
183  have a generic configuration script that can work for a range of
184  architectures.
185
186``--prefix path``:
187  Tools build prefix, ie where they are installed.
188
189``--topdir path``:
190  Top of the build tree, that is the current directory you are in.
191
192``--configdir path``:
193  Path to the configuration directory. This overrides the built in defaults.
194
195``--builddir path``:
196  Path to the build directory. This overrides the default of +build+.
197
198``--sourcedir path``:
199  Path to the source directory. This overrides the default of +source+.
200
201``--patchdir path``:
202  Path to the patches directory. This overrides the default of +patches+.
203
204``--tmppath path``:
205  Path to the temporary directory. This overrides the default of +tmp+.
206
207``--macros files``:
208  Macro files to load. The configuration directory path is searched.
209
210``--log file``:
211  Log all the output from the build process. The output is directed to +stdout+
212  if no log file is provided.
213
214``--url url``:
215  URL to look for source when downloading. This is can be comma separate list.
216
217``--no-download``:
218  Disable downloading of source and patches. If the source is not found an
219  error is raised.
220
221``--targetcflags flags``:
222  List of C flags for the target code. This allows for specific local
223  customisation when testing new variations.
224
225``--targetcxxflags flags``:
226  List of C++ flags for the target code. This allows for specific local
227  customisation when testing new variations.
228
229``--libstdcxxflags flags``:
230  List of C++ flags to build the target libstdc++ code. This allows for
231  specific local customisation when testing new variations.
232
233``--with-<label>``:
234  Add the ``--with-<label>`` to the build. This can be tested for in a script
235  with the ``%bconf_with`` macro.
236
237``--without-<label>``:
238  Add the ``--without-<label>`` to the build. This can be tested for in a
239  script with the ``%bconf_without`` macro.
240
241``--mail-from``:
242  Set the from mail address if report mailing is enabled.
243
244``--mail-to``:
245  Set the to mail address if report mailing is enabled. The report is mailed to
246  this address.
247
248``--mail``:
249  Mail the build report to the mail to address.
250
251``--smtp-host``:
252  The SMTP host to use to send the email. The default is ``localhost``.
253
254``--no-report``:
255  Do not create a report format.
256
257``--report-format format``:
258  The report format can be ``text`` or ``html``. The default is ``html``.
259
260``--keep-going``:
261  Do not stop on error. This is useful if your build sets performs a large
262  number of testing related builds and there are errors.
263
264``--always-clean``:
265  Always clean the build tree even with a failure.
266
267``--no-install``:
268  Do not install the packages to the prefix. Use this if you are only after the
269  tar files.
270
271``--regression``:
272  A convenience option which is the same as ``--no-install``, ``--keep-going``
273  and ``--always-clean``.
274
275``--bset-tar-file``:
276  Create a build set tar file. This is a single tar file of all the packages in
277  the build set.
278
279``--pkg-tar-files``:
280  Create package tar files. A tar file will be created for each package built
281  in a build set.
282
283``--list-bsets``:
284  List available build sets.
285
286``--list-configs``:
287  List available configurations.
288
289``--list-deps``:
290  Print a list of dependent files used by a build set. Dependent files have a
291  ``dep[?]` prefix where ``?`` is a number. The files are listed alphabetically.
292
293Set Builder (sb-builder)
294------------------------
295
296This command builds a configuration as described in a configuration
297file. Configuration files have the extension of ``.cfg``::
298
299    $ ./source-builder/sb-builder --help
300    sb-builder: [options] [args]
301    RTEMS Source Builder, an RTEMS Tools Project (c) 2012 Chris Johns
302    Options and arguments:
303    --force                : Force the build to proceed
304    --quiet                : Quiet output (not used)
305    --trace                : Trace the execution
306    --dry-run              : Do everything but actually run the build
307    --warn-all             : Generate warnings
308    --no-clean             : Do not clean up the build tree
309    --always-clean         : Always clean the build tree, even with an error
310    --jobs                 : Run with specified number of jobs, default: num CPUs.
311    --host                 : Set the host triplet
312    --build                : Set the build triplet
313    --target               : Set the target triplet
314    --prefix path          : Tools build prefix, ie where they are installed
315    --topdir path          : Top of the build tree, default is $PWD
316    --configdir path       : Path to the configuration directory, default: ./config
317    --builddir path        : Path to the build directory, default: ./build
318    --sourcedir path       : Path to the source directory, default: ./source
319    --patchdir path        : Path to the patches directory, default: ./patches
320    --tmppath path         : Path to the temp directory, default: ./tmp
321    --macros file[,[file]  : Macro format files to load after the defaults
322    --log file             : Log file where all build out is written too
323    --url url[,url]        : URL to look for source
324    --targetcflags flags   : List of C flags for the target code
325    --targetcxxflags flags : List of C++ flags for the target code
326    --libstdcxxflags flags : List of C++ flags to build the target libstdc++ code
327    --with-<label>         : Add the --with-<label> to the build
328    --without-<label>      : Add the --without-<label> to the build
329    --list-configs         : List available configurations
Note: See TracBrowser for help on using the repository browser.