summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-27 15:38:30 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-28 07:33:18 +0200
commitc2595631da2782fbc3b59f4b65aa5703d460f903 (patch)
tree22d17f2b88ac593f3d5d2c4117f67862025219ed
parenteng: Add brief description to header file items (diff)
downloadrtems-docs-c2595631da2782fbc3b59f4b65aa5703d460f903.tar.bz2
eng: Support N/A in the action transitions
Sometimes the pre-conditions in an action requirement are not independent and it is necessary to mark pre-conditions as not applicable in a particular transition. Update #3715.
-rw-r--r--eng/req/items.rst17
1 files changed, 13 insertions, 4 deletions
diff --git a/eng/req/items.rst b/eng/req/items.rst
index f97afcc..4b4d85c 100644
--- a/eng/req/items.rst
+++ b/eng/req/items.rst
@@ -2192,8 +2192,12 @@ 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]+$"``.
+have in an action requirement, the shorter the names should be. The name
+``NA`` is reserved and indicates that a condition is not applicable. The value
+
+* shall match with the regular expression "``^[A-Z][a-zA-Z0-9]+$"``,
+
+* and, shall be not equal to "``NA``".
This type is used by the following types:
@@ -2429,8 +2433,13 @@ A value of this type shall be of one of the following variants:
:ref:`SpecTypeActionRequirementName`. 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``".
+* The value may be a string. The value ``all`` represents all states of the
+ pre-condition in this transition. The value ``N/A`` marks the pre-condition
+ as not applicable in this transition. The value shall be an element of
+
+ * "``all``", and
+
+ * "``N/A``".
This type is used by the following types: