summaryrefslogtreecommitdiffstats
path: root/spec/spec
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-25 13:22:56 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-28 10:38:23 +0200
commitadb26ed3bfe8306123fa5dab15dce4d6e6fc19c4 (patch)
tree11ba3c13e7dcb2bfe6b7454fa1b62c8bb9da7f4d /spec/spec
parentRename interface group attributes (diff)
downloadrtems-central-adb26ed3bfe8306123fa5dab15dce4d6e6fc19c4.tar.bz2
spec: Sort attributes
Diffstat (limited to 'spec/spec')
-rw-r--r--spec/spec/build-action-check-cc.yml6
-rw-r--r--spec/spec/build-action-check-cxx.yml6
-rw-r--r--spec/spec/build-action-set-test-state.yml4
-rw-r--r--spec/spec/build-action.yml90
-rw-r--r--spec/spec/build-config-header.yml8
-rw-r--r--spec/spec/build-default-by-variant.yml8
-rw-r--r--spec/spec/build-option.yml8
-rw-r--r--spec/spec/build-script.yml56
-rw-r--r--spec/spec/requirement.yml8
9 files changed, 97 insertions, 97 deletions
diff --git a/spec/spec/build-action-check-cc.yml b/spec/spec/build-action-check-cc.yml
index 3845c280..0b7796b1 100644
--- a/spec/spec/build-action-check-cc.yml
+++ b/spec/spec/build-action-check-cc.yml
@@ -10,6 +10,9 @@ spec-example: null
spec-info:
dict:
attributes:
+ cflags:
+ description: null
+ spec-type: build-cflags
fragment:
description: |
It shall be a code fragment used to check the availability of a
@@ -20,9 +23,6 @@ spec-info:
description: |
It shall be a description of the feature to check.
spec-type: str
- cflags:
- description: null
- spec-type: build-cflags
description: |
This set of attributes specifies a check done using the C compiler.
required-attributes: all
diff --git a/spec/spec/build-action-check-cxx.yml b/spec/spec/build-action-check-cxx.yml
index f10fb84b..64699127 100644
--- a/spec/spec/build-action-check-cxx.yml
+++ b/spec/spec/build-action-check-cxx.yml
@@ -10,6 +10,9 @@ spec-example: null
spec-info:
dict:
attributes:
+ cxxflags:
+ description: null
+ spec-type: build-cxxflags
fragment:
description: |
It shall be a code fragment used to check the availability of a
@@ -20,9 +23,6 @@ spec-info:
description: |
It shall be a description of the feature to check.
spec-type: str
- cxxflags:
- description: null
- spec-type: build-cxxflags
description: |
This set of attributes specifies a check done using the C++ compiler.
required-attributes: all
diff --git a/spec/spec/build-action-set-test-state.yml b/spec/spec/build-action-set-test-state.yml
index baa29c6d..e07bd231 100644
--- a/spec/spec/build-action-set-test-state.yml
+++ b/spec/spec/build-action-set-test-state.yml
@@ -10,6 +10,8 @@ spec-example: null
spec-info:
dict:
attributes: {}
+ description: |
+ This set of attributes specifies test states for a set of test programs.
generic-attributes:
description: |
The keys shall be test program names. The names shall correspond to
@@ -17,8 +19,6 @@ spec-info:
processing order of items, there is no way to check if the name
specified by the attribute key is valid.
spec-type: build-test-state
- description: |
- This set of attributes specifies test states for a set of test programs.
required-attributes: all
spec-name: Build Option Set Test State Action
spec-type: build-action-set-test-state
diff --git a/spec/spec/build-action.yml b/spec/spec/build-action.yml
index 914cf4e1..535fde3a 100644
--- a/spec/spec/build-action.yml
+++ b/spec/spec/build-action.yml
@@ -28,21 +28,6 @@ spec-info:
The action asserts that the action value is equal to the attribute
value.
spec-type: bool-or-int-or-str
- assert-ne:
- description: |
- The action asserts that the action value is not equal to the
- attribute value.
- spec-type: bool-or-int-or-str
- assert-le:
- description: |
- The action asserts that the action value is less than or equal to the
- attribute value.
- spec-type: int-or-str
- assert-lt:
- description: |
- The action asserts that the action value is less than the attribute
- value.
- spec-type: int-or-str
assert-ge:
description: |
The action asserts that the action value is greater than or equal to
@@ -53,39 +38,53 @@ spec-info:
The action asserts that the action value is greater than the
attribute value.
spec-type: int-or-str
- assert-int8:
+ assert-int16:
description: |
- The action asserts that the action value is a valid signed 8-bit
+ The action asserts that the action value is a valid signed 16-bit
integer.
spec-type: none
- assert-uint8:
+ assert-int32:
description: |
- The action asserts that the action value is a valid unsigned 8-bit
+ The action asserts that the action value is a valid signed 32-bit
integer.
spec-type: none
- assert-int16:
+ assert-int64:
description: |
- The action asserts that the action value is a valid signed 16-bit
+ The action asserts that the action value is a valid signed 64-bit
integer.
spec-type: none
- assert-uint16:
+ assert-int8:
description: |
- The action asserts that the action value is a valid unsigned 16-bit
+ The action asserts that the action value is a valid signed 8-bit
integer.
spec-type: none
- assert-int32:
+ assert-le:
description: |
- The action asserts that the action value is a valid signed 32-bit
- integer.
+ The action asserts that the action value is less than or equal to the
+ attribute value.
+ spec-type: int-or-str
+ assert-lt:
+ description: |
+ The action asserts that the action value is less than the attribute
+ value.
+ spec-type: int-or-str
+ assert-ne:
+ description: |
+ The action asserts that the action value is not equal to the
+ attribute value.
+ spec-type: bool-or-int-or-str
+ assert-power-of-two:
+ description: |
+ The action asserts that the action value is a power of two.
spec-type: none
- assert-uint32:
+ assert-uint16:
description: |
- The action asserts that the action value is a valid unsigned 32-bit
+ The action asserts that the action value is a valid unsigned 16-bit
integer.
spec-type: none
- assert-int64:
+ assert-uint32:
description: |
- The action asserts that the action value is a valid signed 64-bit
+ The action asserts that the action value is a valid unsigned 32-bit
integer.
spec-type: none
assert-uint64:
@@ -93,9 +92,10 @@ spec-info:
The action asserts that the action value is a valid unsigned 64-bit
integer.
spec-type: none
- assert-power-of-two:
+ assert-uint8:
description: |
- The action asserts that the action value is a power of two.
+ The action asserts that the action value is a valid unsigned 8-bit
+ integer.
spec-type: none
check-cc:
description: null
@@ -103,13 +103,6 @@ spec-info:
check-cxx:
description: null
spec-type: build-action-check-cxx
- define-condition:
- description: |
- 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.
- spec-type: optional-str
define:
description: |
The action adds a define to the configuration set. If the attribute
@@ -118,6 +111,13 @@ spec-info:
is the action value. If the action value is a string, then it is
quoted.
spec-type: optional-str
+ define-condition:
+ description: |
+ 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.
+ spec-type: optional-str
define-unquoted:
description: |
The action adds a define to the configuration set. If the attribute
@@ -175,6 +175,12 @@ spec-info:
If no such variable exists in the configuration file, then the
default value is used. The value is converted to a boolean.
spec-type: none
+ get-env:
+ description: |
+ The action gets the action value for subsequent actions from the
+ environment variable of the configuration set named by the attribute
+ value.
+ spec-type: str
get-integer:
description: |
The action gets the action value for subsequent actions from a
@@ -189,12 +195,6 @@ spec-info:
If no such variable exists in the configuration file, then the
default value is used. The value is converted to a string.
spec-type: none
- get-env:
- description: |
- The action gets the action value for subsequent actions from the
- environment variable of the configuration set named by the attribute
- value.
- spec-type: str
script:
description: |
The action executes the attribute value with the Python ``eval()``
diff --git a/spec/spec/build-config-header.yml b/spec/spec/build-config-header.yml
index d5be648e..e622a363 100644
--- a/spec/spec/build-config-header.yml
+++ b/spec/spec/build-config-header.yml
@@ -14,6 +14,10 @@ spec-example: null
spec-info:
dict:
attributes:
+ guard:
+ description: |
+ It shall be the header guard define.
+ spec-type: str
include-headers:
description: |
It shall be a list of header files to include via ``#include <...>``.
@@ -21,10 +25,6 @@ spec-info:
install-path:
description: null
spec-type: build-install-path
- guard:
- description: |
- It shall be the header guard define.
- spec-type: str
target:
description: null
spec-type: build-target
diff --git a/spec/spec/build-default-by-variant.yml b/spec/spec/build-default-by-variant.yml
index 8b33d4ee..4d37dda4 100644
--- a/spec/spec/build-default-by-variant.yml
+++ b/spec/spec/build-default-by-variant.yml
@@ -10,15 +10,15 @@ spec-example: null
spec-info:
dict:
attributes:
+ value:
+ description: |
+ It value shall be the default value for the matching variants.
+ spec-type: build-option-value
variants:
description: |
It shall be a list of Python regular expression matching with the
desired variants.
spec-type: list-str
- value:
- description: |
- It value shall be the default value for the matching variants.
- spec-type: build-option-value
description: |
This set of attributes specifies build option default values by variant.
required-attributes: all
diff --git a/spec/spec/build-option.yml b/spec/spec/build-option.yml
index 0db645d8..6d92a739 100644
--- a/spec/spec/build-option.yml
+++ b/spec/spec/build-option.yml
@@ -34,6 +34,10 @@ spec-info:
The list is processed from top to bottom. If a matching variant is
found, then the processing stops.
spec-type: build-default-by-variant-list
+ description:
+ description: |
+ It shall be the description of the option.
+ spec-type: optional-str
format:
description: |
It shall be a `Python format string
@@ -43,10 +47,6 @@ spec-info:
name:
description: null
spec-type: build-option-name
- description:
- description: |
- It shall be the description of the option.
- spec-type: optional-str
description: |
This set of attributes specifies a build option.
required-attributes:
diff --git a/spec/spec/build-script.yml b/spec/spec/build-script.yml
index cae05629..32c4fc6a 100644
--- a/spec/spec/build-script.yml
+++ b/spec/spec/build-script.yml
@@ -14,14 +14,18 @@ spec-example: null
spec-info:
dict:
attributes:
- do-configure:
- description: |
- 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 :file:`wscript`. A local variable ``conf`` is
- available with the ``waf`` configuration context. A local variable
- ``cic`` is available with the configuration item context.
- spec-type: optional-str
+ asflags:
+ description: null
+ spec-type: build-asflags
+ cflags:
+ description: null
+ spec-type: build-cflags
+ cppflags:
+ description: null
+ spec-type: build-cppflags
+ cxxflags:
+ description: null
+ spec-type: build-cxxflags
do-build:
description: |
If this script shall execute, then it shall be Python code which is
@@ -30,14 +34,20 @@ spec-info:
the ``waf`` build context. A local variable ``bic`` is available
with the build item context.
spec-type: optional-str
- prepare-configure:
+ do-configure:
description: |
If this script shall execute, then it shall be Python code which is
- executed via ``exec()`` in the context of the ``prepare_configure()``
+ executed via ``exec()`` in the context of the ``do_configure()``
method of the :file:`wscript`. A local variable ``conf`` is
available with the ``waf`` configuration context. A local variable
``cic`` is available with the configuration item context.
spec-type: optional-str
+ includes:
+ description: null
+ spec-type: build-includes
+ ldflags:
+ description: null
+ spec-type: build-ldflags
prepare-build:
description: |
If this script shall execute, then it shall be Python code which is
@@ -46,6 +56,14 @@ spec-info:
with the ``waf`` build context. A local variable ``bic`` is
available with the build item context.
spec-type: optional-str
+ prepare-configure:
+ description: |
+ 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 :file:`wscript`. A local variable ``conf`` is
+ available with the ``waf`` configuration context. A local variable
+ ``cic`` is available with the configuration item context.
+ spec-type: optional-str
stlib:
description: |
It shall be a list of external static library identifiers used to
@@ -57,24 +75,6 @@ spec-info:
use-before:
description: null
spec-type: build-use-before-list
- asflags:
- description: null
- spec-type: build-asflags
- cflags:
- description: null
- spec-type: build-cflags
- cppflags:
- description: null
- spec-type: build-cppflags
- cxxflags:
- description: null
- spec-type: build-cxxflags
- includes:
- description: null
- spec-type: build-includes
- ldflags:
- description: null
- spec-type: build-ldflags
description: |
This set of attributes specifies build scripts.
required-attributes:
diff --git a/spec/spec/requirement.yml b/spec/spec/requirement.yml
index dccc7ad5..2c0157a1 100644
--- a/spec/spec/requirement.yml
+++ b/spec/spec/requirement.yml
@@ -14,14 +14,14 @@ spec-example: null
spec-info:
dict:
attributes:
- text:
- description: |
- This mandatory attribute defines the requirement text.
- spec-type: requirement-text
requirement-type:
description: |
This mandatory attribute defines the requirement type.
spec-type: name
+ text:
+ description: |
+ This mandatory attribute defines the requirement text.
+ spec-type: requirement-text
description: |
This set of attributes specifies a requirement.
required-attributes: all