5.2. Specification Items¶

5.2.1. Specification Item Hierarchy¶

The specification item types have the following hierarchy:

Root Item Type

5.2.2. Specification Item Types¶

5.2.2.1. Root Item Type¶

The technical specification of RTEMS will contain for example requirements, specializations of requirements, interface specifications, test suites, test cases, and requirement validations. These things will be called specification items or just items if it is clear from the context.

The specification items are stored in files in YAML format with a defined set of key-value pairs called attributes. Each attribute key name shall be a Name. In particular, key names which begin with an underscore (_) are reserved for internal use in tools.

This is the root specification item type. All explicit attributes shall be specified. The explicit attributes for this type are:

SPDX-License-Identifier: The attribute value shall be a SPDX License Identifier. It shall be the license of the item.
copyrights: The attribute value shall be a list. Each list element shall be a Copyright. It shall be the list of copyright statements of the item.
enabled-by: The attribute value shall be an Enabled-By Expression. It shall define the conditions under which the item is enabled.
links: The attribute value shall be a list. Each list element shall be a Link.
type: The attribute value shall be a Name. It shall be the item type. The selection of types and the level of detail depends on a particular standard and product model. We need enough flexibility to be in line with ECSS-E-ST-10-06 and possible future applications of other standards. The item type may be refined further with additional type-specific subtypes.

This type is refined by the following types:

Build Item Type
Constraint Item Type
Glossary Item Type
Interface Item Type
Requirement Item Type
Requirement Validation Item Type
Specification Item Type
Test Case Item Type
Test Platform Item Type
Test Procedure Item Type
Test Suite Item Type

5.2.2.2. Build Item Type¶

This type refines the Root Item Type though the type attribute if the value is build. This set of attributes specifies a build item. All explicit attributes shall be specified. The explicit attributes for this type are:

build-type: The attribute value shall be a Name. It shall be the build item type.

This type is refined by the following types:

Build Ada Test Program Item Type
Build BSP Item Type
Build Configuration File Item Type
Build Configuration Header Item Type
Build Group Item Type
Build Library Item Type
Build Objects Item Type
Build Option Item Type
Build Script Item Type
Build Start File Item Type
Build Test Program Item Type

5.2.2.3. Build Ada Test Program Item Type¶

This type refines the Build Item Type though the build-type attribute if the value is ada-test-program. This set of attributes specifies an Ada test program executable to build. Test programs may use additional objects provided by Build Objects Item Type items. Test programs have an implicit enabled-by attribute value which is controlled by the option action set-test-state. If the test state is set to exclude, then the test program is not built. All explicit attributes shall be specified. The explicit attributes for this type are:

ada-main: The attribute value shall be a string. It shall be the path to the Ada main body file.
ada-object-directory: The attribute value shall be a string. It shall be the path to the Ada object directory (-D option value for gnatmake).
adaflags: The attribute value shall be a list of strings. It shall be a list of options for the Ada compiler.
adaincludes: The attribute value shall be a list of strings. It shall be a list of Ada include paths.
cflags: The attribute value shall be a list. Each list element shall be a Build C Compiler Option.
cppflags: The attribute value shall be a list. Each list element shall be a Build C Preprocessor Option.
includes: The attribute value shall be a list. Each list element shall be a Build Include Path.
ldflags: The attribute value shall be a list. Each list element shall be a Build Linker Option.
source: The attribute value shall be a list. Each list element shall be a Build Source.
stlib: The attribute value shall be a list of strings. It shall be a list of external static library identifiers used to link this test program, e.g. m for libm.a.
target: The attribute value shall be a Build Target.
use-after: The attribute value shall be a list. Each list element shall be a Build Use After Directive.
use-before: The attribute value shall be a list. Each list element shall be a Build Use Before Directive.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
ada-main: testsuites/ada/samples/hello/hello.adb
ada-object-directory: testsuites/ada/samples/hello
adaflags: []
adaincludes:
- cpukit/include/adainclude
- testsuites/ada/support
build-type: ada-test-program
cflags: []
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
cppflags: []
enabled-by: true
includes: []
ldflags: []
links: []
source:
- testsuites/ada/samples/hello/init.c
stlib: []
target: testsuites/ada/ada_hello.exe
type: build
use-after: []
use-before: []

5.2.2.4. Build BSP Item Type¶

This type refines the Build Item Type though the build-type attribute if the value is bsp. This set of attributes specifies a base BSP variant to build. All explicit attributes shall be specified. The explicit attributes for this type are:

arch: The attribute value shall be a string. It shall be the target architecture of the BSP.
bsp: The attribute value shall be a string. It shall be the base BSP variant name.
cflags: The attribute value shall be a list. Each list element shall be a Build C Compiler Option.
cppflags: The attribute value shall be a list. Each list element shall be a Build C Preprocessor Option.
family: The attribute value shall be a string. It shall be the BSP family name. The name shall be the last directory of the path to the BSP sources.
includes: The attribute value shall be a list. Each list element shall be a Build Include Path.
install: The attribute value shall be a list. Each list element shall be a Build Install Directive.
source: The attribute value shall be a list. Each list element shall be a Build Source.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
arch: myarch
bsp: mybsp
build-type: bsp
cflags: []
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
cppflags: []
enabled-by: true
family: mybsp
includes: []
install:
- destination: ${BSP_INCLUDEDIR}
  source:
  - bsps/myarch/mybsp/include/bsp.h
  - bsps/myarch/mybsp/include/tm27.h
- destination: ${BSP_INCLUDEDIR}/bsp
  source:
  - bsps/myarch/mybsp/include/bsp/irq.h
- destination: ${BSP_LIBDIR}
  source:
  - bsps/myarch/mybsp/start/linkcmds
links:
- role: build-dependency
  uid: ../../obj
- role: build-dependency
  uid: ../../opto2
- role: build-dependency
  uid: abi
- role: build-dependency
  uid: obj
- role: build-dependency
  uid: ../start
- role: build-dependency
  uid: ../../bspopts
source:
- bsps/myarch/mybsp/start/bspstart.c
type: build

5.2.2.5. Build Configuration File Item Type¶

This type refines the Build Item Type though the build-type attribute if the value is config-file. This set of attributes specifies a configuration file placed in the build tree. The configuration file is generated during the configure command execution and are placed in the build tree. All explicit attributes shall be specified. The explicit attributes for this type are:

content: The attribute value shall be a string. It shall be the content of the configuration file. A ${VARIABLE} substitution is performed during the configure command execution using the variables of the configuration set. Use $$ for a plain $ character. To have all variables from sibling items available for substitution it is recommended to link them in the proper order.
install-path: The attribute value shall be a Build Install Path.
target: The attribute value shall be a Build Target.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
build-type: config-file
content: |
  # ...
  Name: ${ARCH}-rtems${__RTEMS_MAJOR__}-${BSP_NAME}
  # ...
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
install-path: ${PREFIX}/lib/pkgconfig
links: []
target: ${ARCH}-rtems${__RTEMS_MAJOR__}-${BSP_NAME}.pc
type: build

5.2.2.6. Build Configuration Header Item Type¶

This type refines the Build Item Type though the build-type attribute if the value is config-header. This set of attributes specifies configuration header file. The configuration header file is generated during configure command execution and is placed in the build tree. All collected configuration defines are written to the configuration header file during the configure command execution. To have all configuration defines from sibling items available it is recommended to link them in the proper order. All explicit attributes shall be specified. The explicit attributes for this type are:

guard: The attribute value shall be a string. It shall be the header guard define.
include-headers: The attribute value shall be a list of strings. It shall be a list of header files to include via #include <...>.
install-path: The attribute value shall be a Build Install Path.
target: The attribute value shall be a Build Target.

5.2.2.7. Build Group Item Type¶

This type refines the Build Item Type though the build-type attribute if the value is group. This set of attributes provides a means to aggregate other build items and modify the build item context which is used by referenced build items. The includes, ldflags, objects, and use variables of the build item context are updated by the corresponding attributes of the build group. All explicit attributes shall be specified. The explicit attributes for this type are:

includes: The attribute value shall be a list. Each list element shall be a Build Include Path.
install: The attribute value shall be a list. Each list element shall be a Build Install Directive.
ldflags: The attribute value shall be a list of strings. It shall be a list of options for the linker. They are used to link executables referenced by this item.
use-after: The attribute value shall be a list. Each list element shall be a Build Use After Directive.
use-before: The attribute value shall be a list. Each list element shall be a Build Use Before Directive.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
build-type: group
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by:
- BUILD_TESTS
- BUILD_SAMPLES
includes:
- testsuites/support/include
install: []
ldflags:
- -Wl,--wrap=printf
- -Wl,--wrap=puts
links:
- role: build-dependency
  uid: ticker
type: build
use-after: []
use-before:
- rtemstest

5.2.2.8. Build Library Item Type¶

This type refines the Build Item Type though the build-type attribute if the value is library. This set of attributes specifies a static library. Library items may use additional objects provided by Build Objects Item Type items through the build dependency links of the item. All explicit attributes shall be specified. The explicit attributes for this type are:

cflags: The attribute value shall be a list. Each list element shall be a Build C Compiler Option.
cppflags: The attribute value shall be a list. Each list element shall be a Build C Preprocessor Option.
cxxflags: The attribute value shall be a list. Each list element shall be a Build C++ Compiler Option.
includes: The attribute value shall be a list. Each list element shall be a Build Include Path.
install: The attribute value shall be a list. Each list element shall be a Build Install Directive.
install-path: The attribute value shall be a Build Install Path.
source: The attribute value shall be a list. Each list element shall be a Build Source.
target: The attribute value shall be a Build Target. It shall be the name of the static library, e.g. z for libz.a.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
build-type: library
cflags:
- -Wno-pointer-sign
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
cppflags: []
cxxflags: []
enabled-by: true
includes:
- cpukit/libfs/src/jffs2/include
install:
- destination: ${BSP_INCLUDEDIR}/rtems
  source:
  - cpukit/include/rtems/jffs2.h
install-path: ${BSP_LIBDIR}
links: []
source:
- cpukit/libfs/src/jffs2/src/build.c
target: jffs2
type: build

5.2.2.9. Build Objects Item Type¶

This type refines the Build Item Type though the build-type attribute if the value is objects. This set of attributes specifies a set of object files used to build static libraries or test programs. All explicit attributes shall be specified. The explicit attributes for this type are:

cflags: The attribute value shall be a list. Each list element shall be a Build C Compiler Option.
cppflags: The attribute value shall be a list. Each list element shall be a Build C Preprocessor Option.
cxxflags: The attribute value shall be a list. Each list element shall be a Build C++ Compiler Option.
includes: The attribute value shall be a list. Each list element shall be a Build Include Path.
install: The attribute value shall be a list. Each list element shall be a Build Install Directive.
source: The attribute value shall be a list. Each list element shall be a Build Source.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
build-type: objects
cflags: []
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
cppflags: []
cxxflags: []
enabled-by: true
includes: []
install:
- destination: ${BSP_INCLUDEDIR}/bsp
  source:
  - bsps/include/bsp/bootcard.h
  - bsps/include/bsp/default-initial-extension.h
  - bsps/include/bsp/fatal.h
links: []
source:
- bsps/shared/start/bootcard.c
- bsps/shared/rtems-version.c
type: build

5.2.2.10. Build Option Item Type¶

This type refines the Build Item Type though the build-type attribute if the value is option. This set of attributes specifies a build option. The following explicit attributes are mandatory:

actions
default
default-by-variant
description

The explicit attributes for this type are:

actions: The attribute value shall be a list. Each list element shall be a Build Option Action. Each action operates on the action value handed over by a previous action and action-specific attribute values. The actions pass the processed action value to the next action in the list. The first action starts with an action value of None. The actions are carried out during the configure command execution.
default: The attribute value shall be a Build Option Value. It shall be the default value of the option if no variant-specific default value is specified. Use null to specify that no default value exits. The variant-specific default values may be specified by the default-by-variant attribute.
default-by-variant: The attribute value shall be a list. Each list element shall be a Build Option Default by Variant. The list is processed from top to bottom. If a matching variant is found, then the processing stops.
description: The attribute value shall be an optional string. It shall be the description of the option.
format: The attribute value shall be an optional string. It shall be a Python format string, for example '{}' or '{:#010x}'.
name: The attribute value shall be a Build Option Name.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
actions:
- get-integer: null
- define: null
build-type: option
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
default: 115200
default-by-variant:
- value: 9600
  variants:
  - m68k/m5484FireEngine
  - powerpc/hsc_cm01
- value: 19200
  variants:
  - m68k/COBRA5475
description: |
  Default baud for console and other serial devices.
enabled-by: true
format: '{}'
links: []
name: BSP_CONSOLE_BAUD
type: build

5.2.2.11. Build Script Item Type¶

This type refines the Build Item Type though the build-type attribute if the value is script. This set of attributes specifies a build script. The optional attributes may be required by commands executed through the scripts. The following explicit attributes are mandatory:

do-build
do-configure
prepare-build
prepare-configure

The explicit attributes for this type are:

asflags: The attribute value shall be a list. Each list element shall be a Build Assembler Option.
cflags: The attribute value shall be a list. Each list element shall be a Build C Compiler Option.
cppflags: The attribute value shall be a list. Each list element shall be a Build C Preprocessor Option.
cxxflags: The attribute value shall be a list. Each list element shall be a Build C++ Compiler Option.
do-build: The attribute value shall be an optional string. If this script shall execute, then it shall be Python code which is executed via exec() in the context of the do_build() method of the wscript. A local variable bld is available with the waf build context. A local variable bic is available with the build item context.
do-configure: The attribute value shall be an optional string. If this script shall execute, then it shall be Python code which is executed via exec() in the context of the do_configure() method of the wscript. A local variable conf is available with the waf configuration context. A local variable cic is available with the configuration item context.
includes: The attribute value shall be a list. Each list element shall be a Build Include Path.
ldflags: The attribute value shall be a list. Each list element shall be a Build Linker Option.
prepare-build: The attribute value shall be an optional string. If this script shall execute, then it shall be Python code which is executed via exec() in the context of the prepare_build() method of the wscript. A local variable bld is available with the waf build context. A local variable bic is available with the build item context.
prepare-configure: The attribute value shall be an optional string. If this script shall execute, then it shall be Python code which is executed via exec() in the context of the prepare_configure() method of the wscript. A local variable conf is available with the waf configuration context. A local variable cic is available with the configuration item context.
stlib: The attribute value shall be a list of strings. It shall be a list of external static library identifiers used to link this test program, e.g. m for libm.a.
use-after: The attribute value shall be a list. Each list element shall be a Build Use After Directive.
use-before: The attribute value shall be a list. Each list element shall be a Build Use Before Directive.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
build-type: script
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
default: null
default-by-variant: []
do-build: |
  bld.install_as(
      "${BSP_LIBDIR}/linkcmds",
      "bsps/" + bld.env.ARCH + "/" + bld.env.BSP_FAMILY +
      "/start/linkcmds." + bld.env.BSP_BASE
  )
do-configure: |
  conf.env.append_value(
      "LINKFLAGS",
      ["-qnolinkcmds", "-T", "linkcmds." + conf.env.BSP_BASE]
  )
enabled-by: true
links: []
prepare-build: null
prepare-configure: null
type: build

5.2.2.12. Build Start File Item Type¶

This type refines the Build Item Type though the build-type attribute if the value is start-file. This set of attributes specifies a start file to build. A start file is used to link an executable. All explicit attributes shall be specified. The explicit attributes for this type are:

asflags: The attribute value shall be a list. Each list element shall be a Build Assembler Option.
cppflags: The attribute value shall be a list. Each list element shall be a Build C Preprocessor Option.
includes: The attribute value shall be a list. Each list element shall be a Build Include Path.
install-path: The attribute value shall be a Build Install Path.
source: The attribute value shall be a list. Each list element shall be a Build Source.
target: The attribute value shall be a Build Target.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
asflags: []
build-type: start-file
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
cppflags: []
enabled-by: true
includes: []
install-path: ${BSP_LIBDIR}
links: []
source:
- bsps/sparc/shared/start/start.S
target: start.o
type: build

5.2.2.13. Build Test Program Item Type¶

This type refines the Build Item Type though the build-type attribute if the value is test-program. This set of attributes specifies a test program executable to build. Test programs may use additional objects provided by Build Objects Item Type items. Test programs have an implicit enabled-by attribute value which is controlled by the option action set-test-state. If the test state is set to exclude, then the test program is not built. All explicit attributes shall be specified. The explicit attributes for this type are:

cflags: The attribute value shall be a list. Each list element shall be a Build C Compiler Option.
cppflags: The attribute value shall be a list. Each list element shall be a Build C Preprocessor Option.
cxxflags: The attribute value shall be a list. Each list element shall be a Build C++ Compiler Option.
features: The attribute value shall be a string. It shall be the waf build features for this test program.
includes: The attribute value shall be a list. Each list element shall be a Build Include Path.
ldflags: The attribute value shall be a list. Each list element shall be a Build Linker Option.
source: The attribute value shall be a list. Each list element shall be a Build Source.
stlib: The attribute value shall be a list of strings. It shall be a list of external static library identifiers used to link this test program, e.g. m for libm.a.
target: The attribute value shall be a Build Target.
use-after: The attribute value shall be a list. Each list element shall be a Build Use After Directive.
use-before: The attribute value shall be a list. Each list element shall be a Build Use Before Directive.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
build-type: test-program
cflags: []
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
cppflags: []
cxxflags: []
enabled-by: true
features: c cprogram
includes: []
ldflags: []
links: []
source:
- testsuites/samples/ticker/init.c
- testsuites/samples/ticker/tasks.c
stlib: []
target: testsuites/samples/ticker.exe
type: build
use-after: []
use-before: []

5.2.2.14. Constraint Item Type¶

This type refines the Root Item Type though the type attribute if the value is constraint. This set of attributes specifies a constraint. All explicit attributes shall be specified. The explicit attributes for this type are:

rationale: The attribute value shall be an optional string. If the value is present, then it shall state the rationale or justification of the constraint.
scope: The attribute value shall be a string. It shall be the scope of the constraint.
text: The attribute value shall be a Requirement Text. It shall state the constraint.

5.2.2.15. Glossary Item Type¶

This type refines the Root Item Type though the type attribute if the value is glossary. This set of attributes specifies a glossary item. All explicit attributes shall be specified. The explicit attributes for this type are:

glossary-type: The attribute value shall be a Name. It shall be the glossary item type.

This type is refined by the following types:

Glossary Group Item Type
Glossary Term Item Type

5.2.2.16. Glossary Group Item Type¶

This type refines the Glossary Item Type though the glossary-type attribute if the value is group. This set of attributes specifies a glossary group. All explicit attributes shall be specified. The explicit attributes for this type are:

name: The attribute value shall be a string. It shall be the human readable name of the glossary group.
text: The attribute value shall be a string. It shall state the requirement for the glossary group.

5.2.2.17. Glossary Term Item Type¶

This type refines the Glossary Item Type though the glossary-type attribute if the value is term. This set of attributes specifies a glossary term. All explicit attributes shall be specified. The explicit attributes for this type are:

term: The attribute value shall be a string. It shall be the glossary term.
text: The attribute value shall be a string. It shall be the definition of the glossary term.

5.2.2.18. Interface Item Type¶

This type refines the Root Item Type though the type attribute if the value is interface. This set of attributes specifies an interface specification item. Interface items shall specify the interface of the software product to other software products and the hardware. Use Interface Domain Item Type items to specify interface domains, for example the API, C language, compiler, interfaces to the implementation, and the hardware. All explicit attributes shall be specified. The explicit attributes for this type are:

interface-type: The attribute value shall be a Name. It shall be the interface item type.

This type is refined by the following types:

Application Configuration Group Item Type
Application Configuration Option Item Type
Interface Compound Item Type
Interface Container Item Type
Interface Define Item Type
Interface Domain Item Type
Interface Enum Item Type
Interface Enumerator Item Type
Interface Forward Declaration Item Type
Interface Function Item Type
Interface Group Item Type
Interface Header File Item Type
Interface Macro Item Type
Interface Typedef Item Type
Interface Unspecified Item Type
Interface Variable Item Type

5.2.2.19. Application Configuration Group Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is appl-config-group. This set of attributes specifies an application configuration group. All explicit attributes shall be specified. The explicit attributes for this type are:

description: The attribute value shall be a string. It shall be the description of the application configuration group.
name: The attribute value shall be a string. It shall be human readable name of the application configuration group.
text: The attribute value shall be a Requirement Text. It shall state the requirement for the application configuration group.

5.2.2.20. Application Configuration Option Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is appl-config-option. This set of attributes specifies an application configuration option. All explicit attributes shall be specified. The explicit attributes for this type are:

appl-config-option-type: The attribute value shall be a Name. It shall be the application configuration option type.
description: The attribute value shall be an Interface Description. The Application Configuration Value Option Item Type items have an attribute for constraints.
index-entries: The attribute value shall be a list of strings. It shall be a list of additional application configuration option document index entries. The application configuration option name is automatically added to the document index.
name: The attribute value shall be an Application Configuration Option Name.
notes: The attribute value shall be an Interface Notes.
text: The attribute value shall be a Requirement Text. It shall state the requirement for the application configuration option.

This type is refined by the following types:

Application Configuration Feature Enable Option Item Type
Application Configuration Feature Option Item Type
Application Configuration Value Option Item Type

5.2.2.21. Application Configuration Feature Enable Option Item Type¶

This type refines the Application Configuration Option Item Type though the appl-config-option-type attribute if the value is feature-enable. This set of attributes specifies an application configuration feature enable option.

5.2.2.22. Application Configuration Feature Option Item Type¶

This type refines the Application Configuration Option Item Type though the appl-config-option-type attribute if the value is feature. This set of attributes specifies an application configuration feature option. All explicit attributes shall be specified. The explicit attributes for this type are:

default: The attribute value shall be a string. It shall describe what happens if the configuration option is undefined.

5.2.2.23. Application Configuration Value Option Item Type¶

This type refines the following types:

Application Configuration Option Item Type though the appl-config-option-type attribute if the value is initializer
Application Configuration Option Item Type though the appl-config-option-type attribute if the value is integer

This set of attributes specifies application configuration initializer or integer option. All explicit attributes shall be specified. The explicit attributes for this type are:

constraints: The attribute value shall be an Application Configuration Option Constraint Set.
default-value: The attribute value shall be an Integer or String. It shall shall describe the default value of the application configuration option.

5.2.2.24. Interface Compound Item Type¶

This type refines the following types:

Interface Item Type though the interface-type attribute if the value is struct
Interface Item Type though the interface-type attribute if the value is union

This set of attributes specifies a compound (struct or union). All explicit attributes shall be specified. The explicit attributes for this type are:

brief: The attribute value shall be an Interface Brief Description.
definition: The attribute value shall be a list. Each list element shall be an Interface Compound Member Definition Directive.
definition-kind: The attribute value shall be an Interface Compound Definition Kind.
description: The attribute value shall be an Interface Description.
name: The attribute value shall be a string. It shall be the name of the compound (struct or union).
notes: The attribute value shall be an Interface Notes.

5.2.2.25. Interface Container Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is container. Items of this type specify an interface container. The item shall have exactly one link with the Interface Placement Link Role to an Interface Domain Item Type item. This link defines the interface domain of the container.

5.2.2.26. Interface Define Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is define. This set of attributes specifies a define. All explicit attributes shall be specified. The explicit attributes for this type are:

brief: The attribute value shall be an Interface Brief Description.
definition: The attribute value shall be an Interface Definition Directive.
description: The attribute value shall be an Interface Description.
name: The attribute value shall be a string. It shall be the name of the define.
notes: The attribute value shall be an Interface Notes.

5.2.2.27. Interface Domain Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is domain. This set of attributes specifies an interface domain. Items of the types Interface Container Item Type and Interface Header File Item Type are placed into domains through links with the Interface Placement Link Role. All explicit attributes shall be specified. The explicit attributes for this type are:

description: The attribute value shall be a string. It shall be the description of the domain
name: The attribute value shall be a string. It shall be the human readable name of the domain.

5.2.2.28. Interface Enum Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is enum. This set of attributes specifies an enum. All explicit attributes shall be specified. The explicit attributes for this type are:

brief: The attribute value shall be an Interface Brief Description.
definition-kind: The attribute value shall be an Interface Enum Definition Kind.
description: The attribute value shall be an Interface Description.
name: The attribute value shall be a string. It shall be the name of the enum.
notes: The attribute value shall be an Interface Description.

5.2.2.29. Interface Enumerator Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is enumerator. This set of attributes specifies an enumerator. All explicit attributes shall be specified. The explicit attributes for this type are:

brief: The attribute value shall be an Interface Brief Description.
definition: The attribute value shall be an Interface Definition Directive.
description: The attribute value shall be an Interface Description.
name: The attribute value shall be a string. It shall be the name of the enumerator.
notes: The attribute value shall be an Interface Notes.

5.2.2.30. Interface Forward Declaration Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is forward-declaration. Items of this type specify a forward declaration. The item shall have exactly one link with the Interface Target Link Role to an Interface Compound Item Type item. This link defines the type declared by the forward declaration.

5.2.2.31. Interface Function Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is function. This set of attributes specifies a function. All explicit attributes shall be specified. The explicit attributes for this type are:

brief: The attribute value shall be an Interface Brief Description.
definition: The attribute value shall be an Interface Function Definition Directive.
description: The attribute value shall be an Interface Description.
name: The attribute value shall be a string. It shall be the name of the function.
notes: The attribute value shall be an Interface Notes.
params: The attribute value shall be a list. Each list element shall be an Interface Parameter.
return: The attribute value shall be an Interface Return Directive.

5.2.2.32. Interface Group Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is group. This set of attributes specifies an interface group. All explicit attributes shall be specified. The explicit attributes for this type are:

brief: The attribute value shall be an Interface Brief Description.
description: The attribute value shall be an Interface Description.
identifier: The attribute value shall be an Interface Group Identifier.
name: The attribute value shall be a string. It shall be the human readable name of the interface group.

5.2.2.33. Interface Header File Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is header-file. This set of attributes specifies a header file. The item shall have exactly one link with the Interface Placement Link Role to an Interface Domain Item Type item. This link defines the interface domain of the header file. All explicit attributes shall be specified. The explicit attributes for this type are:

path: The attribute value shall be a string. It shall be the path used to include the header file. For example rtems/confdefs.h.
prefix: The attribute value shall be a string. It shall be the prefix directory path to the header file in the interface domain. For example cpukit/include.

5.2.2.34. Interface Macro Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is macro. This set of attributes specifies a macro. All explicit attributes shall be specified. The explicit attributes for this type are:

brief: The attribute value shall be an Interface Brief Description.
definition: The attribute value shall be an Interface Definition Directive.
description: The attribute value shall be an Interface Description.
name: The attribute value shall be a string. It shall be the name of the macro.
notes: The attribute value shall be an Interface Notes.
params: The attribute value shall be a list. Each list element shall be an Interface Parameter.
return: The attribute value shall be an Interface Return Directive.

5.2.2.35. Interface Typedef Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is typedef. This set of attributes specifies a typedef. All explicit attributes shall be specified. The explicit attributes for this type are:

brief: The attribute value shall be an Interface Brief Description.
definition: The attribute value shall be an Interface Definition Directive.
description: The attribute value shall be an Interface Description.
name: The attribute value shall be a string. It shall be the name of the typedef.
notes: The attribute value shall be an Interface Notes.

5.2.2.36. Interface Unspecified Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is unspecified. This set of attributes specifies an unspecified interface. All explicit attributes shall be specified. The explicit attributes for this type are:

name: The attribute value shall be a string. It shall be the name of the unspecified interface.

5.2.2.37. Interface Variable Item Type¶

This type refines the Interface Item Type though the interface-type attribute if the value is variable. This set of attributes specifies a variable. All explicit attributes shall be specified. The explicit attributes for this type are:

brief: The attribute value shall be an Interface Brief Description.
definition: The attribute value shall be an Interface Definition Directive.
description: The attribute value shall be an Interface Description.
name: The attribute value shall be a string. It shall be the name of the variable.
notes: The attribute value shall be an Interface Notes.

5.2.2.38. Requirement Item Type¶

This type refines the Root Item Type though the type attribute if the value is requirement. This set of attributes specifies a requirement. All explicit attributes shall be specified. The explicit attributes for this type are:

rationale: The attribute value shall be an optional string. If the value is present, then it shall state the rationale or justification of the requirement.
references: The attribute value shall be a list. Each list element shall be a Requirement Reference.
requirement-type: The attribute value shall be a Name. It shall be the requirement item type.
text: The attribute value shall be a Requirement Text. It shall state the requirement.

This type is refined by the following types:

Functional Requirement Item Type
Non-Functional Requirement Item Type

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de
enabled-by: true
functional-type: capability
links: []
rationale: |
  It keeps you busy.
requirement-type: functional
text: |
  The system shall do crazy things.
type: requirement

5.2.2.39. Functional Requirement Item Type¶

This type refines the Requirement Item Type though the requirement-type attribute if the value is functional. This set of attributes specifies a functional requirement. All explicit attributes shall be specified. The explicit attributes for this type are:

functional-type: The attribute value shall be a Name. It shall be the functional type of the requirement.

This type is refined by the following types:

Action Requirement Item Type
Generic Functional Requirement Item Type

5.2.2.40. Action Requirement Item Type¶

This type refines the Functional Requirement Item Type though the functional-type attribute if the value is action. This set of attributes specifies functional requirements and corresponding validation test code. The functional requirements of an action are specified. An action performs a step in a finite state machine. An action is implemented through a function or a macro. The action is performed through a call of the function or an execution of the code of a macro expansion by an actor. The actor is for example a task or an interrupt service routine.

For action requirements which specify the function of an interface, there shall be exactly one link with the Interface Function Link Role to the interface of the action.

The action requirements are specified by

a list of pre-conditions, each with a set of states,
a list of post-conditions, each with a set of states,
the transition of pre-condition states to post-condition states through the action.

Along with the requirements, the test code to generate a validation test is specified. For an action requirement it is verified that all variations of pre-condition states have a set of post-condition states specified in the transition map. All transitions are covered by the generated test code. All explicit attributes shall be specified. The explicit attributes for this type are:

post-conditions: The attribute value shall be a list. Each list element shall be an Action Requirement Condition.
pre-conditions: The attribute value shall be a list. Each list element shall be an Action Requirement Condition.
test-action: The attribute value shall be a string. It shall be the test action code.
test-brief: The attribute value shall be an optional string. If the value is present, then it shall be the test case brief description.
test-context: The attribute value shall be a list. Each list element shall be an Action Requirement Test Context Member.
test-description: The attribute value shall be an optional string. If the value is present, then it shall be the test case description.
test-header: The attribute value shall be an Action Requirement Test Header.
test-includes: The attribute value shall be a list of strings. It shall be a list of header files included via #include <...>.
test-local-includes: The attribute value shall be a list of strings. It shall be a list of header files included via #include "...".
test-name: The attribute value shall be a Test Name.
test-setup: The attribute value shall be an Action Requirement Test Fixture Method.
test-stop: The attribute value shall be an Action Requirement Test Fixture Method.
test-support: The attribute value shall be an optional string. If the value is present, then it shall be the test case support code. The support code is placed at file scope before the test case code.
test-target: The attribute value shall be a string. It shall be the path to the generated test case source file.
test-teardown: The attribute value shall be an Action Requirement Test Fixture Method.
transition-map: The attribute value shall be a list. Each list element shall be an Action Requirement Transition.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
functional-type: action
links: []
post-conditions:
- name: Status
  states:
  - name: Success
    test-code: |
      /* Check that the status is SUCCESS */
    text: |
      The status shall be SUCCESS.
  - name: Error
    test-code: |
      /* Check that the status is ERROR */
    text: |
      The status shall be ERROR.
  test-epilogue: null
  test-prologue: null
- name: Data
  states:
  - name: Unchanged
    test-code: |
      /* Check that the data is unchanged */
    text: |
      The data shall be unchanged by the action.
  - name: Red
    test-code: |
      /* Check that the data is red */
    text: |
      The data shall be red.
  - name: Green
    test-code: |
      /* Check that the data is green */
    text: |
      The data shall be green.
  test-epilogue: null
  test-prologue: null
pre-conditions:
- name: Data
  states:
  - name: NullPtr
    test-code: |
      /* Set data pointer to NULL */
    text: |
      The data pointer shall be NULL.
  - name: Valid
    test-code: |
      /* Set data pointer to reference a valid data buffer */
    text: |
      The data pointer shall reference a valid data buffer.
  test-epilogue: null
  test-prologue: null
- name: Option
  states:
  - name: Red
    test-code: |
      /* Set option to RED */
    text: |
      The option shall be RED.
  - name: Green
    test-code: |
      /* Set option to GREEN */
    text: |
      The option shall be GREEN.
  test-epilogue: null
  test-prologue: null
requirement-type: functional
test-action: |
  /* Call the function of the action */
test-brief: null
test-context:
- brief: null
  description: null
  member: void *data
- brief: null
  description: null
  member: option_type option
test-description: null
test-header: null
test-includes: []
test-local-includes: []
test-name: RedGreenData
test-setup: null
test-stop: null
test-support: null
test-target: tc-red-green-data.c
test-teardown: null
transition-map:
- enabled-by: true
  post-conditions:
    Status: Error
    Data: Unchanged
  pre-conditions:
    Data: NullPtr
    Option: all
- enabled-by: true
  post-conditions:
    Status: Success
    Data: Red
  pre-conditions:
    Data: Valid
    Option: Red
- enabled-by: true
  post-conditions:
    Status: Success
    Data: Green
  pre-conditions:
    Data: Valid
    Option: Green
rationale: null
references: []
text: |
  ${.:/text-template}
type: requirement

5.2.2.41. Generic Functional Requirement Item Type¶

This type refines the following types:

Functional Requirement Item Type though the functional-type attribute if the value is capability
Functional Requirement Item Type though the functional-type attribute if the value is dependability-function
Functional Requirement Item Type though the functional-type attribute if the value is function
Functional Requirement Item Type though the functional-type attribute if the value is operational
Functional Requirement Item Type though the functional-type attribute if the value is safety-function

Items of this type state a functional requirement with the functional type defined by the specification type refinement.

5.2.2.42. Non-Functional Requirement Item Type¶

This type refines the Requirement Item Type though the requirement-type attribute if the value is non-functional. This set of attributes specifies a non-functional requirement. All explicit attributes shall be specified. The explicit attributes for this type are:

non-functional-type: The attribute value shall be a Requirement Non-Functional Type. It shall be the non-functional type of the requirement.

5.2.2.43. Requirement Validation Item Type¶

This type refines the Root Item Type though the type attribute if the value is validation. This set of attributes provides a requirement validation evidence. The item shall have exactly one link to the validated requirement with the Requirement Validation Link Role. All explicit attributes shall be specified. The explicit attributes for this type are:

method

The attribute value shall be a Requirement Validation Method. Validation by test is done through Test Case Item Type items.

text

The attribute value shall be a string. It shall provide the validation evidence depending on the validation method:

By analysis: A statement shall be provided how the requirement is met, by analysing static properties of the software product.
By inspection: A statement shall be provided how the requirement is met, by inspection of the source code.
By review of design: A rationale shall be provided to demonstrate how the requirement is satisfied implicitly by the software design.

5.2.2.44. Specification Item Type¶

This type refines the Root Item Type though the type attribute if the value is spec. This set of attributes specifies specification types. All explicit attributes shall be specified. The explicit attributes for this type are:

spec-description: The attribute value shall be an optional string. It shall be the description of the specification type.
spec-example: The attribute value shall be an optional string. If the value is present, then it shall be an example of the specification type.
spec-info: The attribute value shall be a Specification Information.
spec-name: The attribute value shall be an optional string. It shall be the human readable name of the specification type.
spec-type: The attribute value shall be a Name. It shall the specification type.

Please have a look at the following example:

SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
links:
- role: spec-member
  uid: root
- role: spec-refinement
  spec-key: type
  spec-value: example
  uid: root
spec-description: null
spec-example: null
spec-info:
  dict:
    attributes:
      an-example-attribute:
        description: |
          It shall be an example.
        spec-type: optional-str
      example-number:
        description: |
          It shall be the example number.
        spec-type: int
    description: |
      This set of attributes specifies an example.
    mandatory-attributes: all
spec-name: Example Item Type
spec-type: spec
type: spec

5.2.2.45. Test Case Item Type¶

This type refines the Root Item Type though the type attribute if the value is test-case. This set of attributes specifies a test case. All explicit attributes shall be specified. The explicit attributes for this type are:

actions: The attribute value shall be a list. Each list element shall be a Test Case Action.
brief: The attribute value shall be a string. It shall be the test case brief description.
description: The attribute value shall be an optional string. It shall be the test case description.
epilogue: The attribute value shall be an optional string. If the value is present, then it shall be the test case epilogue code. The epilogue code is placed in the test case body after the test case actions.
fixture: The attribute value shall be an optional string. If the value is present, then it shall be a pointer to the test case fixture. The test case fixture pointer declaration may be provided by the test case support code or via an included header file.
includes: The attribute value shall be a list of strings. It shall be a list of header files included via #include <...>.
local-includes: The attribute value shall be a list of strings. It shall be a list of header files included via #include "...".
name: The attribute value shall be a Test Name.
prologue: The attribute value shall be an optional string. If the value is present, then it shall be the test case prologue code. The prologue code is placed in the test case body before the test case actions. A use case is the declaration of local variables used by the test case actions.
support: The attribute value shall be an optional string. If the value is present, then it shall be the test case support code. The support code is placed at file scope before the test case code.
target: The attribute value shall be a string. It shall be the path to the generated target test case source file.

5.2.2.46. Test Platform Item Type¶

This type refines the Root Item Type though the type attribute if the value is test-platform. Please note:

Warning

This item type is work in progress.

This set of attributes specifies a test platform. All explicit attributes shall be specified. The explicit attributes for this type are:

description: The attribute value shall be a string. It shall be the description of the test platform.
name: The attribute value shall be a string. It shall be the human readable name of the test platform.

5.2.2.47. Test Procedure Item Type¶

This type refines the Root Item Type though the type attribute if the value is test-procedure. Please note:

Warning

This item type is work in progress.

This set of attributes specifies a test procedure. All explicit attributes shall be specified. The explicit attributes for this type are:

name: The attribute value shall be a string. It shall be the human readable name of the test procedure.
purpose: The attribute value shall be a string. It shall state the purpose of the test procedure.
steps: The attribute value shall be a string. It shall describe the steps of the test procedure execution.

5.2.2.48. Test Suite Item Type¶

This type refines the Root Item Type though the type attribute if the value is test-suite. This set of attributes specifies a test suite. All explicit attributes shall be specified. The explicit attributes for this type are:

brief: The attribute value shall be a string. It shall be the test suite brief description.
code: The attribute value shall be a string. It shall be the test suite code. The test suite code is placed at file scope in the target source file.
description: The attribute value shall be an optional string. It shall be the test suite description.
includes: The attribute value shall be a list of strings. It shall be a list of header files included via #include <...>.
local-includes: The attribute value shall be a list of strings. It shall be a list of header files included via #include "...".
name: The attribute value shall be a Test Name.
target: The attribute value shall be a string. It shall be the path to the generated target test suite source file.

5.2.3. Specification Attribute Sets and Value Types¶

5.2.3.1. Action Requirement Condition¶

This set of attributes defines an action pre-condition or post-condition. All explicit attributes shall be specified. The explicit attributes for this type are:

name: The attribute value shall be an Action Requirement Name.
states: The attribute value shall be a list. Each list element shall be an Action Requirement State.
test-epilogue: The attribute value shall be an optional string. If the value is present, then it shall be the test epilogue code. The epilogue code is placed in the test condition preparation or check before the state-specific code. The code may use a local variable ctx which points to the test context, see Action Requirement Test Context Member.
test-prologue: The attribute value shall be an optional string. If the value is present, then it shall be the test prologue code. The prologue code is placed in the test condition preparation or check after the state-specific code. The code may use a local variable ctx which points to the test context, see Action Requirement Test Context Member.

This type is used by the following types:

Action Requirement Item Type

5.2.3.2. Action Requirement Name¶

The value shall be a string. It shall be the name of a condition or a state of a condition used to define pre-conditions and post-conditions of an action requirement. It shall be formatted in CamelCase. It should be brief and abbreviated. The rationale for this is that the names are used in tables and the horizontal space is limited by the page width. The more conditions you have in an action requirement, the shorter the names should be. The value shall match with the regular expression “^[A-Z][a-zA-Z0-9]+$".

This type is used by the following types:

Action Requirement Condition
Action Requirement State
Action Requirement Transition Post-Conditions
Action Requirement Transition Pre-Conditions

5.2.3.3. Action Requirement State¶

This set of attributes defines an action pre-condition or post-condition state. All explicit attributes shall be specified. The explicit attributes for this type are:

name: The attribute value shall be an Action Requirement Name.
test-code: The attribute value shall be a string. It shall be the test code to prepare or check the state of the condition. The code may use a local variable ctx which points to the test context, see Action Requirement Test Context Member.
text: The attribute value shall be a Requirement Text. It shall define the state of the condition.

This type is used by the following types:

Action Requirement Condition

5.2.3.4. Action Requirement Test Context Member¶

A value of this type shall be of one of the following variants:

The value may be a set of attributes. This set of attributes defines an action requirement test context member. All explicit attributes shall be specified. The explicit attributes for this type are:

brief
The attribute value shall be an optional string. It shall be the test context member brief description.

description
The attribute value shall be an optional string. It shall be the test context member description.

member
The attribute value shall be a string. It shall be the test context member definition. It shall be a valid C structure member definition without a trailing ;.
There may by be no value (null).

This type is used by the following types:

Action Requirement Item Type

5.2.3.5. Action Requirement Test Fixture Method¶

A value of this type shall be of one of the following variants:

The value may be a set of attributes. This set of attributes defines an action requirement test fixture method. All explicit attributes shall be specified. The explicit attributes for this type are:

brief
The attribute value shall be an optional string. It shall be the test fixture method brief description.

code
The attribute value shall be a string. It shall be the test fixture method code. The code may use a local variable ctx which points to the test context, see Action Requirement Test Context Member.

description
The attribute value shall be an optional string. It shall be the test fixture method description.
There may by be no value (null).

This type is used by the following types:

Action Requirement Item Type

5.2.3.6. Action Requirement Test Header¶

A value of this type shall be of one of the following variants:

The value may be a set of attributes. This set of attributes specifies an action requirement test header. In case a test header is specified, then instead of a test case a test run function will be generated. The test run function will be declared in the test header target file and defined in the test source target file. The test run function can be used to compose test cases. The test header file is not automatically included in the test source file. It should be added to the includes or local includes of the test. All explicit attributes shall be specified. The explicit attributes for this type are:

code
The attribute value shall be an optional string. If the value is present, then it shall be the test case header code. The header code is placed at file scope after the test enum declarations and before the test run function declaration.

includes
The attribute value shall be a list of strings. It shall be a list of header files included by the header file via #include <...>.

local-includes
The attribute value shall be a list of strings. It shall be a list of header files included by the header file via #include "...".

run-params
The attribute value shall be a list. Each list element shall be an Action Requirement Test Run Parameter.

target
The attribute value shall be a string. It shall be the path to the generated test header file.
There may by be no value (null).

This type is used by the following types:

Action Requirement Item Type

5.2.3.7. Action Requirement Test Run Parameter¶

This set of attributes specifies a parameter for the test run function. The parameter is also added as a member to the test context, see Action Requirement Test Context Member. All explicit attributes shall be specified. The explicit attributes for this type are:

description: The attribute value shall be a string. It shall be the description of the parameter.
dir: The attribute value shall be an Interface Parameter Direction.
name: The attribute value shall be a string. It shall be the parameter name.
specifier: The attribute value shall be a string. It shall be the complete function parameter specifier. Use ${.:name} for the parameter name, for example "int ${.:name}".

This type is used by the following types:

Action Requirement Test Header

5.2.3.8. Action Requirement Transition¶

This set of attributes defines the transition from multiple sets of states of pre-conditions to a set of states of post-conditions through an action in an action requirement. The ability to specify multiple sets of states of pre-conditions which result in a common set of post-conditions may allow a more compact specification of the transition map. For example, let us suppose you want to specify the action of a function with a pointer parameter. The function performs an early check that the pointer is NULL and in this case returns an error code. The pointer condition dominates the action outcome if the pointer is NULL. Other pre-condition states can be simply set to all for this transition. All explicit attributes shall be specified. The explicit attributes for this type are:

enabled-by: The attribute value shall be an Enabled-By Expression. The transition map may be customized to support configuration variants through this attribute. The default transitions (enabled-by: true) shall be specified before the customized variants in the list.
post-conditions: The attribute value shall be an Action Requirement Transition Post-Conditions.
pre-conditions: The attribute value shall be an Action Requirement Transition Pre-Conditions.

This type is used by the following types:

Action Requirement Item Type

5.2.3.9. Action Requirement Transition Post-Conditions¶

This set of attributes defines for each post-condition the state after the action for a transition in an action requirement. Generic attributes may be specified. Each generic attribute key shall be an Action Requirement Name. Each generic attribute value shall be an Action Requirement Name. There shall be exactly one generic attribute key for each post-condition. The key name shall be the post-condition name. The value of each generic attribute shall be the state of the post-condition.

This type is used by the following types:

Action Requirement Transition

5.2.3.10. Action Requirement Transition Pre-Condition State Set¶

A value of this type shall be of one of the following variants:

The value may be a list. Each list element shall be an Action Requirement Name. The list defines the set of states of the pre-condition in the transition.
The value may be a string. The value represents all states of the pre-condition in the transition. The value shall be equal to “all”.

This type is used by the following types:

Action Requirement Transition Pre-Conditions

5.2.3.11. Action Requirement Transition Pre-Conditions¶

This set of attributes defines for each pre-condition the set of states before the action for a transition in an actin requirement. Generic attributes may be specified. Each generic attribute key shall be an Action Requirement Name. Each generic attribute value shall be an Action Requirement Transition Pre-Condition State Set. There shall be exactly one generic attribute key for each pre-condition. The key name shall be the pre-condition name. The value of each generic attribute shall be a set of states of the pre-condition.

This type is used by the following types:

Action Requirement Transition

5.2.3.12. Application Configuration Group Member Link Role¶

This type refines the Link though the role attribute if the value is appl-config-group-member. It defines the application configuration group membership role of links.

5.2.3.13. Application Configuration Option Constraint Set¶

This set of attributes defines application configuration option constraints. Additional constraints can be added through the links of the item using the Constraint Link Role. None of the explicit attributes is mandatory, they are all are optional. The explicit attributes for this type are:

max: The attribute value shall be an Integer or String. It shall be the maximum value of the application configuration option.
min: The attribute value shall be an Integer or String. It shall be the minimum value of the application configuration option.
set: The attribute value shall be a list. Each list element shall be an Integer or String. It shall be the set of valid values for the application configuration option.
texts: The attribute value shall be a list. Each list element shall be a Requirement Text. It shall be a list of constraints specific to this application configuration option. For general constraints, use a link with the Constraint Link Role to a constraint item.

This type is used by the following types:

Application Configuration Value Option Item Type

5.2.3.14. Application Configuration Option Name¶

The value shall be a string. It shall be the name of an application configuration option. The value shall match with the regular expression “^(CONFIGURE_|BSP_)[A-Z0-9_]+$".

This type is used by the following types:

Application Configuration Option Item Type

5.2.3.15. Boolean or Integer or String¶

A value of this type shall be of one of the following variants:

The value may be a boolean.
The value may be an integer number.
The value may be a string.

This type is used by the following types:

Build Option Action
Interface Return Value

5.2.3.16. Build Assembler Option¶

The value shall be a string. It shall be an option for the assembler. The options are used to assemble the sources of this item. The options defined by this attribute succeed the options presented to the item by the build item context.

This type is used by the following types:

Build Script Item Type
Build Start File Item Type

5.2.3.17. Build C Compiler Option¶

The value shall be a string. It shall be an option for the C compiler. The options are used to compile the sources of this item. The options defined by this attribute succeed the options presented to the item by the build item context.

This type is used by the following types:

Build Ada Test Program Item Type
Build BSP Item Type
Build Library Item Type
Build Objects Item Type
Build Option C Compiler Check Action
Build Script Item Type
Build Test Program Item Type

5.2.3.18. Build C Preprocessor Option¶

The value shall be a string. It shall be an option for the C preprocessor. The options are used to preprocess the sources of this item. The options defined by this attribute succeed the options presented to the item by the build item context.

This type is used by the following types:

Build Ada Test Program Item Type
Build BSP Item Type
Build Library Item Type
Build Objects Item Type
Build Script Item Type
Build Start File Item Type
Build Test Program Item Type

5.2.3.19. Build C++ Compiler Option¶

The value shall be a string. It shall be an option for the C++ compiler. The options are used to compile the sources of this item. The options defined by this attribute succeed the options presented to the item by the build item context.

This type is used by the following types:

Build Library Item Type
Build Objects Item Type
Build Option C++ Compiler Check Action
Build Script Item Type
Build Test Program Item Type

5.2.3.20. Build Dependency Link Role¶

This type refines the Link though the role attribute if the value is build-dependency. It defines the build dependency role of links.

5.2.3.21. Build Include Path¶

The value shall be a string. It shall be a path to header files. The path is used by the C preprocessor to search for header files. It succeeds the includes presented to the item by the build item context. For an Build Group Item Type item the includes are visible to all items referenced by the group item. For Build BSP Item Type, Build Objects Item Type, Build Library Item Type, Build Start File Item Type, and Build Test Program Item Type items the includes are only visible to the sources specified by the item itself and they do not propagate to referenced items.

This type is used by the following types:

Build Ada Test Program Item Type
Build BSP Item Type
Build Group Item Type
Build Library Item Type
Build Objects Item Type
Build Script Item Type
Build Start File Item Type
Build Test Program Item Type

5.2.3.22. Build Install Directive¶

This set of attributes specifies files installed by a build item. All explicit attributes shall be specified. The explicit attributes for this type are:

destination: The attribute value shall be a string. It shall be the install destination directory.
source: The attribute value shall be a list of strings. It shall be the list of source files to be installed in the destination directory. The path to a source file shall be relative to the directory of the wscript.

This type is used by the following types:

Build BSP Item Type
Build Group Item Type
Build Library Item Type
Build Objects Item Type

5.2.3.23. Build Install Path¶

A value of this type shall be of one of the following variants:

There may by be no value (null).
The value may be a string. It shall be the installation path of a Build Target.

This type is used by the following types:

Build Configuration File Item Type
Build Configuration Header Item Type
Build Library Item Type
Build Start File Item Type

5.2.3.24. Build Linker Option¶

The value shall be a string. It shall be an option for the linker. The options are used to link executables. The options defined by this attribute succeed the options presented to the item by the build item context.

This type is used by the following types:

Build Ada Test Program Item Type
Build Script Item Type
Build Test Program Item Type

5.2.3.25. Build Option Action¶

This set of attributes specifies a build option action. Exactly one of the explicit attributes shall be specified. The explicit attributes for this type are:

append-test-cppflags: The attribute value shall be a string. It shall be the name of a test program. The action appends the action value to the CPPFLAGS of the test program. The name shall correspond to the name of a Build Test Program Item Type item. Due to the processing order of items, there is no way to check if the name specified by the attribute value is valid.
assert-aligned: The attribute value shall be an integer number. The action asserts that the action value is aligned according to the attribute value.
assert-eq: The attribute value shall be a Boolean or Integer or String. The action asserts that the action value is equal to the attribute value.
assert-ge: The attribute value shall be an Integer or String. The action asserts that the action value is greater than or equal to the attribute value.
assert-gt: The attribute value shall be an Integer or String. The action asserts that the action value is greater than the attribute value.
assert-int16: The attribute shall have no value. The action asserts that the action value is a valid signed 16-bit integer.
assert-int32: The attribute shall have no value. The action asserts that the action value is a valid signed 32-bit integer.
assert-int64: The attribute shall have no value. The action asserts that the action value is a valid signed 64-bit integer.
assert-int8: The attribute shall have no value. The action asserts that the action value is a valid signed 8-bit integer.
assert-le: The attribute value shall be an Integer or String. The action asserts that the action value is less than or equal to the attribute value.
assert-lt: The attribute value shall be an Integer or String. The action asserts that the action value is less than the attribute value.
assert-ne: The attribute value shall be a Boolean or Integer or String. The action asserts that the action value is not equal to the attribute value.
assert-power-of-two: The attribute shall have no value. The action asserts that the action value is a power of two.
assert-uint16: The attribute shall have no value. The action asserts that the action value is a valid unsigned 16-bit integer.
assert-uint32: The attribute shall have no value. The action asserts that the action value is a valid unsigned 32-bit integer.
assert-uint64: The attribute shall have no value. The action asserts that the action value is a valid unsigned 64-bit integer.
assert-uint8: The attribute shall have no value. The action asserts that the action value is a valid unsigned 8-bit integer.
check-cc: The attribute value shall be a Build Option C Compiler Check Action.
check-cxx: The attribute value shall be a Build Option C++ Compiler Check Action.
define: The attribute value shall be an optional string. The action adds a define to the configuration set. If the attribute value is present, then it is used as the name of the define, otherwise the name of the item is used. The value of the define is the action value. If the action value is a string, then it is quoted.
define-condition: The attribute value shall be an optional string. The action adds a conditional define to the configuration set. If the attribute value is present, then it is used as the name of the define, otherwise the name of the item is used. The value of the define is the action value.
define-unquoted: The attribute value shall be an optional string. The action adds a define to the configuration set. If the attribute value is present, then it is used as the name of the define, otherwise the name of the item is used. The value of the define is the action value. If the action value is a string, then it is not quoted.
env-append: The attribute value shall be an optional string. The action appends the action value to an environment of the configuration set. If the attribute value is present, then it is used as the name of the environment variable, otherwise the name of the item is used.
env-assign: The attribute value shall be an optional string. The action assigns the action value to an environment of the configuration set. If the attribute value is present, then it is used as the name of the environment variable, otherwise the name of the item is used.
env-enable: The attribute value shall be an optional string. If the action value is true, then a name is appended to the ENABLE environment variable of the configuration set. If the attribute value is present, then it is used as the name, otherwise the name of the item is used.
find-program: The attribute shall have no value. The action tries to find the program specified by the action value. Uses the ${PATH} to find the program. Returns the result of the find operation, e.g. a path to the program.
find-tool: The attribute shall have no value. The action tries to find the tool specified by the action value. Uses the tool paths specified by the --rtems-tools command line option. Returns the result of the find operation, e.g. a path to the program.
format-and-define: The attribute value shall be an optional string. The action adds a define to the configuration set. If the attribute value is present, then it is used as the name of the define, otherwise the name of the item is used. The value of the define is the action value. The value is formatted according to the format attribute value.
get-boolean: The attribute shall have no value. The action gets the action value for subsequent actions from a configuration file variable named by the items name attribute. If no such variable exists in the configuration file, then the default value is used. The value is converted to a boolean.
get-env: The attribute value shall be a string. The action gets the action value for subsequent actions from the environment variable of the configuration set named by the attribute value.
get-integer: The attribute shall have no value. The action gets the action value for subsequent actions from a configuration file variable named by the items name attribute. If no such variable exists in the configuration file, then the default value is used. The value is converted to an integer.
get-string: The attribute shall have no value. The action gets the action value for subsequent actions from a configuration file variable named by the items name attribute. If no such variable exists in the configuration file, then the default value is used. The value is converted to a string.
script: The attribute value shall be a string. The action executes the attribute value with the Python eval() function in the context of the script action handler.
set-test-state: The attribute value shall be a Build Option Set Test State Action.
set-value: The attribute value shall be a Build Option Value. The action sets the action value for subsequent actions to the attribute value.
split: The attribute shall have no value. The action splits the action value.
substitute: The attribute shall have no value. The action Performs a ${VARIABLE} substitution on the action value. Use $$ for a plain $ character.

This type is used by the following types:

Build Option Item Type

5.2.3.26. Build Option C Compiler Check Action¶

This set of attributes specifies a check done using the C compiler. All explicit attributes shall be specified. The explicit attributes for this type are:

cflags: The attribute value shall be a list. Each list element shall be a Build C Compiler Option.
fragment: The attribute value shall be a string. It shall be a code fragment used to check the availability of a certain feature through compilation with the C compiler. The resulting object is not linked to an executable.
message: The attribute value shall be a string. It shall be a description of the feature to check.

This type is used by the following types:

Build Option Action

5.2.3.27. Build Option C++ Compiler Check Action¶

This set of attributes specifies a check done using the C++ compiler. All explicit attributes shall be specified. The explicit attributes for this type are:

cxxflags: The attribute value shall be a list. Each list element shall be a Build C++ Compiler Option.
fragment: The attribute value shall be a string. It shall be a code fragment used to check the availability of a certain feature through compilation with the C++ compiler. The resulting object is not linked to an executable.
message: The attribute value shall be a string. It shall be a description of the feature to check.

This type is used by the following types:

Build Option Action

5.2.3.28. Build Option Default by Variant¶

This set of attributes specifies build option default values by variant. All explicit attributes shall be specified. The explicit attributes for this type are:

value: The attribute value shall be a Build Option Value. It value shall be the default value for the matching variants.
variants: The attribute value shall be a list of strings. It shall be a list of Python regular expression matching with the desired variants.

This type is used by the following types:

Build Option Item Type

5.2.3.29. Build Option Name¶

The value shall be a string. It shall be the name of the build option. The value shall match with the regular expression “^[a-zA-Z_][a-zA-Z0-9_]*$".

This type is used by the following types:

Build Option Item Type

5.2.3.30. Build Option Set Test State Action¶

This set of attributes specifies test states for a set of test programs. Generic attributes may be specified. Each generic attribute key shall be a Name. Each generic attribute value shall be a Build Test State. The keys shall be test program names. The names shall correspond to the name of a Build Test Program Item Type or Build Ada Test Program Item Type item. Due to the processing order of items, there is no way to check if the name specified by the attribute key is valid.

This type is used by the following types:

Build Option Action

5.2.3.31. Build Option Value¶

A value of this type shall be of one of the following variants:

The value may be a boolean.
The value may be an integer number.
The value may be a list. Each list element shall be a string.
There may by be no value (null).
The value may be a string.

This type is used by the following types:

Build Option Action
Build Option Default by Variant
Build Option Item Type

5.2.3.32. Build Source¶

The value shall be a string. It shall be a source file. The path to a source file shall be relative to the directory of the wscript.

This type is used by the following types:

Build Ada Test Program Item Type
Build BSP Item Type
Build Library Item Type
Build Objects Item Type
Build Start File Item Type
Build Test Program Item Type

5.2.3.33. Build Target¶

The value shall be a string. It shall be the target file path. The path to the target file shall be relative to the directory of the wscript. The target file is located in the build tree.

This type is used by the following types:

Build Ada Test Program Item Type
Build Configuration File Item Type
Build Configuration Header Item Type
Build Library Item Type
Build Start File Item Type
Build Test Program Item Type

5.2.3.34. Build Test State¶

The value shall be a string. This string defines a test state. The value shall be an element of

“benchmark”,
“exclude”,
“expected-fail”,
“indeterminate”, and
“user-input”.

This type is used by the following types:

Build Option Set Test State Action

5.2.3.35. Build Use After Directive¶

The value shall be a string. It shall be an internal static library identifier. They are used to link programs referenced by this item, e.g. z for libz.a. They are placed after the use items of the build item context.

This type is used by the following types:

Build Ada Test Program Item Type
Build Group Item Type
Build Script Item Type
Build Test Program Item Type

5.2.3.36. Build Use Before Directive¶

The value shall be a string. It shall be an internal static library identifier. They are used to link programs referenced by this item, e.g. z for libz.a. They are placed before the use items of the build item context.

This type is used by the following types:

Build Ada Test Program Item Type
Build Group Item Type
Build Script Item Type
Build Test Program Item Type

5.2.3.37. Constraint Link Role¶

This type refines the Link though the role attribute if the value is constraint. It defines the constraint role of links. The link target shall be a constraint.

5.2.3.38. Copyright¶

The value shall be a string. It shall be a copyright statement of a copyright holder of the specification item. The value

shall match with the regular expression “^\s*Copyright\s+$C$\s+[0-9]+,\s*[0-9]+\s+.+\s*$",
or, shall match with the regular expression “^\s*Copyright\s+$C$\s+[0-9]+\s+.+\s*$",
or, shall match with the regular expression “^\s*Copyright\s+$C$\s+.+\s*$".

This type is used by the following types:

Root Item Type

5.2.3.39. Enabled-By Expression¶

A value of this type shall be an expression which defines under which conditions the specification item or parts of it are enabled. The expression is evaluated with the use of an enabled set. This is a set of strings which indicate enabled features.

A value of this type shall be of one of the following variants:

The value may be a boolean. This expression evaluates directly to the boolean value.
The value may be a set of attributes. Each attribute defines an operator. Exactly one of the explicit attributes shall be specified. The explicit attributes for this type are:

and
The attribute value shall be a list. Each list element shall be an Enabled-By Expression. The and operator evaluates to the logical and of the evaluation results of the expressions in the list.

not
The attribute value shall be an Enabled-By Expression. The not operator evaluates to the logical not of the evaluation results of the expression.

or
The attribute value shall be a list. Each list element shall be an Enabled-By Expression. The or operator evaluates to the logical or of the evaluation results of the expressions in the list.
The value may be a list. Each list element shall be an Enabled-By Expression. This list of expressions evaluates to the logical or of the evaluation results of the expressions in the list.
The value may be a string. If the value is in the enabled set, this expression evaluates to true, otherwise to false.

This type is used by the following types:

Action Requirement Transition
Enabled-By Expression
Interface Include Link Role
Root Item Type

Please have a look at the following example:

enabled-by:
  and:
  - RTEMS_NETWORKING
  - not: RTEMS_SMP

5.2.3.40. Glossary Membership Link Role¶

This type refines the Link though the role attribute if the value is glossary-member. It defines the glossary membership role of links.

5.2.3.41. Integer or String¶

A value of this type shall be of one of the following variants:

The value may be an integer number.
The value may be a string.

This type is used by the following types:

Application Configuration Option Constraint Set
Application Configuration Value Option Item Type
Build Option Action

5.2.3.42. Interface Brief Description¶

A value of this type shall be of one of the following variants:

There may by be no value (null).
The value may be a string. It shall be the brief description of the interface.

This type is used by the following types:

Interface Compound Item Type
Interface Compound Member Definition
Interface Define Item Type
Interface Enum Item Type
Interface Enumerator Item Type
Interface Function Item Type
Interface Group Item Type
Interface Macro Item Type
Interface Typedef Item Type
Interface Variable Item Type

5.2.3.43. Interface Compound Definition Kind¶

The value shall be a string. It specifies how the interface compound is defined. It may be a typedef only, the struct or union only, or a typedef with a struct or union definition. The value shall be an element of

“struct-only”,
“typedef-and-struct”,
“typedef-and-union”,
“typedef-only”, and
“union-only”.

This type is used by the following types:

Interface Compound Item Type

5.2.3.44. Interface Compound Member Compound¶

This type refines the following types:

Interface Compound Member Definition though the kind attribute if the value is struct
Interface Compound Member Definition though the kind attribute if the value is union

This set of attributes specifies an interface compound member compound. All explicit attributes shall be specified. The explicit attributes for this type are:

definition: The attribute value shall be a list. Each list element shall be an Interface Compound Member Definition Directive.

5.2.3.45. Interface Compound Member Declaration¶

This type refines the Interface Compound Member Definition though the kind attribute if the value is member. This set of attributes specifies an interface compound member declaration. All explicit attributes shall be specified. The explicit attributes for this type are:

definition: The attribute value shall be a string. It shall be the interface compound member declaration. On the declaration a context-sensitive substitution of item variables is performed.

5.2.3.46. Interface Compound Member Definition¶

This set of attributes specifies an interface compound member definition. All explicit attributes shall be specified. The explicit attributes for this type are:

brief: The attribute value shall be an Interface Brief Description.
description: The attribute value shall be an Interface Description.
kind: The attribute value shall be a string. It shall be the interface compound member kind.
name: The attribute value shall be a string. It shall be the interface compound member name.

This type is refined by the following types:

Interface Compound Member Compound
Interface Compound Member Declaration

This type is used by the following types:

Interface Compound Member Definition Directive
Interface Compound Member Definition Variant

5.2.3.47. Interface Compound Member Definition Directive¶

This set of attributes specifies an interface compound member definition directive. All explicit attributes shall be specified. The explicit attributes for this type are:

default: The attribute value shall be an Interface Compound Member Definition. The default definition will be used if no variant-specific definition is enabled.
variants: The attribute value shall be a list. Each list element shall be an Interface Compound Member Definition Variant.

This type is used by the following types:

Interface Compound Item Type
Interface Compound Member Compound

5.2.3.48. Interface Compound Member Definition Variant¶

This set of attributes specifies an interface compound member definition variant. All explicit attributes shall be specified. The explicit attributes for this type are:

definition: The attribute value shall be an Interface Compound Member Definition. The definition will be used if the expression defined by the enabled-by attribute evaluates to true. In generated header files, the expression is evaluated by the C preprocessor.
enabled-by: The attribute value shall be an Interface Enabled-By Expression.

This type is used by the following types:

Interface Compound Member Definition Directive

5.2.3.49. Interface Definition¶

A value of this type shall be of one of the following variants:

There may by be no value (null).
The value may be a string. It shall be the definition. On the definition a context-sensitive substitution of item variables is performed.

This type is used by the following types:

Interface Definition Directive
Interface Definition Variant

5.2.3.50. Interface Definition Directive¶

This set of attributes specifies an interface definition directive. All explicit attributes shall be specified. The explicit attributes for this type are:

default: The attribute value shall be an Interface Definition. The default definition will be used if no variant-specific definition is enabled.
variants: The attribute value shall be a list. Each list element shall be an Interface Definition Variant.

This type is used by the following types:

Interface Define Item Type
Interface Enumerator Item Type
Interface Macro Item Type
Interface Typedef Item Type
Interface Variable Item Type

5.2.3.51. Interface Definition Variant¶

This set of attributes specifies an interface definition variant. All explicit attributes shall be specified. The explicit attributes for this type are:

definition: The attribute value shall be an Interface Definition. The definition will be used if the expression defined by the enabled-by attribute evaluates to true. In generated header files, the expression is evaluated by the C preprocessor.
enabled-by: The attribute value shall be an Interface Enabled-By Expression.

This type is used by the following types:

Interface Definition Directive

5.2.3.52. Interface Description¶

A value of this type shall be of one of the following variants:

There may by be no value (null).
The value may be a string. It shall be the description of the interface. The description should be short and concentrate on the average case. All special cases, usage notes, constraints, error conditions, configuration dependencies, references, etc. should be described in the Interface Notes.

This type is used by the following types:

Application Configuration Option Item Type
Interface Compound Item Type
Interface Compound Member Definition
Interface Define Item Type
Interface Enum Item Type
Interface Enumerator Item Type
Interface Function Item Type
Interface Group Item Type
Interface Macro Item Type
Interface Parameter
Interface Return Value
Interface Typedef Item Type
Interface Variable Item Type

5.2.3.53. Interface Enabled-By Expression¶

A value of this type shall be an expression which defines under which conditions an interface definition is enabled. In generated header files, the expression is evaluated by the C preprocessor.

A value of this type shall be of one of the following variants:

The value may be a boolean. It is converted to 0 or 1. It defines a symbol in the expression.
The value may be a set of attributes. Each attribute defines an operator. Exactly one of the explicit attributes shall be specified. The explicit attributes for this type are:

and
The attribute value shall be a list. Each list element shall be an Interface Enabled-By Expression. The and operator defines a logical and of the expressions in the list.

not
The attribute value shall be an Interface Enabled-By Expression. The not operator defines a logical not of the expression.

or
The attribute value shall be a list. Each list element shall be an Interface Enabled-By Expression. The or operator defines a logical or of the expressions in the list.
The value may be a list. Each list element shall be an Interface Enabled-By Expression. It defines a logical or of the expressions in the list.
The value may be a string. It defines a symbol in the expression.

This type is used by the following types:

Interface Compound Member Definition Variant
Interface Definition Variant
Interface Enabled-By Expression
Interface Function Definition Variant

5.2.3.54. Interface Enum Definition Kind¶

The value shall be a string. It specifies how the enum is defined. It may be a typedef only, the enum only, or a typedef with an enum definition. The value shall be an element of

“enum-only”,
“typedef-and-enum”, and
“typedef-only”.

This type is used by the following types:

Interface Enum Item Type

5.2.3.55. Interface Enumerator Link Role¶

This type refines the Link though the role attribute if the value is interface-enumerator. It defines the interface enumerator role of links.

5.2.3.56. Interface Function Definition¶

This set of attributes specifies a function definition. All explicit attributes shall be specified. The explicit attributes for this type are:

body: The attribute value shall be an optional string. If the value is present, then it shall be the definition of a static inline function. On the function definition a context-sensitive substitution of item variables is performed. If no value is present, then the function is declared as an external function.
params: The attribute value shall be a list of strings. It shall be the list of parameter declarations of the function. On the function parameter declarations a context-sensitive substitution of item variables is performed.
return: The attribute value shall be a string. It shall be the function return type. On the return type a context-sensitive substitution of item variables is performed.

This type is used by the following types:

Interface Function Definition Directive
Interface Function Definition Variant

5.2.3.57. Interface Function Definition Directive¶

This set of attributes specifies a function definition directive. All explicit attributes shall be specified. The explicit attributes for this type are:

default: The attribute value shall be an Interface Function Definition. The default definition will be used if no variant-specific definition is enabled.
variants: The attribute value shall be a list. Each list element shall be an Interface Function Definition Variant.

This type is used by the following types:

Interface Function Item Type

5.2.3.58. Interface Function Definition Variant¶

This set of attributes specifies a function definition variant. All explicit attributes shall be specified. The explicit attributes for this type are:

definition: The attribute value shall be an Interface Function Definition. The definition will be used if the expression defined by the enabled-by attribute evaluates to true. In generated header files, the expression is evaluated by the C preprocessor.
enabled-by: The attribute value shall be an Interface Enabled-By Expression.

This type is used by the following types:

Interface Function Definition Directive

5.2.3.59. Interface Function Link Role¶

This type refines the Link though the role attribute if the value is interface-function. It defines the interface function role of links. It is used to indicate that a Action Requirement Item Type item specifies functional requirements of an Interface Function Item Type or a Interface Macro Item Type item.

5.2.3.60. Interface Group Identifier¶

The value shall be a string. It shall be the identifier of the interface group. The value shall match with the regular expression “^[A-Z][a-zA-Z0-9]*$".

This type is used by the following types:

Interface Group Item Type

5.2.3.61. Interface Group Membership Link Role¶

This type refines the Link though the role attribute if the value is interface-ingroup. It defines the interface group membership role of links.

5.2.3.62. Interface Include Link Role¶

This type refines the Link though the role attribute if the value is interface-include. It defines the interface include role of links and is used to indicate that an interface container includes another interface container. For example, one header file includes another header file. All explicit attributes shall be specified. The explicit attributes for this type are:

enabled-by: The attribute value shall be an Enabled-By Expression. It shall define under which conditions the interface container is included.

5.2.3.63. Interface Notes¶

A value of this type shall be of one of the following variants:

There may by be no value (null).
The value may be a string. It shall be the notes for the interface.

This type is used by the following types:

Application Configuration Option Item Type
Interface Compound Item Type
Interface Define Item Type
Interface Enumerator Item Type
Interface Function Item Type
Interface Macro Item Type
Interface Typedef Item Type
Interface Variable Item Type

5.2.3.64. Interface Parameter¶

This set of attributes specifies an interface parameter. All explicit attributes shall be specified. The explicit attributes for this type are:

description: The attribute value shall be an Interface Description.
dir: The attribute value shall be an Interface Parameter Direction.
name: The attribute value shall be a string. It shall be the interface parameter name.

This type is used by the following types:

Interface Function Item Type
Interface Macro Item Type

5.2.3.65. Interface Parameter Direction¶

A value of this type shall be of one of the following variants:

There may by be no value (null).
The value may be a string. It specifies the interface parameter direction. The value shall be an element of
- “in”,
- “out”, and
- “inout”.

This type is used by the following types:

Action Requirement Test Run Parameter
Interface Parameter

5.2.3.66. Interface Placement Link Role¶

This type refines the Link though the role attribute if the value is interface-placement. It defines the interface placement role of links. It is used to indicate that an interface definition is placed into an interface container, for example a header file.

5.2.3.67. Interface Return Directive¶

This set of attributes specifies an interface return. All explicit attributes shall be specified. The explicit attributes for this type are:

return: The attribute value shall be an optional string. It shall describe the interface return for unspecified return values.
return-values: The attribute value shall be a list. Each list element shall be an Interface Return Value.

This type is used by the following types:

Interface Function Item Type
Interface Macro Item Type

5.2.3.68. Interface Return Value¶

This set of attributes specifies an interface return value. All explicit attributes shall be specified. The explicit attributes for this type are:

description: The attribute value shall be an Interface Description.
value: The attribute value shall be a Boolean or Integer or String. It shall be the described interface return value.

This type is used by the following types:

Interface Return Directive

5.2.3.69. Interface Target Link Role¶

This type refines the Link though the role attribute if the value is interface-target. It defines the interface target role of links. It is used for interface forward declarations.

5.2.3.70. Link¶

This set of attributes specifies a link from one specification item to another specification item. The links in a list are ordered. The first link in the list is processed first. All explicit attributes shall be specified. The explicit attributes for this type are:

role: The attribute value shall be a Name. It shall be the role of the link.
uid: The attribute value shall be an UID. It shall be the absolute or relative UID of the link target item.

This type is refined by the following types:

Application Configuration Group Member Link Role
Build Dependency Link Role
Constraint Link Role
Glossary Membership Link Role
Interface Enumerator Link Role
Interface Function Link Role
Interface Group Membership Link Role
Interface Include Link Role
Interface Placement Link Role
Interface Target Link Role
Requirement Refinement Link Role
Requirement Validation Link Role
Specification Member Link Role
Specification Refinement Link Role

This type is used by the following types:

Root Item Type
Test Case Action
Test Case Check

5.2.3.71. Name¶

The value shall be a string. A string is a valid name if it matches with the ^([a-z][a-z0-9-]*|SPDX-License-Identifier)$ regular expression.

This type is used by the following types:

Application Configuration Option Item Type
Build Item Type
Build Option Set Test State Action
Functional Requirement Item Type
Glossary Item Type
Interface Item Type
Link
Requirement Item Type
Root Item Type
Specification Attribute Value
Specification Explicit Attributes
Specification Generic Attributes
Specification Item Type
Specification List
Specification Refinement Link Role

5.2.3.72. Optional String¶

A value of this type shall be of one of the following variants:

There may by be no value (null).
The value may be a string.

5.2.3.73. Requirement Non-Functional Type¶

The value shall be a string. This type shall be used for non-functional requirement types. The value shall be an element of

“build-configuration”,
“constraint”,
“design”,
“documentation”,
“interface”,
“interface-requirement”,
“maintainability”,
“performance”,
“portability”,
“quality”,
“reliability”,
“resource”, and
“safety”.

This type is used by the following types:

Non-Functional Requirement Item Type

5.2.3.74. Requirement Reference¶

This set of attributes specifies a requirement reference. All explicit attributes shall be specified. The explicit attributes for this type are:

identifier: The attribute value shall be a string. It shall be the type-specific identifier of the reference target. For group references use the Doxygen group identifier.
type: The attribute value shall be a Requirement Reference Type.

This type is used by the following types:

Requirement Item Type

5.2.3.75. Requirement Reference Type¶

The value shall be a string. It specifies the type of a requirement reference. The value shall be an element of

“define”,
“file”,
“function”,
“group”,
“macro”, and
“variable”.

This type is used by the following types:

Requirement Reference

5.2.3.77. Requirement Text¶

The value shall be a string. It shall state a requirement or constraint. The value shall not contain an element of

“acceptable”,
“adequate”,
“almost always”,
“and/or”,
“appropriate”,
“approximately”,
“as far as possible”,
“as much as practicable”,
“best”,
“best possible”,
“easy”,
“efficient”,
“e.g.”,
“enable”,
“enough”,
“etc.”,
“few”,
“first rate”,
“flexible”,
“generally”,
“goal”,
“graceful”,
“great”,
“greatest”,
“ideally”,
“i.e.”,
“if possible”,
“in most cases”,
“large”,
“many”,
“maximize”,
“minimize”,
“most”,
“multiple”,
“necessary”,
“numerous”,
“optimize”,
“ought to”,
“probably”,
“quick”,
“rapid”,
“reasonably”,
“relevant”,
“robust”,
“satisfactory”,
“several”,
“shall be included but not limited to”,
“simple”,
“small”,
“some”,
“state of the art”,
“sufficient”,
“suitable”,
“support”,
“systematically”,
“transparent”,
“typical”,
“user friendly”,
“usually”,
“versatile”, and
“when necessary”.

This type is used by the following types:

Action Requirement State
Application Configuration Group Item Type
Application Configuration Option Constraint Set
Application Configuration Option Item Type
Constraint Item Type
Requirement Item Type

5.2.3.78. Requirement Validation Link Role¶

This type refines the Link though the role attribute if the value is validation. It defines the requirement validation role of links.

5.2.3.79. Requirement Validation Method¶

The value shall be a string. This value type characterizes a requirement validation method (except validation by test). The value shall be an element of

“by-analysis”,
“by-inspection”, and
“by-review-of-design”.

This type is used by the following types:

Requirement Validation Item Type

5.2.3.80. SPDX License Identifier¶

The value shall be a string. It defines the license of the item expressed though an SPDX License Identifier. The value

shall be equal to “CC-BY-SA-4.0 OR BSD-2-Clause”,
or, shall be equal to “BSD-2-Clause”,
or, shall be equal to “CC-BY-SA-4.0”.

This type is used by the following types:

Root Item Type

5.2.3.81. Specification Attribute Set¶

This set of attributes specifies a set of attributes. The following explicit attributes are mandatory:

attributes
description
mandatory-attributes

The explicit attributes for this type are:

attributes: The attribute value shall be a Specification Explicit Attributes. It shall specify the explicit attributes of the attribute set.
description: The attribute value shall be an optional string. It shall be the description of the attribute set.
generic-attributes: The attribute value shall be a Specification Generic Attributes. It shall specify the generic attributes of the attribute set.
mandatory-attributes: The attribute value shall be a Specification Mandatory Attributes. It shall specify the mandatory attributes of the attribute set.

This type is used by the following types:

Specification Information

5.2.3.82. Specification Attribute Value¶

This set of attributes specifies an attribute value. All explicit attributes shall be specified. The explicit attributes for this type are:

description: The attribute value shall be an optional string. It shall be the description of the attribute value.
spec-type: The attribute value shall be a Name. It shall be the specification type of the attribute value.

This type is used by the following types:

Specification Explicit Attributes

5.2.3.83. Specification Boolean Value¶

This attribute set specifies a boolean value. Only the description attribute is mandatory. The explicit attributes for this type are:

assert: The attribute value shall be a boolean. This optional attribute defines the value constraint of the specified boolean value. If the value of the assert attribute is true, then the value of the specified boolean value shall be true. If the value of the assert attribute is false, then the value of the specified boolean value shall be false. In case the assert attribute is not present, then the value of the specified boolean value may be true or false.
description: The attribute value shall be an optional string. It shall be the description of the specified boolean value.

This type is used by the following types:

Specification Information

5.2.3.84. Specification Explicit Attributes¶

Generic attributes may be specified. Each generic attribute key shall be a Name. Each generic attribute value shall be a Specification Attribute Value. Each generic attribute specifies an explicit attribute of the attribute set. The key of the each generic attribute defines the attribute key of the explicit attribute.

This type is used by the following types:

Specification Attribute Set

5.2.3.85. Specification Floating-Point Assert¶

A value of this type shall be an expression which asserts that the floating-point value of the specified attribute satisfies the required constraints.

A value of this type shall be of one of the following variants:

The value may be a set of attributes. Each attribute defines an operator. Exactly one of the explicit attributes shall be specified. The explicit attributes for this type are:

and
The attribute value shall be a list. Each list element shall be a Specification Floating-Point Assert. The and operator evaluates to the logical and of the evaluation results of the expressions in the list.

eq
The attribute value shall be a floating-point number. The eq operator evaluates to true, if the value to check is equal to the value of this attribute, otherwise to false.

ge
The attribute value shall be a floating-point number. The ge operator evaluates to true, if the value to check is greater than or equal to the value of this attribute, otherwise to false.

gt
The attribute value shall be a floating-point number. The gt operator evaluates to true, if the value to check is greater than the value of this attribute, otherwise to false.

le
The attribute value shall be a floating-point number. The le operator evaluates to true, if the value to check is less than or equal to the value of this attribute, otherwise to false.

lt
The attribute value shall be a floating-point number. The lt operator evaluates to true, if the value to check is less than the value of this attribute, otherwise to false.

ne
The attribute value shall be a floating-point number. The ne operator evaluates to true, if the value to check is not equal to the value of this attribute, otherwise to false.

not
The attribute value shall be a Specification Floating-Point Assert. The not operator evaluates to the logical not of the evaluation results of the expression.

or
The attribute value shall be a list. Each list element shall be a Specification Floating-Point Assert. The or operator evaluates to the logical or of the evaluation results of the expressions in the list.
The value may be a list. Each list element shall be a Specification Floating-Point Assert. This list of expressions evaluates to the logical or of the evaluation results of the expressions in the list.

This type is used by the following types:

Specification Floating-Point Assert
Specification Floating-Point Value

5.2.3.86. Specification Floating-Point Value¶

This set of attributes specifies a floating-point value. Only the description attribute is mandatory. The explicit attributes for this type are:

assert: The attribute value shall be a Specification Floating-Point Assert. This optional attribute defines the value constraints of the specified floating-point value. In case the assert attribute is not present, then the value of the specified floating-point value may be every valid floating-point number.
description: The attribute value shall be an optional string. It shall be the description of the specified floating-point value.

This type is used by the following types:

Specification Information

5.2.3.87. Specification Generic Attributes¶

This set of attributes specifies generic attributes. Generic attributes are attributes which are not explicitly specified by Specification Explicit Attributes. They are restricted to uniform attribute key and value types. All explicit attributes shall be specified. The explicit attributes for this type are:

description: The attribute value shall be an optional string. It shall be the description of the generic attributes.
key-spec-type: The attribute value shall be a Name. It shall be the specification type of the generic attribute keys.
value-spec-type: The attribute value shall be a Name. It shall be the specification type of the generic attribute values.

This type is used by the following types:

Specification Attribute Set

5.2.3.88. Specification Information¶

This set of attributes specifies attribute values. At least one of the explicit attributes shall be specified. The explicit attributes for this type are:

bool: The attribute value shall be a Specification Boolean Value. It shall specify a boolean value.
dict: The attribute value shall be a Specification Attribute Set. It shall specify a set of attributes.
float: The attribute value shall be a Specification Floating-Point Value. It shall specify a floating-point value.
int: The attribute value shall be a Specification Integer Value. It shall specify an integer value.
list: The attribute value shall be a Specification List. It shall specify a list of attributes or values.
none: The attribute shall have no value. It specifies that no value is required.
str: The attribute value shall be a Specification String Value. It shall specify a string.

This type is used by the following types:

Specification Item Type

5.2.3.89. Specification Integer Assert¶

A value of this type shall be an expression which asserts that the integer value of the specified attribute satisfies the required constraints.

A value of this type shall be of one of the following variants:

The value may be a set of attributes. Each attribute defines an operator. Exactly one of the explicit attributes shall be specified. The explicit attributes for this type are:

and
The attribute value shall be a list. Each list element shall be a Specification Integer Assert. The and operator evaluates to the logical and of the evaluation results of the expressions in the list.

eq
The attribute value shall be an integer number. The eq operator evaluates to true, if the value to check is equal to the value of this attribute, otherwise to false.

ge
The attribute value shall be an integer number. The ge operator evaluates to true, if the value to check is greater than or equal to the value of this attribute, otherwise to false.

gt
The attribute value shall be an integer number. The gt operator evaluates to true, if the value to check is greater than the value of this attribute, otherwise to false.

le
The attribute value shall be an integer number. The le operator evaluates to true, if the value to check is less than or equal to the value of this attribute, otherwise to false.

lt
The attribute value shall be an integer number. The lt operator evaluates to true, if the value to check is less than the value of this attribute, otherwise to false.

ne
The attribute value shall be an integer number. The ne operator evaluates to true, if the value to check is not equal to the value of this attribute, otherwise to false.

not
The attribute value shall be a Specification Integer Assert. The not operator evaluates to the logical not of the evaluation results of the expression.

or
The attribute value shall be a list. Each list element shall be a Specification Integer Assert. The or operator evaluates to the logical or of the evaluation results of the expressions in the list.
The value may be a list. Each list element shall be a Specification Integer Assert. This list of expressions evaluates to the logical or of the evaluation results of the expressions in the list.

This type is used by the following types:

Specification Integer Assert
Specification Integer Value

5.2.3.90. Specification Integer Value¶

This set of attributes specifies an integer value. Only the description attribute is mandatory. The explicit attributes for this type are:

assert: The attribute value shall be a Specification Integer Assert. This optional attribute defines the value constraints of the specified integer value. In case the assert attribute is not present, then the value of the specified integer value may be every valid integer number.
description: The attribute value shall be an optional string. It shall be the description of the specified integer value.

This type is used by the following types:

Specification Information

5.2.3.91. Specification List¶

This set of attributes specifies a list of attributes or values. All explicit attributes shall be specified. The explicit attributes for this type are:

description: The attribute value shall be an optional string. It shall be the description of the list.
spec-type: The attribute value shall be a Name. It shall be the specification type of elements of the list.

This type is used by the following types:

Specification Information

5.2.3.92. Specification Mandatory Attributes¶

It defines which explicit attributes are mandatory.

A value of this type shall be of one of the following variants:

The value may be a list. Each list element shall be a Name. The list defines the mandatory attributes through their key names.
The value may be a string. It defines how many explicit attributes are mandatory. If none is used, then none of the explicit attributes is mandatory, they are all optional. The value shall be an element of
- “all”,
- “at-least-one”,
- “at-most-one”,
- “exactly-one”, and
- “none”.

This type is used by the following types:

Specification Attribute Set

5.2.3.93. Specification Member Link Role¶

This type refines the Link though the role attribute if the value is spec-member. It defines the specification membership role of links.

5.2.3.95. Specification String Assert¶

A value of this type shall be an expression which asserts that the string of the specified attribute satisfies the required constraints.

A value of this type shall be of one of the following variants:

The value may be a set of attributes. Each attribute defines an operator. Exactly one of the explicit attributes shall be specified. The explicit attributes for this type are:

and
The attribute value shall be a list. Each list element shall be a Specification String Assert. The and operator evaluates to the logical and of the evaluation results of the expressions in the list.

contains
The attribute value shall be a list of strings. The contains operator evaluates to true, if the string to check converted to lower case with all white space characters converted to a single space character contains a string of the list of strings of this attribute, otherwise to false.

eq
The attribute value shall be a string. The eq operator evaluates to true, if the string to check is equal to the value of this attribute, otherwise to false.

ge
The attribute value shall be a string. The ge operator evaluates to true, if the string to check is greater than or equal to the value of this attribute, otherwise to false.

gt
The attribute value shall be a string. The gt operator evaluates to true, if the string to check is greater than the value of this attribute, otherwise to false.

in
The attribute value shall be a list of strings. The in operator evaluates to true, if the string to check is contained in the list of strings of this attribute, otherwise to false.

le
The attribute value shall be a string. The le operator evaluates to true, if the string to check is less than or equal to the value of this attribute, otherwise to false.

lt
The attribute value shall be a string. The lt operator evaluates to true, if the string to check is less than the value of this attribute, otherwise to false.

ne
The attribute value shall be a string. The ne operator evaluates to true, if the string to check is not equal to the value of this attribute, otherwise to false.

not
The attribute value shall be a Specification String Assert. The not operator evaluates to the logical not of the evaluation results of the expression.

or
The attribute value shall be a list. Each list element shall be a Specification String Assert. The or operator evaluates to the logical or of the evaluation results of the expressions in the list.

re
The attribute value shall be a string. The re operator evaluates to true, if the string to check matches with the regular expression of this attribute, otherwise to false.

uid
The attribute shall have no value. The uid operator evaluates to true, if the string is a valid UID, otherwise to false.
The value may be a list. Each list element shall be a Specification String Assert. This list of expressions evaluates to the logical or of the evaluation results of the expressions in the list.

This type is used by the following types:

Specification String Assert
Specification String Value

5.2.3.96. Specification String Value¶

This set of attributes specifies a string. Only the description attribute is mandatory. The explicit attributes for this type are:

assert: The attribute value shall be a Specification String Assert. This optional attribute defines the constraints of the specified string. In case the assert attribute is not present, then the specified string may be every valid string.
description: The attribute value shall be an optional string. It shall be the description of the specified string attribute.

This type is used by the following types:

Specification Information

5.2.3.97. Test Case Action¶

This set of attributes specifies a test case action. All explicit attributes shall be specified. The explicit attributes for this type are:

action: The attribute value shall be a string. It shall be the test case action code.
checks: The attribute value shall be a list. Each list element shall be a Test Case Check.
description: The attribute value shall be an optional string. It shall be the test case action description.
links: The attribute value shall be a list. Each list element shall be a Link.

This type is used by the following types:

Test Case Item Type

5.2.3.98. Test Case Check¶

This set of attributes specifies a test case check. All explicit attributes shall be specified. The explicit attributes for this type are:

check: The attribute value shall be a string. It shall be the test case check code.
description: The attribute value shall be an optional string. It shall be the test case check description.
links: The attribute value shall be a list. Each list element shall be a Link.

This type is used by the following types:

Test Case Action

5.2.3.99. Test Name¶

The value shall be a string. It shall be the name of a test suite or test case. It shall be formatted in the style of a caption. If shall form a valid C designator after removal of all white space characters. The value shall match with the regular expression “^[A-Z][a-zA-Z0-9 _]+$".

This type is used by the following types:

Action Requirement Item Type
Test Case Item Type
Test Suite Item Type

5.2.3.100. UID¶

The value shall be a string. The string shall be a valid absolute or relative item UID.

This type is used by the following types:

Link