[rtems-central commit] spec: Canonicalize requirement wordings

Sebastian Huber sebh at rtems.org
Tue May 9 13:45:27 UTC 2023


Module:    rtems-central
Branch:    master
Commit:    dff8cb8b74d79843630fe8cbfc1cf077ac6c9c6f
Changeset: http://git.rtems.org/rtems-central/commit/?id=dff8cb8b74d79843630fe8cbfc1cf077ac6c9c6f

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Fri May  5 14:41:20 2023 +0200

spec: Canonicalize requirement wordings

---

 spec/rtems/attr/req/default-equals.yml            | 4 ++--
 spec/rtems/intr/req/lock-declare-identifier.yml   | 6 +++---
 spec/rtems/intr/req/lock-declare-specifier.yml    | 6 +++---
 spec/rtems/intr/req/lock-define-identifier.yml    | 6 +++---
 spec/rtems/intr/req/lock-define-specifier.yml     | 6 +++---
 spec/rtems/intr/req/lock-empty-initializer.yml    | 2 +-
 spec/rtems/intr/req/lock-member-identifier.yml    | 4 ++--
 spec/rtems/intr/req/lock-member-type.yml          | 4 ++--
 spec/rtems/intr/req/lock-reference-identifier.yml | 4 ++--
 spec/rtems/intr/req/lock-reference-target.yml     | 6 +++---
 spec/rtems/intr/req/lock-reference-type.yml       | 4 ++--
 spec/rtems/intr/req/lock-use-context.yml          | 4 ++--
 spec/rtems/intr/req/lock-white-space.yml          | 2 +-
 spec/rtems/mode/req/interrupt-level.yml           | 6 +++---
 14 files changed, 32 insertions(+), 32 deletions(-)

diff --git a/spec/rtems/attr/req/default-equals.yml b/spec/rtems/attr/req/default-equals.yml
index 4d011127..4ee6b8b2 100644
--- a/spec/rtems/attr/req/default-equals.yml
+++ b/spec/rtems/attr/req/default-equals.yml
@@ -10,6 +10,6 @@ rationale: null
 references: []
 requirement-type: functional
 text: |
-  The value of macro ${../if/default:/name} shall be equal to the value
-  of expression ``${../if/fifo:/name} | ${../if/local:/name}``.
+  The value of ${../if/default:/name} shall be equal to the value of the
+  expression ${../if/fifo:/name} bitwise or ${../if/local:/name}.
 type: requirement
diff --git a/spec/rtems/intr/req/lock-declare-identifier.yml b/spec/rtems/intr/req/lock-declare-identifier.yml
index 554012ff..e8fbb4cc 100644
--- a/spec/rtems/intr/req/lock-declare-identifier.yml
+++ b/spec/rtems/intr/req/lock-declare-identifier.yml
@@ -10,7 +10,7 @@ rationale: null
 references: []
 requirement-type: functional
 text: |
-  When the ${../if/lock-declare:/name} is used, it shall expand to an object
-  declaration with an identifier specified by the
-  ${../if/lock-declare:/params[1]/name} parameter.
+  The ${../if/lock-declare:/name} macro shall expand to an object declaration
+  with an identifier specified by the ${../if/lock-declare:/params[1]/name}
+  parameter.
 type: requirement
diff --git a/spec/rtems/intr/req/lock-declare-specifier.yml b/spec/rtems/intr/req/lock-declare-specifier.yml
index 5f16c988..a88efea6 100644
--- a/spec/rtems/intr/req/lock-declare-specifier.yml
+++ b/spec/rtems/intr/req/lock-declare-specifier.yml
@@ -10,7 +10,7 @@ rationale: null
 references: []
 requirement-type: functional
 text: |
-  When the ${../if/lock-declare:/name} is used, it shall expand to an object
-  declaration with a specifier specified by the
-  ${../if/lock-declare:/params[0]/name} parameter.
+  The ${../if/lock-declare:/name} macro shall expand to an object declaration
+  with a specifier specified by the ${../if/lock-declare:/params[0]/name}
+  parameter.
 type: requirement
diff --git a/spec/rtems/intr/req/lock-define-identifier.yml b/spec/rtems/intr/req/lock-define-identifier.yml
index 44a0ed07..114c2cbc 100644
--- a/spec/rtems/intr/req/lock-define-identifier.yml
+++ b/spec/rtems/intr/req/lock-define-identifier.yml
@@ -10,7 +10,7 @@ rationale: null
 references: []
 requirement-type: functional
 text: |
-  When the ${../if/lock-define:/name} is used, it shall expand to an object
-  definition with an identifier specified by the
-  ${../if/lock-define:/params[1]/name} parameter.
+  The ${../if/lock-define:/name} macro shall expand to an object definition
+  with an identifier specified by the ${../if/lock-define:/params[1]/name}
+  parameter.
 type: requirement
diff --git a/spec/rtems/intr/req/lock-define-specifier.yml b/spec/rtems/intr/req/lock-define-specifier.yml
index ed17336d..04fb194a 100644
--- a/spec/rtems/intr/req/lock-define-specifier.yml
+++ b/spec/rtems/intr/req/lock-define-specifier.yml
@@ -10,7 +10,7 @@ rationale: null
 references: []
 requirement-type: functional
 text: |
-  When the ${../if/lock-define:/name} is used, it shall expand to an object
-  definition with a specifier specified by the
-  ${../if/lock-define:/params[0]/name} parameter.
+  The ${../if/lock-define:/name} macro shall expand to an object definition
+  with a specifier specified by the ${../if/lock-define:/params[0]/name}
+  parameter.
 type: requirement
diff --git a/spec/rtems/intr/req/lock-empty-initializer.yml b/spec/rtems/intr/req/lock-empty-initializer.yml
index 6d095227..f4af1bd7 100644
--- a/spec/rtems/intr/req/lock-empty-initializer.yml
+++ b/spec/rtems/intr/req/lock-empty-initializer.yml
@@ -11,6 +11,6 @@ rationale: null
 references: []
 requirement-type: functional
 text: |
-  When the macro is used, the macro shall expand to an empty structure
+  The ${../if/lock-initializer:/name} macro shall expand to an empty structure
   initializer.
 type: requirement
diff --git a/spec/rtems/intr/req/lock-member-identifier.yml b/spec/rtems/intr/req/lock-member-identifier.yml
index 8a143b3f..6a7c681f 100644
--- a/spec/rtems/intr/req/lock-member-identifier.yml
+++ b/spec/rtems/intr/req/lock-member-identifier.yml
@@ -10,7 +10,7 @@ rationale: null
 references: []
 requirement-type: functional
 text: |
-  When the ${../if/lock-member:/name} is used, it shall expand to structure or
-  union member declaration with an identifier specified by the
+  The ${../if/lock-member:/name} macro shall expand to structure or union
+  member declaration with an identifier specified by the
   ${../if/lock-define:/params[0]/name} parameter.
 type: requirement
diff --git a/spec/rtems/intr/req/lock-member-type.yml b/spec/rtems/intr/req/lock-member-type.yml
index 1bde15cb..f884e6cf 100644
--- a/spec/rtems/intr/req/lock-member-type.yml
+++ b/spec/rtems/intr/req/lock-member-type.yml
@@ -10,6 +10,6 @@ rationale: null
 references: []
 requirement-type: functional
 text: |
-  When the ${../if/lock-member:/name} is used, it shall expand to structure or
-  union member declaration with a type of ${../if/lock:/name}.
+  The ${../if/lock-member:/name} macro shall expand to structure or union
+  member declaration with a type of ${../if/lock:/name}.
 type: requirement
diff --git a/spec/rtems/intr/req/lock-reference-identifier.yml b/spec/rtems/intr/req/lock-reference-identifier.yml
index 135df28f..0c69bb36 100644
--- a/spec/rtems/intr/req/lock-reference-identifier.yml
+++ b/spec/rtems/intr/req/lock-reference-identifier.yml
@@ -10,7 +10,7 @@ rationale: null
 references: []
 requirement-type: functional
 text: |
-  When the ${../if/lock-reference:/name} is used, it shall expand to an object
-  reference definition with an identifier specified by the
+  The ${../if/lock-reference:/name} macro shall expand to an object reference
+  definition with an identifier specified by the
   ${../if/lock-reference:/params[0]/name} parameter.
 type: requirement
diff --git a/spec/rtems/intr/req/lock-reference-target.yml b/spec/rtems/intr/req/lock-reference-target.yml
index f46b6848..995d8f1b 100644
--- a/spec/rtems/intr/req/lock-reference-target.yml
+++ b/spec/rtems/intr/req/lock-reference-target.yml
@@ -10,7 +10,7 @@ rationale: null
 references: []
 requirement-type: functional
 text: |
-  When the ${../if/lock-reference:/name} is used, it shall expand to an object
-  reference definition which is initialized to the object reference specified
-  by the ${../if/lock-reference:/params[1]/name} parameter.
+  The ${../if/lock-reference:/name} macro shall expand to an object reference
+  definition which is initialized to the object reference specified by the
+  ${../if/lock-reference:/params[1]/name} parameter.
 type: requirement
diff --git a/spec/rtems/intr/req/lock-reference-type.yml b/spec/rtems/intr/req/lock-reference-type.yml
index 0eba8971..4219c5c3 100644
--- a/spec/rtems/intr/req/lock-reference-type.yml
+++ b/spec/rtems/intr/req/lock-reference-type.yml
@@ -10,6 +10,6 @@ rationale: null
 references: []
 requirement-type: functional
 text: |
-  When the ${../if/lock-reference:/name} is used, it shall expand to an object
-  reference definition with a type of a pointer to ${../if/lock:/name}.
+  The ${../if/lock-reference:/name} macro shall expand to an object reference
+  definition with a type of a pointer to ${../if/lock:/name}.
 type: requirement
diff --git a/spec/rtems/intr/req/lock-use-context.yml b/spec/rtems/intr/req/lock-use-context.yml
index c59c86d0..7263d220 100644
--- a/spec/rtems/intr/req/lock-use-context.yml
+++ b/spec/rtems/intr/req/lock-use-context.yml
@@ -13,6 +13,6 @@ rationale: null
 references: []
 requirement-type: functional
 text: |
-  When the macro is used, the macro shall expand to code block which marks the
-  second parameter as used.
+  The macro shall expand to a code block which marks the second parameter as
+  used.
 type: requirement
diff --git a/spec/rtems/intr/req/lock-white-space.yml b/spec/rtems/intr/req/lock-white-space.yml
index 80fbeb2f..71fcdba8 100644
--- a/spec/rtems/intr/req/lock-white-space.yml
+++ b/spec/rtems/intr/req/lock-white-space.yml
@@ -21,5 +21,5 @@ rationale: null
 references: []
 requirement-type: functional
 text: |
-  When the macro is used, the macro shall expand to white space only.
+  The macro shall expand to white space only.
 type: requirement
diff --git a/spec/rtems/mode/req/interrupt-level.yml b/spec/rtems/mode/req/interrupt-level.yml
index 7e9fc601..4eafb1d3 100644
--- a/spec/rtems/mode/req/interrupt-level.yml
+++ b/spec/rtems/mode/req/interrupt-level.yml
@@ -10,8 +10,8 @@ rationale: null
 references: []
 requirement-type: functional
 text: |
-  When the ${../if/interrupt-level:/name} macro is used, it shall expand to a
-  constant expression which computes the bitwise and of the value specified by
-  the ${../if/interrupt-level:/params[0]/name} parameter and
+  The ${../if/interrupt-level:/name} macro shall expand to a constant
+  expression which computes the bitwise and of the value specified by the
+  ${../if/interrupt-level:/params[0]/name} parameter and
   ${../if/interrupt-mask:/name}.
 type: requirement



More information about the vc mailing list