diff options
Diffstat (limited to 'user/bld/index.rst')
| -rw-r--r-- | user/bld/index.rst | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/user/bld/index.rst b/user/bld/index.rst index 411b3a2..dbad167 100644 --- a/user/bld/index.rst +++ b/user/bld/index.rst @@ -1,6 +1,6 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. Copyright (C) 2019, 2020 embedded brains GmbH +.. Copyright (C) 2019, 2020 embedded brains GmbH & Co. KG .. Copyright (C) 2019, 2020 Sebastian Huber .. index:: BSP build system @@ -25,7 +25,7 @@ RTEMS sources * the `waf <https://waf.io/>`_ meta build system command line tool, -* a `wscript <https://git.rtems.org/rtems/tree/wcript>`_ file used by ``waf``, +* a `wscript <https://git.rtems.org/rtems/tree/wscript>`_ file used by ``waf``, and * a @@ -54,7 +54,7 @@ Work Flow There are five steps necessary to build and install one or more BSPs. 1. Select which BSPs you want to build. See also :ref:`BSPs` and - ``./waf bsp_list``. + ``./waf bsplist``. 2. Write a BSP build configuration file (e.g. ``config.ini``) which determines which BSPs are built and how they are configured. @@ -93,7 +93,7 @@ Use ``./waf --help`` to get a list of commands and options. BSP List -------- -The BSP list command ``./waf bsp_list`` loads the build specification items and +The BSP list command ``./waf bsplist`` loads the build specification items and generates a list of base BSPs from it. The list is sorted by architecture and base BSP name. Which base BSPs are listed can be controlled by the ``--rtems-bsps`` command line option. It expects a comma-separated list of @@ -103,7 +103,7 @@ items can be specified by the ``--rtems-specs`` command line option. .. code-block:: none - $ ./waf bsp_list --rtems-bsps=sparc/ + $ ./waf bsplist --rtems-bsps=sparc/ sparc/at697f sparc/erc32 sparc/gr712rc @@ -115,7 +115,7 @@ items can be specified by the ``--rtems-specs`` command line option. .. code-block:: none - $ ./waf bsp_list --rtems-bsps='/leon,/rv64imac$' + $ ./waf bsplist --rtems-bsps='/leon,/rv64imac$' riscv/rv64imac sparc/leon2 sparc/leon3 @@ -123,7 +123,7 @@ items can be specified by the ``--rtems-specs`` command line option. BSP Defaults ------------ -The BSP defaults command ``./waf bsp_defaults`` loads the build specification +The BSP defaults command ``./waf bspdefaults`` loads the build specification items and generates a list options with default values for each base BSP from it. The list is sorted by architecture and base BSP name. Which base BSPs are listed can be controlled by the ``--rtems-bsps`` command line option. Default @@ -134,12 +134,12 @@ option. .. code-block:: none - $ ./waf bsp_defaults --rtems-bsps=gr712rc --rtems-compiler=gcc | grep ABI_FLAGS + $ ./waf bspdefaults --rtems-bsps=gr712rc --rtems-compiler=gcc | grep ABI_FLAGS ABI_FLAGS = -mcpu=leon3 -mfix-gr712rc .. code-block:: none - $ ./waf bsp_defaults --rtems-bsps=gr712rc --rtems-compiler=clang | grep ABI_FLAGS + $ ./waf bspdefaults --rtems-bsps=gr712rc --rtems-compiler=clang | grep ABI_FLAGS ABI_FLAGS = -mcpu=gr712rc Configure @@ -186,7 +186,7 @@ name. This one line configuration file is sufficient to build the base BSP `sparc/erc32` with default values for all options. The base BSPs are determined -by the build specification. The ``./waf bsp_list`` command lists all base BSPs. +by the build specification. The ``./waf bsplist`` command lists all base BSPs. You can create your own BSP names. However, in this case you have to inherit from a base BSP. The inheritance works only within an architecture, e.g. a `riscv` BSP cannot inherit options from an `arm` BSP. @@ -222,12 +222,12 @@ option. INHERIT = gr740 COMPILER = clang -Use the ``./waf bsp_defaults`` command to get a list of all configuration +Use the ``./waf bspdefaults`` command to get a list of all configuration options with default values. .. code-block:: none - $ ./waf bsp_defaults --rtems-bsps=sparc/erc32 + $ ./waf bspdefaults --rtems-bsps=sparc/erc32 [sparc/erc32] # Flags passed to the library archiver ARFLAGS = crD @@ -246,7 +246,7 @@ options with default values. INSTALL_LEGACY_MAKEFILES = True It is not recommended to blindly add all the options obtained through the -``./waf bsp_defaults`` command to custom configuration files. The specified +``./waf bspdefaults`` command to custom configuration files. The specified options should be kept at the necessary minimum to get the desired build. Some projects may still want to specify all options in a configuration file to @@ -255,9 +255,9 @@ the user and base BSP values with the ``diff`` command. .. code-block:: none - $ ./waf bsp_defaults --rtems-bsps=sparc/erc32 > config.ini + $ ./waf bspdefaults --rtems-bsps=sparc/erc32 > config.ini $ sed -i 's/BUILD_TESTS = False/BUILD_TESTS = True/' config.ini - $ ./waf bsp_defaults --rtems-bsps=sparc/erc32 | diff -u - config.ini + $ ./waf bspdefaults --rtems-bsps=sparc/erc32 | diff -u - config.ini --- config.ini 2019-12-04 08:21:36.049335872 +0100 +++ - 2019-12-04 08:21:41.187432405 +0100 @@ -31,7 +31,7 @@ |