[PATCH 1/2] eng, user: update bsp_defaults to bspdefaults

Gedare Bloom gedare at rtems.org
Thu Nov 3 16:00:54 UTC 2022


Oops, looks like I don't have my scripts set up properly for tagging
the repo. Anyway these two are for rtems-docs, reflecting the proposal
to change the rtems.git/wscript API

On Thu, Nov 3, 2022 at 9:58 AM Gedare Bloom <gedare at rtems.org> wrote:
>
> ---
>  eng/build-system.rst      |  2 +-
>  user/bld/index.rst        | 16 ++++++++--------
>  user/bsps/arm/imxrt.rst   |  2 +-
>  user/bsps/arm/stm32h7.rst |  2 +-
>  4 files changed, 11 insertions(+), 11 deletions(-)
>
> diff --git a/eng/build-system.rst b/eng/build-system.rst
> index 030679d..dd979e9 100644
> --- a/eng/build-system.rst
> +++ b/eng/build-system.rst
> @@ -79,7 +79,7 @@ In the ``./waf bsp_list`` command, the BSP list is generated from the
>  BSP Defaults
>  ------------
>
> -In the ``./waf bsp_defaults`` command, the BSP defaults are generated from the
> +In the ``./waf bspdefaults`` command, the BSP defaults are generated from the
>  :ref:`SpecTypeBuildBSPItemType` and :ref:`SpecTypeBuildOptionItemType` items.
>  Build specification items contribute to the command through the
>  ``do_defaults()`` method in the ``wscript``.
> diff --git a/user/bld/index.rst b/user/bld/index.rst
> index 411b3a2..d75cb5d 100644
> --- a/user/bld/index.rst
> +++ b/user/bld/index.rst
> @@ -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
> @@ -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 @@
> diff --git a/user/bsps/arm/imxrt.rst b/user/bsps/arm/imxrt.rst
> index e185823..b4f37fd 100644
> --- a/user/bsps/arm/imxrt.rst
> +++ b/user/bsps/arm/imxrt.rst
> @@ -20,7 +20,7 @@ Build Configuration Options
>  Please see the documentation of the `IMXRT_*` and `BSP_*` configuration options
>  for that. You can generate a default set of options with::
>
> -  ./waf bsp_defaults --rtems-bsps=arm/imxrt1052 > config.ini
> +  ./waf bspdefaults --rtems-bsps=arm/imxrt1052 > config.ini
>
>  Boot Process
>  ------------
> diff --git a/user/bsps/arm/stm32h7.rst b/user/bsps/arm/stm32h7.rst
> index ec7440f..9f1f082 100644
> --- a/user/bsps/arm/stm32h7.rst
> +++ b/user/bsps/arm/stm32h7.rst
> @@ -332,7 +332,7 @@ Generate default configuration for the board:
>
>  .. code-block:: shell
>
> -                $ ./waf bsp_defaults --rtems-bsps=arm/stm32h747i-disco > stm32h747i-disco.ini
> +                $ ./waf bspdefaults --rtems-bsps=arm/stm32h747i-disco > stm32h747i-disco.ini
>                  Regenerate build specification cache (needs a couple of seconds)...
>
>  To run basic hello world or ticker samples you do not need to modify
> --
> 2.34.1
>


More information about the devel mailing list