source: rtems-docs/rsb/commands.rst @ 9742e45

4.115
Last change on this file since 9742e45 was 9742e45, checked in by Chris Johns <chrisj@…>, on 11/02/16 at 04:20:35

RSB: Fix the heading level for the PDF.

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