Changeset f3811f2 in rtems-docs


Ignore:
Timestamp:
01/17/23 14:14:02 (13 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
f690480
Parents:
dc2ea30
git-author:
Sebastian Huber <sebastian.huber@…> (01/17/23 14:14:02)
git-committer:
Sebastian Huber <sebastian.huber@…> (01/23/23 06:53:19)
Message:

eng: Improve build option default values

Merge "default" and "default-by-variant" attributes. Use an enabled-by
expression to select the default value.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • eng/req/items.rst

    rdc2ea30 rf3811f2  
    715715* ``default``
    716716
    717 * ``default-by-variant``
    718 
    719717* ``description``
    720718
     
    730728
    731729default
    732     The attribute value shall be a :ref:`SpecTypeBuildOptionValue`. It shall be
    733     the default value of the option if no variant-specific default value is
    734     specified.  Use ``null`` to specify that no default value exits.  The
    735     variant-specific default values may be specified by the
    736     ``default-by-variant`` attribute.
    737 
    738 default-by-variant
    739     The attribute value shall be a list. Each list element shall be a
    740     :ref:`SpecTypeBuildOptionDefaultByVariant`. The list is checked two times
    741     and processed from top to bottom. Firstly, the base BSP name is used to
    742     match with a variant. Secondly, the BSP family name prefixed by ``bsps/``
    743     is used to match with a variant.  If a matching variant is found, then the
    744     processing stops.
     730    The attribute value shall be a list. Each list element shall be a
     731    :ref:`SpecTypeBuildOptionDefaultValue`. It shall be the list of default
     732    values of the option.  When a default value is needed, the first value on
     733    the list which is enabled according to the enabled set is choosen.  If no
     734    value is enabled, then the default value is ``null``.
    745735
    746736description
     
    767757    build-type: option
    768758    copyrights:
    769     - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
    770     default: 115200
    771     default-by-variant:
    772     - value: 9600
    773       variants:
     759    - Copyright (C) 2020, 2022 embedded brains GmbH (http://www.embedded-brains.de)
     760    default:
     761    - enabled-by:
    774762      - bsps/powerpc/motorola_powerpc
    775763      - m68k/m5484FireEngine
    776764      - powerpc/hsc_cm01
    777     - value: 19200
    778       variants:
    779       - m68k/COBRA5475
     765      value: 9600
     766    - enabled-by: m68k/COBRA5475
     767      value: 19200
     768    - enabled-by: true
     769      value: 115200
    780770    description: |
    781771      Default baud for console and other serial devices.
     
    34243414* :ref:`SpecTypeBuildOptionAction`
    34253415
    3426 .. _SpecTypeBuildOptionDefaultByVariant:
    3427 
    3428 Build Option Default by Variant
    3429 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    3430 
    3431 This set of attributes specifies build option default values by variant. All
    3432 explicit attributes shall be specified. The explicit attributes for this type
    3433 are:
     3416.. _SpecTypeBuildOptionDefaultValue:
     3417
     3418Build Option Default Value
     3419^^^^^^^^^^^^^^^^^^^^^^^^^^
     3420
     3421This set of attributes specifies a build option default value. All explicit
     3422attributes shall be specified. The explicit attributes for this type are:
     3423
     3424enabled-by
     3425    The attribute value shall be an :ref:`SpecTypeEnabledByExpression`.
    34343426
    34353427value
    3436     The attribute value shall be a :ref:`SpecTypeBuildOptionValue`. It value
    3437     shall be the default value for the matching variants.
    3438 
    3439 variants
    3440     The attribute value shall be a list of strings. It shall be a list of
    3441     Python regular expression matching with the desired variants.
     3428    The attribute value shall be a :ref:`SpecTypeBuildOptionValue`. Its value
     3429    shall be the default value for the associated enabled-by expression.
    34423430
    34433431This type is used by the following types:
     
    34963484* :ref:`SpecTypeBuildOptionAction`
    34973485
    3498 * :ref:`SpecTypeBuildOptionDefaultByVariant`
    3499 
    3500 * :ref:`SpecTypeBuildOptionItemType`
     3486* :ref:`SpecTypeBuildOptionDefaultValue`
    35013487
    35023488.. _SpecTypeBuildSource:
     
    36813667
    36823668* :ref:`SpecTypeActionRequirementTransition`
     3669
     3670* :ref:`SpecTypeBuildOptionDefaultValue`
    36833671
    36843672* :ref:`SpecTypeEnabledByExpression`
Note: See TracChangeset for help on using the changeset viewer.