diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-06-04 10:34:56 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-06-08 08:59:20 +0200 |
commit | 9499f8bc3ff935c507c2d7fc36d5debb6949b89d (patch) | |
tree | a3e564298790bbb272349def292fefd7d5696ba0 /spec/spec | |
parent | spec: Canonicalize descriptions (diff) | |
download | rtems-central-9499f8bc3ff935c507c2d7fc36d5debb6949b89d.tar.bz2 |
spec: Rename required in mandatory attributes
The term "required" is quite overloaded in the specification context.
Use "mandatory" instead.
Shorten the phrase "explicitly defined attributes" to "explicit
attributes".
Diffstat (limited to 'spec/spec')
99 files changed, 111 insertions, 112 deletions
diff --git a/spec/spec/appl-config-group-member.yml b/spec/spec/appl-config-group-member.yml index 954bd36f..3c40703f 100644 --- a/spec/spec/appl-config-group-member.yml +++ b/spec/spec/appl-config-group-member.yml @@ -16,7 +16,7 @@ spec-info: attributes: {} description: | It defines the application configuration group membership role of links. - required-attributes: all + mandatory-attributes: all spec-name: Application Configuration Group Member Link Role spec-type: appl-config-group-member type: spec diff --git a/spec/spec/appl-config-group.yml b/spec/spec/appl-config-group.yml index 03e62449..b7e72f45 100644 --- a/spec/spec/appl-config-group.yml +++ b/spec/spec/appl-config-group.yml @@ -30,7 +30,7 @@ spec-info: spec-type: requirement-text description: | This set of attributes specifies an application configuration group. - required-attributes: all + mandatory-attributes: all spec-name: Application Configuration Group Item Type spec-type: appl-config-group type: spec diff --git a/spec/spec/appl-config-option-constraints.yml b/spec/spec/appl-config-option-constraints.yml index 1e33835a..0fde7a94 100644 --- a/spec/spec/appl-config-option-constraints.yml +++ b/spec/spec/appl-config-option-constraints.yml @@ -35,7 +35,7 @@ spec-info: This set of attributes defines application configuration option constraints. Additional constraints can be added through the links of the item using the ${constraint-role:/spec-name}. - required-attributes: none + mandatory-attributes: none spec-name: Application Configuration Option Constraint Set spec-type: appl-config-option-constraints type: spec diff --git a/spec/spec/appl-config-option-feature-enable.yml b/spec/spec/appl-config-option-feature-enable.yml index 024bac46..d7b37088 100644 --- a/spec/spec/appl-config-option-feature-enable.yml +++ b/spec/spec/appl-config-option-feature-enable.yml @@ -17,7 +17,7 @@ spec-info: description: | This set of attributes specifies an application configuration feature enable option. - required-attributes: all + mandatory-attributes: all spec-name: Application Configuration Feature Enable Option Item Type spec-type: appl-config-option-feature-enable type: spec diff --git a/spec/spec/appl-config-option-feature.yml b/spec/spec/appl-config-option-feature.yml index b4ecdcfa..a54154ae 100644 --- a/spec/spec/appl-config-option-feature.yml +++ b/spec/spec/appl-config-option-feature.yml @@ -22,7 +22,7 @@ spec-info: description: | This set of attributes specifies an application configuration feature option. - required-attributes: all + mandatory-attributes: all spec-name: Application Configuration Feature Option Item Type spec-type: appl-config-option-feature type: spec diff --git a/spec/spec/appl-config-option-value.yml b/spec/spec/appl-config-option-value.yml index 7842d2bb..96abef0d 100644 --- a/spec/spec/appl-config-option-value.yml +++ b/spec/spec/appl-config-option-value.yml @@ -29,7 +29,7 @@ spec-info: description: | This set of attributes specifies application configuration initializer or integer option. - required-attributes: all + mandatory-attributes: all spec-name: Application Configuration Value Option Item Type spec-type: appl-config-option-value type: spec diff --git a/spec/spec/appl-config-option.yml b/spec/spec/appl-config-option.yml index 7759f408..f41bda80 100644 --- a/spec/spec/appl-config-option.yml +++ b/spec/spec/appl-config-option.yml @@ -42,7 +42,7 @@ spec-info: spec-type: requirement-text description: | This set of attributes specifies an application configuration option. - required-attributes: all + mandatory-attributes: all spec-name: Application Configuration Option Item Type spec-type: appl-config-option type: spec diff --git a/spec/spec/build-action-check-cc.yml b/spec/spec/build-action-check-cc.yml index 0b7796b1..b784c959 100644 --- a/spec/spec/build-action-check-cc.yml +++ b/spec/spec/build-action-check-cc.yml @@ -25,7 +25,7 @@ spec-info: spec-type: str description: | This set of attributes specifies a check done using the C compiler. - required-attributes: all + mandatory-attributes: all spec-name: Build Option C Compiler Check Action spec-type: build-action-check-cc type: spec diff --git a/spec/spec/build-action-check-cxx.yml b/spec/spec/build-action-check-cxx.yml index 64699127..620254e1 100644 --- a/spec/spec/build-action-check-cxx.yml +++ b/spec/spec/build-action-check-cxx.yml @@ -25,7 +25,7 @@ spec-info: spec-type: str description: | This set of attributes specifies a check done using the C++ compiler. - required-attributes: all + mandatory-attributes: all spec-name: Build Option C++ Compiler Check Action spec-type: build-action-check-cxx type: spec diff --git a/spec/spec/build-action-set-test-state.yml b/spec/spec/build-action-set-test-state.yml index 28aa0894..c630c8f8 100644 --- a/spec/spec/build-action-set-test-state.yml +++ b/spec/spec/build-action-set-test-state.yml @@ -20,7 +20,7 @@ spec-info: of items, there is no way to check if the name specified by the attribute key is valid. spec-type: build-test-state - required-attributes: all + mandatory-attributes: all spec-name: Build Option Set Test State Action spec-type: build-action-set-test-state type: spec diff --git a/spec/spec/build-action.yml b/spec/spec/build-action.yml index 462e03f6..1b3302e5 100644 --- a/spec/spec/build-action.yml +++ b/spec/spec/build-action.yml @@ -219,7 +219,7 @@ spec-info: spec-type: none description: | This set of attributes specifies a build option action. - required-attributes: exactly-one + mandatory-attributes: exactly-one spec-name: Build Option Action spec-type: build-action type: spec diff --git a/spec/spec/build-ada-test-program.yml b/spec/spec/build-ada-test-program.yml index 2425f858..21518735 100644 --- a/spec/spec/build-ada-test-program.yml +++ b/spec/spec/build-ada-test-program.yml @@ -89,7 +89,7 @@ spec-info: ``enabled-by`` attribute value which is controlled by the option action :ref:`set-test-state <SpecTypeBuildOptionItemType>`. If the test state is set to ``exclude``, then the test program is not built. - required-attributes: all + mandatory-attributes: all spec-name: Build Ada Test Program Item Type spec-type: build-ada-test-program type: spec diff --git a/spec/spec/build-bsp.yml b/spec/spec/build-bsp.yml index 3660da67..4258d08f 100644 --- a/spec/spec/build-bsp.yml +++ b/spec/spec/build-bsp.yml @@ -82,7 +82,7 @@ spec-info: spec-type: build-source-list description: | This set of attributes specifies a base BSP variant to build. - required-attributes: all + mandatory-attributes: all spec-name: Build BSP Item Type spec-type: build-bsp type: spec diff --git a/spec/spec/build-config-file.yml b/spec/spec/build-config-file.yml index ed050b68..ca196778 100644 --- a/spec/spec/build-config-file.yml +++ b/spec/spec/build-config-file.yml @@ -45,7 +45,7 @@ spec-info: 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. - required-attributes: all + mandatory-attributes: all spec-name: Build Configuration File Item Type spec-type: build-config-file type: spec diff --git a/spec/spec/build-config-header.yml b/spec/spec/build-config-header.yml index 98a332a2..647f847c 100644 --- a/spec/spec/build-config-header.yml +++ b/spec/spec/build-config-header.yml @@ -35,7 +35,7 @@ spec-info: 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. - required-attributes: all + mandatory-attributes: all spec-name: Build Configuration Header Item Type spec-type: build-config-header type: spec diff --git a/spec/spec/build-default-by-variant.yml b/spec/spec/build-default-by-variant.yml index 4d37dda4..5a6e7fa4 100644 --- a/spec/spec/build-default-by-variant.yml +++ b/spec/spec/build-default-by-variant.yml @@ -21,7 +21,7 @@ spec-info: spec-type: list-str description: | This set of attributes specifies build option default values by variant. - required-attributes: all + mandatory-attributes: all spec-name: Build Option Default by Variant spec-type: build-default-by-variant type: spec diff --git a/spec/spec/build-dependency.yml b/spec/spec/build-dependency.yml index aecde8b0..9f12bb71 100644 --- a/spec/spec/build-dependency.yml +++ b/spec/spec/build-dependency.yml @@ -16,7 +16,7 @@ spec-info: attributes: {} description: | It defines the build dependency role of links. - required-attributes: all + mandatory-attributes: all spec-name: Build Dependency Link Role spec-type: build-dependency type: spec diff --git a/spec/spec/build-group.yml b/spec/spec/build-group.yml index c0dd1c63..643637d1 100644 --- a/spec/spec/build-group.yml +++ b/spec/spec/build-group.yml @@ -57,7 +57,7 @@ spec-info: items. The ``includes``, ``ldflags``, ``objects``, and ``use`` variables of the build item context are updated by the corresponding attributes of the build group. - required-attributes: all + mandatory-attributes: all spec-name: Build Group Item Type spec-type: build-group type: spec diff --git a/spec/spec/build-install.yml b/spec/spec/build-install.yml index 84e5f66b..cb6ce9bf 100644 --- a/spec/spec/build-install.yml +++ b/spec/spec/build-install.yml @@ -22,7 +22,7 @@ spec-info: spec-type: list-str description: | This set of attributes specifies files installed by a build item. - required-attributes: all + mandatory-attributes: all spec-name: Build Install Directive spec-type: build-install type: spec diff --git a/spec/spec/build-library.yml b/spec/spec/build-library.yml index a48644ac..de5cfe1a 100644 --- a/spec/spec/build-library.yml +++ b/spec/spec/build-library.yml @@ -65,7 +65,7 @@ spec-info: This set of attributes specifies a static library. Library items may use additional objects provided by ${build-objects:/spec-name} items through the build dependency links of the item. - required-attributes: all + mandatory-attributes: all spec-name: Build Library Item Type spec-type: build-library type: spec diff --git a/spec/spec/build-objects.yml b/spec/spec/build-objects.yml index 2192cb07..0453619d 100644 --- a/spec/spec/build-objects.yml +++ b/spec/spec/build-objects.yml @@ -55,7 +55,7 @@ spec-info: description: | This set of attributes specifies a set of object files used to build static libraries or test programs. - required-attributes: all + mandatory-attributes: all spec-name: Build Objects Item Type spec-type: build-objects type: spec diff --git a/spec/spec/build-option.yml b/spec/spec/build-option.yml index b05275aa..86384b8f 100644 --- a/spec/spec/build-option.yml +++ b/spec/spec/build-option.yml @@ -72,7 +72,7 @@ spec-info: spec-type: build-option-name description: | This set of attributes specifies a build option. - required-attributes: + mandatory-attributes: - actions - default - default-by-variant diff --git a/spec/spec/build-script.yml b/spec/spec/build-script.yml index dcbe498c..9cce6f03 100644 --- a/spec/spec/build-script.yml +++ b/spec/spec/build-script.yml @@ -100,7 +100,7 @@ spec-info: description: | This set of attributes specifies a build script. The optional attributes may be required by commands executed through the scripts. - required-attributes: + mandatory-attributes: - do-build - do-configure - prepare-build diff --git a/spec/spec/build-start-file.yml b/spec/spec/build-start-file.yml index d82722bf..b79db900 100644 --- a/spec/spec/build-start-file.yml +++ b/spec/spec/build-start-file.yml @@ -49,7 +49,7 @@ spec-info: description: | This set of attributes specifies a start file to build. A start file is used to link an executable. - required-attributes: all + mandatory-attributes: all spec-name: Build Start File Item Type spec-type: build-start-file type: spec diff --git a/spec/spec/build-test-program.yml b/spec/spec/build-test-program.yml index f2fc4d0d..0f96964b 100644 --- a/spec/spec/build-test-program.yml +++ b/spec/spec/build-test-program.yml @@ -77,7 +77,7 @@ spec-info: ``enabled-by`` attribute value which is controlled by the option action :ref:`set-test-state <SpecTypeBuildOptionItemType>`. If the test state is set to ``exclude``, then the test program is not built. - required-attributes: all + mandatory-attributes: all spec-name: Build Test Program Item Type spec-type: build-test-program type: spec diff --git a/spec/spec/build.yml b/spec/spec/build.yml index d91deb8e..4dce73a0 100644 --- a/spec/spec/build.yml +++ b/spec/spec/build.yml @@ -20,7 +20,7 @@ spec-info: spec-type: name description: | This set of attributes specifies a build item. - required-attributes: all + mandatory-attributes: all spec-name: Build Item Type spec-type: build type: spec diff --git a/spec/spec/constraint-role.yml b/spec/spec/constraint-role.yml index c57cf17f..3ceb60fd 100644 --- a/spec/spec/constraint-role.yml +++ b/spec/spec/constraint-role.yml @@ -17,7 +17,7 @@ spec-info: description: | It defines the constraint role of links. The link target shall be a constraint. - required-attributes: all + mandatory-attributes: all spec-name: Constraint Link Role spec-type: constraint-role type: spec diff --git a/spec/spec/constraint.yml b/spec/spec/constraint.yml index aa00f51f..07670b74 100644 --- a/spec/spec/constraint.yml +++ b/spec/spec/constraint.yml @@ -29,7 +29,7 @@ spec-info: spec-type: requirement-text description: | This set of attributes specifies a constraint. - required-attributes: all + mandatory-attributes: all spec-name: Constraint Item Type spec-type: constraint type: spec diff --git a/spec/spec/enabled-by.yml b/spec/spec/enabled-by.yml index ec13804f..c88d74e4 100644 --- a/spec/spec/enabled-by.yml +++ b/spec/spec/enabled-by.yml @@ -38,7 +38,7 @@ spec-info: spec-type: enabled-by-list description: | Each attribute defines an operator. - required-attributes: exactly-one + mandatory-attributes: exactly-one list: description: | This list of expressions evaluates to the *logical or* of the evaluation diff --git a/spec/spec/glossary-group.yml b/spec/spec/glossary-group.yml index 305d6152..6f8ea05a 100644 --- a/spec/spec/glossary-group.yml +++ b/spec/spec/glossary-group.yml @@ -24,7 +24,7 @@ spec-info: spec-type: str description: | This set of attributes specifies a glossary group. - required-attributes: all + mandatory-attributes: all spec-name: Glossary Group Item Type spec-type: glossary-group type: spec diff --git a/spec/spec/glossary-member.yml b/spec/spec/glossary-member.yml index 7c91beb4..6220f7a9 100644 --- a/spec/spec/glossary-member.yml +++ b/spec/spec/glossary-member.yml @@ -16,7 +16,7 @@ spec-info: attributes: {} description: | It defines the glossary membership role of links. - required-attributes: all + mandatory-attributes: all spec-name: Glossary Membership Link Role spec-type: glossary-member type: spec diff --git a/spec/spec/glossary-term.yml b/spec/spec/glossary-term.yml index c6493fc8..9e6473b9 100644 --- a/spec/spec/glossary-term.yml +++ b/spec/spec/glossary-term.yml @@ -24,7 +24,7 @@ spec-info: spec-type: str description: | This set of attributes specifies a glossary term. - required-attributes: all + mandatory-attributes: all spec-name: Glossary Term Item Type spec-type: glossary-term type: spec diff --git a/spec/spec/glossary.yml b/spec/spec/glossary.yml index d3a9e134..831564b2 100644 --- a/spec/spec/glossary.yml +++ b/spec/spec/glossary.yml @@ -20,7 +20,7 @@ spec-info: spec-type: name description: | This set of attributes specifies a glossary item. - required-attributes: all + mandatory-attributes: all spec-name: Glossary Item Type spec-type: glossary type: spec diff --git a/spec/spec/interface-compound.yml b/spec/spec/interface-compound.yml index f277756a..a1fdc123 100644 --- a/spec/spec/interface-compound.yml +++ b/spec/spec/interface-compound.yml @@ -39,7 +39,7 @@ spec-info: spec-type: interface-notes description: | This set of attributes specifies a compound (struct or union). - required-attributes: all + mandatory-attributes: all spec-name: Interface Compound Item Type spec-type: interface-compound type: spec diff --git a/spec/spec/interface-container.yml b/spec/spec/interface-container.yml index 9f59b8ec..be98c68e 100644 --- a/spec/spec/interface-container.yml +++ b/spec/spec/interface-container.yml @@ -19,7 +19,7 @@ spec-info: exactly one link with the ${interface-placement:/spec-name} to an ${interface-domain:/spec-name} item. This link defines the interface domain of the container. - required-attributes: all + mandatory-attributes: all spec-name: Interface Container Item Type spec-type: interface-container type: spec diff --git a/spec/spec/interface-define.yml b/spec/spec/interface-define.yml index a8aefc12..ccd8718f 100644 --- a/spec/spec/interface-define.yml +++ b/spec/spec/interface-define.yml @@ -32,7 +32,7 @@ spec-info: spec-type: interface-notes description: | This set of attributes specifies a define. - required-attributes: all + mandatory-attributes: all spec-name: Interface Define Item Type spec-type: interface-define type: spec diff --git a/spec/spec/interface-definition-directive.yml b/spec/spec/interface-definition-directive.yml index 7112bc52..d5fe46cb 100644 --- a/spec/spec/interface-definition-directive.yml +++ b/spec/spec/interface-definition-directive.yml @@ -20,7 +20,7 @@ spec-info: spec-type: interface-definition-variant-list description: | This set of attributes specifies an interface definition directive. - required-attributes: all + mandatory-attributes: all spec-name: Interface Definition Directive spec-type: interface-definition-directive type: spec diff --git a/spec/spec/interface-definition-variant.yml b/spec/spec/interface-definition-variant.yml index 56baf89f..02276c5e 100644 --- a/spec/spec/interface-definition-variant.yml +++ b/spec/spec/interface-definition-variant.yml @@ -21,7 +21,7 @@ spec-info: spec-type: interface-enabled-by description: | This set of attributes specifies an interface definition variant. - required-attributes: all + mandatory-attributes: all spec-name: Interface Definition Variant spec-type: interface-definition-variant type: spec diff --git a/spec/spec/interface-domain.yml b/spec/spec/interface-domain.yml index 0ea33efa..143e0b8c 100644 --- a/spec/spec/interface-domain.yml +++ b/spec/spec/interface-domain.yml @@ -27,7 +27,7 @@ spec-info: ${interface-container:/spec-name} and ${interface-header-file:/spec-name} are placed into domains through links with the ${interface-placement:/spec-name}. - required-attributes: all + mandatory-attributes: all spec-name: Interface Domain Item Type spec-type: interface-domain type: spec diff --git a/spec/spec/interface-enabled-by.yml b/spec/spec/interface-enabled-by.yml index 8863269b..9c0798ec 100644 --- a/spec/spec/interface-enabled-by.yml +++ b/spec/spec/interface-enabled-by.yml @@ -32,7 +32,7 @@ spec-info: spec-type: interface-enabled-by-list description: | Each attribute defines an operator. - required-attributes: exactly-one + mandatory-attributes: exactly-one list: description: | It defines a *logical or* of the expressions in the list. diff --git a/spec/spec/interface-enum.yml b/spec/spec/interface-enum.yml index 38430703..0a7c3e57 100644 --- a/spec/spec/interface-enum.yml +++ b/spec/spec/interface-enum.yml @@ -32,7 +32,7 @@ spec-info: spec-type: interface-description description: | This set of attributes specifies an enum. - required-attributes: all + mandatory-attributes: all spec-name: Interface Enum Item Type spec-type: interface-enum type: spec diff --git a/spec/spec/interface-enumerator-role.yml b/spec/spec/interface-enumerator-role.yml index 7fab2799..1bfa32c9 100644 --- a/spec/spec/interface-enumerator-role.yml +++ b/spec/spec/interface-enumerator-role.yml @@ -16,7 +16,7 @@ spec-info: attributes: {} description: | It defines the interface enumerator role of links. - required-attributes: all + mandatory-attributes: all spec-name: Interface Enumerator Link Role spec-type: interface-enumerator-role type: spec diff --git a/spec/spec/interface-enumerator.yml b/spec/spec/interface-enumerator.yml index 1743ed55..3b7b60b7 100644 --- a/spec/spec/interface-enumerator.yml +++ b/spec/spec/interface-enumerator.yml @@ -32,7 +32,7 @@ spec-info: spec-type: interface-notes description: | This set of attributes specifies an enumerator. - required-attributes: all + mandatory-attributes: all spec-name: Interface Enumerator Item Type spec-type: interface-enumerator type: spec diff --git a/spec/spec/interface-forward-declaration.yml b/spec/spec/interface-forward-declaration.yml index de6e1562..ab180f04 100644 --- a/spec/spec/interface-forward-declaration.yml +++ b/spec/spec/interface-forward-declaration.yml @@ -19,7 +19,7 @@ spec-info: exactly one link with the ${interface-target:/spec-name} to an ${interface-compound:/spec-name} item. This link defines the type declared by the forward declaration. - required-attributes: all + mandatory-attributes: all spec-name: Interface Forward Declaration Item Type spec-type: interface-forward-declaration type: spec diff --git a/spec/spec/interface-function-definition-directive.yml b/spec/spec/interface-function-definition-directive.yml index d7258990..b7f1f87d 100644 --- a/spec/spec/interface-function-definition-directive.yml +++ b/spec/spec/interface-function-definition-directive.yml @@ -20,7 +20,7 @@ spec-info: spec-type: interface-function-definition-variant-list description: | This set of attributes specifies a function definition directive. - required-attributes: all + mandatory-attributes: all spec-name: Interface Function Definition Directive spec-type: interface-function-definition-directive type: spec diff --git a/spec/spec/interface-function-definition-variant.yml b/spec/spec/interface-function-definition-variant.yml index ab9fdaca..167ed8ff 100644 --- a/spec/spec/interface-function-definition-variant.yml +++ b/spec/spec/interface-function-definition-variant.yml @@ -21,7 +21,7 @@ spec-info: spec-type: interface-enabled-by description: | This set of attributes specifies a function definition variant. - required-attributes: all + mandatory-attributes: all spec-name: Interface Function Definition Variant spec-type: interface-function-definition-variant type: spec diff --git a/spec/spec/interface-function-definition.yml b/spec/spec/interface-function-definition.yml index 1d05127d..c4297969 100644 --- a/spec/spec/interface-function-definition.yml +++ b/spec/spec/interface-function-definition.yml @@ -30,7 +30,7 @@ spec-info: spec-type: str description: | This set of attributes specifies a function definition. - required-attributes: all + mandatory-attributes: all spec-name: Interface Function Definition spec-type: interface-function-definition type: spec diff --git a/spec/spec/interface-function.yml b/spec/spec/interface-function.yml index 21e7e846..f1916752 100644 --- a/spec/spec/interface-function.yml +++ b/spec/spec/interface-function.yml @@ -38,7 +38,7 @@ spec-info: spec-type: interface-return-directive description: | This set of attributes specifies a function. - required-attributes: all + mandatory-attributes: all spec-name: Interface Function Item Type spec-type: interface-function type: spec diff --git a/spec/spec/interface-group.yml b/spec/spec/interface-group.yml index ee6c3c2c..8710d42a 100644 --- a/spec/spec/interface-group.yml +++ b/spec/spec/interface-group.yml @@ -29,7 +29,7 @@ spec-info: spec-type: str description: | This set of attributes specifies an interface group. - required-attributes: all + mandatory-attributes: all spec-name: Interface Group Item Type spec-type: interface-group type: spec diff --git a/spec/spec/interface-header-file.yml b/spec/spec/interface-header-file.yml index f7965150..d6b10e89 100644 --- a/spec/spec/interface-header-file.yml +++ b/spec/spec/interface-header-file.yml @@ -29,7 +29,7 @@ spec-info: exactly one link with the ${interface-placement:/spec-name} to an ${interface-domain:/spec-name} item. This link defines the interface domain of the header file. - required-attributes: all + mandatory-attributes: all spec-name: Interface Header File Item Type spec-type: interface-header-file type: spec diff --git a/spec/spec/interface-include.yml b/spec/spec/interface-include.yml index 30524426..13fc0040 100644 --- a/spec/spec/interface-include.yml +++ b/spec/spec/interface-include.yml @@ -23,7 +23,7 @@ spec-info: 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. - required-attributes: all + mandatory-attributes: all spec-name: Interface Include Link Role spec-type: interface-include type: spec diff --git a/spec/spec/interface-ingroup.yml b/spec/spec/interface-ingroup.yml index 98b5e09c..f55e8ab4 100644 --- a/spec/spec/interface-ingroup.yml +++ b/spec/spec/interface-ingroup.yml @@ -16,7 +16,7 @@ spec-info: attributes: {} description: | It defines the interface group membership role of links. - required-attributes: all + mandatory-attributes: all spec-name: Interface Group Membership Link Role spec-type: interface-ingroup type: spec diff --git a/spec/spec/interface-macro.yml b/spec/spec/interface-macro.yml index d67624a2..69bf9998 100644 --- a/spec/spec/interface-macro.yml +++ b/spec/spec/interface-macro.yml @@ -38,7 +38,7 @@ spec-info: spec-type: interface-return-directive description: | This set of attributes specifies a macro. - required-attributes: all + mandatory-attributes: all spec-name: Interface Macro Item Type spec-type: interface-macro type: spec diff --git a/spec/spec/interface-member-compound.yml b/spec/spec/interface-member-compound.yml index 1322f22d..aff80d65 100644 --- a/spec/spec/interface-member-compound.yml +++ b/spec/spec/interface-member-compound.yml @@ -23,7 +23,7 @@ spec-info: spec-type: interface-member-definition-directive-list description: | This set of attributes specifies an interface compound member compound. - required-attributes: all + mandatory-attributes: all spec-name: Interface Compound Member Compound spec-type: interface-member-compound type: spec diff --git a/spec/spec/interface-member-declaration.yml b/spec/spec/interface-member-declaration.yml index 763e5f08..c119b765 100644 --- a/spec/spec/interface-member-declaration.yml +++ b/spec/spec/interface-member-declaration.yml @@ -23,7 +23,7 @@ spec-info: description: | This set of attributes specifies an interface compound member declaration. - required-attributes: all + mandatory-attributes: all spec-name: Interface Compound Member Declaration spec-type: interface-member-declaration type: spec diff --git a/spec/spec/interface-member-definition-directive.yml b/spec/spec/interface-member-definition-directive.yml index 8193d0ee..1e17e577 100644 --- a/spec/spec/interface-member-definition-directive.yml +++ b/spec/spec/interface-member-definition-directive.yml @@ -21,7 +21,7 @@ spec-info: description: | This set of attributes specifies an interface compound member definition directive. - required-attributes: all + mandatory-attributes: all spec-name: Interface Compound Member Definition Directive spec-type: interface-member-definition-directive type: spec diff --git a/spec/spec/interface-member-definition-variant.yml b/spec/spec/interface-member-definition-variant.yml index 4f215656..3cd15a58 100644 --- a/spec/spec/interface-member-definition-variant.yml +++ b/spec/spec/interface-member-definition-variant.yml @@ -22,7 +22,7 @@ spec-info: description: | This set of attributes specifies an interface compound member definition variant. - required-attributes: all + mandatory-attributes: all spec-name: Interface Compound Member Definition Variant spec-type: interface-member-definition-variant type: spec diff --git a/spec/spec/interface-member-definition.yml b/spec/spec/interface-member-definition.yml index 5833cec0..2f8be1fe 100644 --- a/spec/spec/interface-member-definition.yml +++ b/spec/spec/interface-member-definition.yml @@ -26,7 +26,7 @@ spec-info: spec-type: str description: | This set of attributes specifies an interface compound member definition. - required-attributes: all + mandatory-attributes: all spec-name: Interface Compound Member Definition spec-type: interface-member-definition type: spec diff --git a/spec/spec/interface-param.yml b/spec/spec/interface-param.yml index f0fada59..cb822665 100644 --- a/spec/spec/interface-param.yml +++ b/spec/spec/interface-param.yml @@ -22,7 +22,7 @@ spec-info: spec-type: str description: | This set of attributes specifies an interface parameter. - required-attributes: all + mandatory-attributes: all spec-name: Interface Parameter spec-type: interface-param type: spec diff --git a/spec/spec/interface-placement.yml b/spec/spec/interface-placement.yml index f1c72fb5..b8c6f6f7 100644 --- a/spec/spec/interface-placement.yml +++ b/spec/spec/interface-placement.yml @@ -18,7 +18,7 @@ spec-info: 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. - required-attributes: all + mandatory-attributes: all spec-name: Interface Placement Link Role spec-type: interface-placement type: spec diff --git a/spec/spec/interface-return-directive.yml b/spec/spec/interface-return-directive.yml index 66182f6a..5fe3f6f7 100644 --- a/spec/spec/interface-return-directive.yml +++ b/spec/spec/interface-return-directive.yml @@ -19,7 +19,7 @@ spec-info: spec-type: interface-return-value-list description: | This set of attributes specifies an interface return. - required-attributes: all + mandatory-attributes: all spec-name: Interface Return Directive spec-type: interface-return-directive type: spec diff --git a/spec/spec/interface-return-value.yml b/spec/spec/interface-return-value.yml index 800917b3..c479c987 100644 --- a/spec/spec/interface-return-value.yml +++ b/spec/spec/interface-return-value.yml @@ -19,7 +19,7 @@ spec-info: spec-type: bool-or-int-or-str description: | This set of attributes specifies an interface return value. - required-attributes: all + mandatory-attributes: all spec-name: Interface Return Value spec-type: interface-return-value type: spec diff --git a/spec/spec/interface-target.yml b/spec/spec/interface-target.yml index 4fc4db68..94cae816 100644 --- a/spec/spec/interface-target.yml +++ b/spec/spec/interface-target.yml @@ -17,7 +17,7 @@ spec-info: description: | It defines the interface target role of links. It is used for interface forward declarations. - required-attributes: all + mandatory-attributes: all spec-name: Interface Target Link Role spec-type: interface-target type: spec diff --git a/spec/spec/interface-typedef.yml b/spec/spec/interface-typedef.yml index 28218330..c066a22b 100644 --- a/spec/spec/interface-typedef.yml +++ b/spec/spec/interface-typedef.yml @@ -32,7 +32,7 @@ spec-info: spec-type: interface-notes description: | This set of attributes specifies a typedef. - required-attributes: all + mandatory-attributes: all spec-name: Interface Typedef Item Type spec-type: interface-typedef type: spec diff --git a/spec/spec/interface-unspecified.yml b/spec/spec/interface-unspecified.yml index 7d82ab54..41d5482d 100644 --- a/spec/spec/interface-unspecified.yml +++ b/spec/spec/interface-unspecified.yml @@ -20,7 +20,7 @@ spec-info: spec-type: str description: | This set of attributes specifies an unspecified interface. - required-attributes: all + mandatory-attributes: all spec-name: Interface Unspecified Item Type spec-type: interface-unspecified type: spec diff --git a/spec/spec/interface-variable.yml b/spec/spec/interface-variable.yml index b727327f..c57da662 100644 --- a/spec/spec/interface-variable.yml +++ b/spec/spec/interface-variable.yml @@ -32,7 +32,7 @@ spec-info: spec-type: interface-notes description: | This set of attributes specifies a variable. - required-attributes: all + mandatory-attributes: all spec-name: Interface Variable Item Type spec-type: interface-variable type: spec diff --git a/spec/spec/interface.yml b/spec/spec/interface.yml index d975a949..e8bfed2c 100644 --- a/spec/spec/interface.yml +++ b/spec/spec/interface.yml @@ -25,7 +25,7 @@ spec-info: ${interface-domain:/spec-name} items to specify interface domains, for example the ${/glossary/api:/term}, C language, compiler, interfaces to the implementation, and the hardware. - required-attributes: all + mandatory-attributes: all spec-name: Interface Item Type spec-type: interface type: spec diff --git a/spec/spec/link.yml b/spec/spec/link.yml index d8378064..3c7fb5de 100644 --- a/spec/spec/link.yml +++ b/spec/spec/link.yml @@ -22,7 +22,7 @@ spec-info: 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. - required-attributes: all + mandatory-attributes: all spec-name: Link spec-type: link type: spec diff --git a/spec/spec/requirement-functional.yml b/spec/spec/requirement-functional.yml index 46ed7cd0..503909dc 100644 --- a/spec/spec/requirement-functional.yml +++ b/spec/spec/requirement-functional.yml @@ -20,7 +20,7 @@ spec-info: spec-type: requirement-functional-type description: | This set of attributes specifies a functional requirement. - required-attributes: all + mandatory-attributes: all spec-name: Functional Requirement Item Type spec-type: requirement-functional type: spec diff --git a/spec/spec/requirement-non-functional.yml b/spec/spec/requirement-non-functional.yml index 410446bf..11bd5495 100644 --- a/spec/spec/requirement-non-functional.yml +++ b/spec/spec/requirement-non-functional.yml @@ -20,7 +20,7 @@ spec-info: spec-type: requirement-non-functional-type description: | This set of attributes specifies a non-functional requirement. - required-attributes: all + mandatory-attributes: all spec-name: Non-Functional Requirement Item Type spec-type: requirement-non-functional type: spec diff --git a/spec/spec/requirement-reference.yml b/spec/spec/requirement-reference.yml index 12a06a3d..599963a1 100644 --- a/spec/spec/requirement-reference.yml +++ b/spec/spec/requirement-reference.yml @@ -20,7 +20,7 @@ spec-info: spec-type: requirement-reference-type description: | This set of attributes specifies a requirement reference. - required-attributes: all + mandatory-attributes: all spec-name: Requirement Reference spec-type: requirement-reference type: spec diff --git a/spec/spec/requirement-refinement.yml b/spec/spec/requirement-refinement.yml index 7918bc8a..f5dc5d45 100644 --- a/spec/spec/requirement-refinement.yml +++ b/spec/spec/requirement-refinement.yml @@ -16,7 +16,7 @@ spec-info: attributes: {} description: | It defines the requirement refinement role of links. - required-attributes: all + mandatory-attributes: all spec-name: Requirement Refinement Link Role spec-type: requirement-refinement type: spec diff --git a/spec/spec/requirement-validation-role.yml b/spec/spec/requirement-validation-role.yml index ed948838..a2460ba4 100644 --- a/spec/spec/requirement-validation-role.yml +++ b/spec/spec/requirement-validation-role.yml @@ -16,7 +16,7 @@ spec-info: attributes: {} description: | It defines the requirement validation role of links. - required-attributes: all + mandatory-attributes: all spec-name: Requirement Validation Link Role spec-type: requirement-validation-role type: spec diff --git a/spec/spec/requirement-validation.yml b/spec/spec/requirement-validation.yml index 4b1bbf42..dadba7ad 100644 --- a/spec/spec/requirement-validation.yml +++ b/spec/spec/requirement-validation.yml @@ -37,7 +37,7 @@ spec-info: This set of attributes provides a requirement validation evidence. The item shall have exactly one link to the validated requirement with the ${requirement-validation-role:/spec-name}. - required-attributes: all + mandatory-attributes: all spec-name: Requirement Validation Item Type spec-type: requirement-validation type: spec diff --git a/spec/spec/requirement.yml b/spec/spec/requirement.yml index e241c001..3018b8c7 100644 --- a/spec/spec/requirement.yml +++ b/spec/spec/requirement.yml @@ -44,7 +44,7 @@ spec-info: spec-type: requirement-text description: | This set of attributes specifies a requirement. - required-attributes: all + mandatory-attributes: all spec-name: Requirement Item Type spec-type: requirement type: spec diff --git a/spec/spec/root.yml b/spec/spec/root.yml index b819dddf..58d65280 100644 --- a/spec/spec/root.yml +++ b/spec/spec/root.yml @@ -45,7 +45,7 @@ spec-info: use in tools. This is the root specification item type. - required-attributes: all + mandatory-attributes: all spec-name: Root Item Type spec-type: root type: spec diff --git a/spec/spec/spec-assert-float.yml b/spec/spec/spec-assert-float.yml index bad0bae5..fd6f2564 100644 --- a/spec/spec/spec-assert-float.yml +++ b/spec/spec/spec-assert-float.yml @@ -60,7 +60,7 @@ spec-info: spec-type: spec-assert-float-list description: | Each attribute defines an operator. - required-attributes: exactly-one + mandatory-attributes: exactly-one list: description: | This list of expressions evaluates to the *logical or* of the evaluation diff --git a/spec/spec/spec-assert-int.yml b/spec/spec/spec-assert-int.yml index de96df11..ec903b80 100644 --- a/spec/spec/spec-assert-int.yml +++ b/spec/spec/spec-assert-int.yml @@ -59,7 +59,7 @@ spec-info: spec-type: spec-assert-int-list description: | Each attribute defines an operator. - required-attributes: exactly-one + mandatory-attributes: exactly-one list: description: | This list of expressions evaluates to the *logical or* of the evaluation diff --git a/spec/spec/spec-assert-str.yml b/spec/spec/spec-assert-str.yml index 0ebd4779..915da6ed 100644 --- a/spec/spec/spec-assert-str.yml +++ b/spec/spec/spec-assert-str.yml @@ -83,7 +83,7 @@ spec-info: spec-type: none description: | Each attribute defines an operator. - required-attributes: exactly-one + mandatory-attributes: exactly-one list: description: | This list of expressions evaluates to the *logical or* of the evaluation diff --git a/spec/spec/spec-attribute-value.yml b/spec/spec/spec-attribute-value.yml index 3143ac08..d44e2256 100644 --- a/spec/spec/spec-attribute-value.yml +++ b/spec/spec/spec-attribute-value.yml @@ -20,7 +20,7 @@ spec-info: spec-type: name description: | This set of attributes specifies an attribute value. - required-attributes: all + mandatory-attributes: all spec-name: Specification Attribute Value spec-type: spec-attribute-value type: spec diff --git a/spec/spec/spec-attributes.yml b/spec/spec/spec-attributes.yml index e32b4139..4d4f1686 100644 --- a/spec/spec/spec-attributes.yml +++ b/spec/spec/spec-attributes.yml @@ -15,7 +15,7 @@ spec-info: description: | The generic attributes specify an attribute set. spec-type: spec-attribute-value - required-attributes: none + mandatory-attributes: none spec-name: Specification Attribute spec-type: spec-attributes type: spec diff --git a/spec/spec/spec-bool.yml b/spec/spec/spec-bool.yml index 2f45d243..e23f3b1f 100644 --- a/spec/spec/spec-bool.yml +++ b/spec/spec/spec-bool.yml @@ -26,7 +26,7 @@ spec-info: spec-type: optional-str description: | This attribute set specifies a boolean value. - required-attributes: + mandatory-attributes: - description spec-name: Specification Boolean Value spec-type: spec-bool diff --git a/spec/spec/spec-dict.yml b/spec/spec/spec-dict.yml index a3066f7a..d917c52e 100644 --- a/spec/spec/spec-dict.yml +++ b/spec/spec/spec-dict.yml @@ -12,8 +12,7 @@ spec-info: attributes: attributes: description: | - It shall be the specification of the set of explicitly defined - attributes. + It shall be the specification of the set of explicit attributes. spec-type: spec-attributes description: description: | @@ -24,16 +23,16 @@ spec-info: It shall be the specification of the generic attributes of the attribute set. spec-type: spec-generic-attributes - required-attributes: + mandatory-attributes: description: | - It shall be the set of required attributes of the attribute set. - spec-type: spec-required-attributes + It shall be the set of mandatory attributes of the attribute set. + spec-type: spec-mandatory-attributes description: | This set of attributes specifies a set of attributes. - required-attributes: + mandatory-attributes: - attributes - description - - required-attributes + - mandatory-attributes spec-name: Specification Attribute Set spec-type: spec-dict type: spec diff --git a/spec/spec/spec-float.yml b/spec/spec/spec-float.yml index 1fe07b2e..1f831eb8 100644 --- a/spec/spec/spec-float.yml +++ b/spec/spec/spec-float.yml @@ -23,7 +23,7 @@ spec-info: spec-type: optional-str description: | This set of attributes specifies a floating-point value. - required-attributes: + mandatory-attributes: - description spec-name: Specification Floating-Point Value spec-type: spec-float diff --git a/spec/spec/spec-generic-attributes.yml b/spec/spec/spec-generic-attributes.yml index 50765a48..50e89bc8 100644 --- a/spec/spec/spec-generic-attributes.yml +++ b/spec/spec/spec-generic-attributes.yml @@ -22,7 +22,7 @@ spec-info: This set of attributes specifies generic attributes. Generic attributes are attributes which are not explicitly defined. They are restricted to a uniform attribute value type. - required-attributes: all + mandatory-attributes: all spec-name: Specification Generic Attributes spec-type: spec-generic-attributes type: spec diff --git a/spec/spec/spec-info.yml b/spec/spec/spec-info.yml index e6ef4fa8..5bdbeee0 100644 --- a/spec/spec/spec-info.yml +++ b/spec/spec/spec-info.yml @@ -40,7 +40,7 @@ spec-info: spec-type: spec-str description: | This set of attributes specifies attribute values. - required-attributes: at-least-one + mandatory-attributes: at-least-one spec-name: Specification Information spec-type: spec-info type: spec diff --git a/spec/spec/spec-int.yml b/spec/spec/spec-int.yml index de158a89..080a3a9d 100644 --- a/spec/spec/spec-int.yml +++ b/spec/spec/spec-int.yml @@ -23,7 +23,7 @@ spec-info: spec-type: optional-str description: | This set of attributes specifies an integer value. - required-attributes: + mandatory-attributes: - description spec-name: Specification Integer Value spec-type: spec-int diff --git a/spec/spec/spec-list.yml b/spec/spec/spec-list.yml index 28ea4b89..b8f87807 100644 --- a/spec/spec/spec-list.yml +++ b/spec/spec/spec-list.yml @@ -20,7 +20,7 @@ spec-info: spec-type: name description: | This set of attributes specifies a list of attributes or values. - required-attributes: all + mandatory-attributes: all spec-name: Specification List spec-type: spec-list type: spec diff --git a/spec/spec/spec-required-attributes.yml b/spec/spec/spec-mandatory-attributes.yml index f2a6692b..700de958 100644 --- a/spec/spec/spec-required-attributes.yml +++ b/spec/spec/spec-mandatory-attributes.yml @@ -6,13 +6,12 @@ links: - role: spec-member uid: root spec-description: | - This attribute value defines which of the explicitly defined attributes are - required. + It defines which explicit attributes are mandatory. spec-example: null spec-info: list: description: | - This list defines the required attributes through their keys. + The list defines the mandatory attributes through their key names. spec-type: name str: assert: @@ -23,8 +22,9 @@ spec-info: - exactly-one - none description: | - This string defines the how many explicitly defined attributes are - required. -spec-name: Specification Required Attributes -spec-type: spec-required-attributes + It defines how many explicit attributes are mandatory. If `none` is + used, then none of the explicit attributes is mandatory, they are all + optional. +spec-name: Specification Mandatory Attributes +spec-type: spec-mandatory-attributes type: spec diff --git a/spec/spec/spec-member.yml b/spec/spec/spec-member.yml index 60f68a11..790500ef 100644 --- a/spec/spec/spec-member.yml +++ b/spec/spec/spec-member.yml @@ -16,7 +16,7 @@ spec-info: attributes: {} description: | It defines the specification membership role of links. - required-attributes: all + mandatory-attributes: all spec-name: Specification Member Link Role spec-type: spec-member type: spec diff --git a/spec/spec/spec-refinement.yml b/spec/spec/spec-refinement.yml index ec22d50d..8fd16da1 100644 --- a/spec/spec/spec-refinement.yml +++ b/spec/spec/spec-refinement.yml @@ -26,7 +26,7 @@ spec-info: spec-type: name description: | It defines the specification refinement role of links. - required-attributes: all + mandatory-attributes: all spec-name: Specification Refinement Link Role spec-type: spec-refinement type: spec diff --git a/spec/spec/spec-str.yml b/spec/spec/spec-str.yml index c0ed378e..f83dae5e 100644 --- a/spec/spec/spec-str.yml +++ b/spec/spec/spec-str.yml @@ -22,7 +22,7 @@ spec-info: spec-type: optional-str description: | This set of attributes specifies a string. - required-attributes: + mandatory-attributes: - description spec-name: Specification String Value spec-type: spec-str diff --git a/spec/spec/spec.yml b/spec/spec/spec.yml index 8a752f4a..e67e920e 100644 --- a/spec/spec/spec.yml +++ b/spec/spec/spec.yml @@ -37,7 +37,7 @@ spec-example: | spec-type: int description: | This set of attributes specifies an example. - required-attributes: all + mandatory-attributes: all spec-name: Example Item Type spec-type: spec type: spec @@ -66,7 +66,7 @@ spec-info: spec-type: name description: | This set of attributes specifies specification types. - required-attributes: all + mandatory-attributes: all spec-name: Specification Item Type spec-type: spec type: spec diff --git a/spec/spec/test-case-action.yml b/spec/spec/test-case-action.yml index 2dcedb61..46c3866d 100644 --- a/spec/spec/test-case-action.yml +++ b/spec/spec/test-case-action.yml @@ -26,7 +26,7 @@ spec-info: spec-type: links description: | This set of attributes specifies a test case action. - required-attributes: all + mandatory-attributes: all spec-name: Test Case Action spec-type: test-case-action type: spec diff --git a/spec/spec/test-case-check.yml b/spec/spec/test-case-check.yml index 47b4d912..ebe8c47b 100644 --- a/spec/spec/test-case-check.yml +++ b/spec/spec/test-case-check.yml @@ -23,7 +23,7 @@ spec-info: spec-type: links description: | This set of attributes specifies a test case check. - required-attributes: all + mandatory-attributes: all spec-name: Test Case Check spec-type: test-case-check type: spec diff --git a/spec/spec/test-case.yml b/spec/spec/test-case.yml index 297d7108..00773055 100644 --- a/spec/spec/test-case.yml +++ b/spec/spec/test-case.yml @@ -66,7 +66,7 @@ spec-info: spec-type: str description: | This set of attributes specifies a test case. - required-attributes: all + mandatory-attributes: all spec-name: Test Case Item Type spec-type: test-case type: spec diff --git a/spec/spec/test-platform.yml b/spec/spec/test-platform.yml index dbcc48b5..c2ede20b 100644 --- a/spec/spec/test-platform.yml +++ b/spec/spec/test-platform.yml @@ -30,7 +30,7 @@ spec-info: This item type is work in progress. This set of attributes specifies a test platform. - required-attributes: all + mandatory-attributes: all spec-name: Test Platform Item Type spec-type: test-platform type: spec diff --git a/spec/spec/test-procedure.yml b/spec/spec/test-procedure.yml index f5e381c5..c3675188 100644 --- a/spec/spec/test-procedure.yml +++ b/spec/spec/test-procedure.yml @@ -34,7 +34,7 @@ spec-info: This item type is work in progress. This set of attributes specifies a test procedure. - required-attributes: all + mandatory-attributes: all spec-name: Test Procedure Item Type spec-type: test-procedure type: spec diff --git a/spec/spec/test-suite.yml b/spec/spec/test-suite.yml index 517f5428..aed3a55b 100644 --- a/spec/spec/test-suite.yml +++ b/spec/spec/test-suite.yml @@ -44,7 +44,7 @@ spec-info: spec-type: str description: | This set of attributes specifies a test suite. - required-attributes: all + mandatory-attributes: all spec-name: Test Suite Item Type spec-type: test-suite type: spec |