[rtems-central commit] spec: Document signal manager

Sebastian Huber sebh at rtems.org
Fri Feb 19 06:05:32 UTC 2021


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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Mon Feb 15 10:22:04 2021 +0100

spec: Document signal manager

---

 config.yml                                         |  3 ++
 spec/rtems/signal/if/asr-entry.yml                 |  4 +-
 spec/rtems/signal/if/asr.yml                       |  8 ++-
 spec/rtems/signal/if/catch.yml                     | 56 +++++++++++++++++---
 spec/rtems/signal/if/send.yml                      | 60 +++++++++++++++++++---
 spec/rtems/signal/if/set.yml                       |  4 +-
 .../signal/if/{signal-0.yml => signal-00.yml}      |  3 +-
 .../signal/if/{signal-1.yml => signal-01.yml}      |  3 +-
 .../signal/if/{signal-2.yml => signal-02.yml}      |  3 +-
 .../signal/if/{signal-3.yml => signal-03.yml}      |  3 +-
 .../signal/if/{signal-4.yml => signal-04.yml}      |  3 +-
 .../signal/if/{signal-5.yml => signal-05.yml}      |  3 +-
 .../signal/if/{signal-6.yml => signal-06.yml}      |  3 +-
 .../signal/if/{signal-7.yml => signal-07.yml}      |  3 +-
 .../signal/if/{signal-8.yml => signal-08.yml}      |  3 +-
 .../signal/if/{signal-9.yml => signal-09.yml}      |  3 +-
 spec/rtems/signal/if/signal-10.yml                 |  3 +-
 spec/rtems/signal/if/signal-11.yml                 |  3 +-
 spec/rtems/signal/if/signal-12.yml                 |  3 +-
 spec/rtems/signal/if/signal-13.yml                 |  3 +-
 spec/rtems/signal/if/signal-14.yml                 |  3 +-
 spec/rtems/signal/if/signal-15.yml                 |  3 +-
 spec/rtems/signal/if/signal-16.yml                 |  3 +-
 spec/rtems/signal/if/signal-17.yml                 |  3 +-
 spec/rtems/signal/if/signal-18.yml                 |  3 +-
 spec/rtems/signal/if/signal-19.yml                 |  3 +-
 spec/rtems/signal/if/signal-20.yml                 |  3 +-
 spec/rtems/signal/if/signal-21.yml                 |  3 +-
 spec/rtems/signal/if/signal-22.yml                 |  3 +-
 spec/rtems/signal/if/signal-23.yml                 |  3 +-
 spec/rtems/signal/if/signal-24.yml                 |  3 +-
 spec/rtems/signal/if/signal-25.yml                 |  3 +-
 spec/rtems/signal/if/signal-26.yml                 |  3 +-
 spec/rtems/signal/if/signal-27.yml                 |  3 +-
 spec/rtems/signal/if/signal-28.yml                 |  3 +-
 spec/rtems/signal/if/signal-29.yml                 |  3 +-
 spec/rtems/signal/if/signal-30.yml                 |  3 +-
 spec/rtems/signal/if/signal-31.yml                 |  3 +-
 38 files changed, 180 insertions(+), 51 deletions(-)

diff --git a/config.yml b/config.yml
index c58a002..d53f03b 100644
--- a/config.yml
+++ b/config.yml
@@ -123,6 +123,9 @@ interface-documentation:
 - directives-target: modules/rtems-docs/c-user/object-services/directives.rst
   group: /rtems/object/if/group
   introduction-target: modules/rtems-docs/c-user/object-services/introduction.rst
+- directives-target: modules/rtems-docs/c-user/signal/directives.rst
+  group: /rtems/signal/if/group
+  introduction-target: modules/rtems-docs/c-user/signal/introduction.rst
 spec-verification:
   root-type: /spec/root
 spec-documentation:
diff --git a/spec/rtems/signal/if/asr-entry.yml b/spec/rtems/signal/if/asr-entry.yml
index e48b75b..92f7de0 100644
--- a/spec/rtems/signal/if/asr-entry.yml
+++ b/spec/rtems/signal/if/asr-entry.yml
@@ -1,5 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  This type defines the prototype of routines which are used to process
+  asynchronous signals.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/asr.yml b/spec/rtems/signal/if/asr.yml
index ebe5569..3ea5232 100644
--- a/spec/rtems/signal/if/asr.yml
+++ b/spec/rtems/signal/if/asr.yml
@@ -1,5 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  This type defines the return type of routines which are used to process
+  asynchronous signals.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
@@ -16,5 +18,7 @@ links:
 - role: interface-ingroup
   uid: group
 name: rtems_asr
-notes: null
+notes: |
+  This type can be used to document asynchronous signal routines in the source
+  code.
 type: interface
diff --git a/spec/rtems/signal/if/catch.yml b/spec/rtems/signal/if/catch.yml
index aaa3d0e..ea7d0f0 100644
--- a/spec/rtems/signal/if/catch.yml
+++ b/spec/rtems/signal/if/catch.yml
@@ -1,5 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  Establishes an asynchronous signal routine (ASR) for the calling task.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
@@ -12,25 +13,66 @@ definition:
     - ${../../mode/if/mode:/name} ${.:/params[1]/name}
     return: ${../../status/if/code:/name}
   variants: []
-description: null
+description: |
+  This directive establishes an asynchronous signal routine (ASR) for the
+  calling task.  The ${.:/params[0]/name} parameter specifies the entry point
+  of the ASR.  A task may have at most one handler installed at a time.  The
+  most recently installed handler is used.  When ${.:/params[0]/name} is
+  ${/c/if/null:/name}, the ASR for the calling task is invalidated and all
+  pending signals are cleared.  Any signals sent to a task with an invalid ASR
+  are discarded.  The ${.:/params[1]/name} parameter specifies the execution
+  mode for the ASR.  This execution mode supersedes the task's execution mode
+  while the ASR is executing.
 enabled-by: true
-index-entries: []
+index-entries:
+- establish an ASR
+- install an ASR
 interface-type: function
 links:
 - role: interface-placement
   uid: header
 - role: interface-ingroup
   uid: group
+- role: constraint
+  uid: /constraint/directive-ctx-task
+- role: constraint
+  uid: /constraint/directive-no-preempt
 name: rtems_signal_catch
-notes: null
+notes: |
+  It is strongly recommended to disable ASR processing during ASR processing by
+  setting ${../../mode/if/no-asr:/name} in ${.:/params[1]/name}, otherwise a
+  recursion may happen during ASR processing.  Uncontrolled recursion may lead
+  to stack overflows.
+
+  Using the same mutex (in particular a recursive mutex) in normal task context
+  and during ASR processing may result in undefined behaviour.
+
+  Asynchronous signal handlers can access thread-local storage
+  (${/glossary/tls:/term}).  When thread-local storage is shared between normal
+  task context and ASR processing, it may be protected by disabled interrupts.
 params:
-- description: '%'
+- description: |
+    is the handler to process an asynchronous signal set.
   dir: null
   name: asr_handler
-- description: '%'
+- description: |
+    is the task mode while an asynchronous signal set is processed by the
+    handler.  See ${../../task/if/mode:/name}.
   dir: null
   name: mode_set
 return:
   return: null
-  return-values: []
+  return-values:
+  - description: |
+      The requested operation was successful.
+    value: ${../../status/if/successful:/name}
+  - description: |
+      The ${../../mode/if/no-preempt:/name} was set in ${.:/params[1]/name} and
+      the system configuration had no implementation for this mode.
+    value: ${../../status/if/not-implemented:/name}
+  - description: |
+      The ${../../mode/if/interrupt-level:/name} was set with a positive level
+      in ${.:/params[1]/name} and the system configuration had no
+      implementation for this mode.
+    value: ${../../status/if/not-implemented:/name}
 type: interface
diff --git a/spec/rtems/signal/if/send.yml b/spec/rtems/signal/if/send.yml
index e294c60..f0df684 100644
--- a/spec/rtems/signal/if/send.yml
+++ b/spec/rtems/signal/if/send.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  Sends the signal set to the task.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
   default:
@@ -12,25 +13,68 @@ definition:
     - ${set:/name} ${.:/params[1]/name}
     return: ${../../status/if/code:/name}
   variants: []
-description: null
+description: |
+  This directive sends the signal set, ${.:/params[1]/name}, to the target
+  task identified by ${.:/params[0]/name}.
+
+  If a caller sends a signal set to a task with an invalid
+  ${/glossary/asr:/term}, then an error code is returned to the caller.  If a
+  caller sends a signal set to a task whose ASR is valid but disabled, then the
+  signal set will be caught and left pending for the ASR to process when it is
+  enabled.  If a caller sends a signal set to a task with an ASR that is both
+  valid and enabled, then the signal set is caught and the ASR will execute the
+  next time the task is dispatched to run.
 enabled-by: true
-index-entries: []
+index-entries:
+- send signal set
 interface-type: function
 links:
 - role: interface-placement
   uid: header
 - role: interface-ingroup
   uid: group
+- role: constraint
+  uid: /constraint/directive-ctx-isr
+- role: constraint
+  uid: /constraint/directive-ctx-devinit
+- role: constraint
+  uid: /constraint/directive-ctx-task
+- role: constraint
+  uid: /constraint/directive-no-preempt-local
+- role: constraint
+  uid: /constraint/directive-remote
 name: rtems_signal_send
-notes: null
+notes: |
+  Sending a signal set to a task has no effect on that task's state.  If a
+  signal set is sent to a blocked task, then the task will remain blocked and
+  the signals will be processed when the task becomes the running task.
+
+  Sending a signal set to a global task which does not reside on the local node
+  will generate a request telling the remote node to send the signal set to the
+  specified task.
 params:
-- description: '%'
+- description: |
+    is the identifier of the target task to receive the signal set.
   dir: null
   name: id
-- description: '%'
+- description: |
+    is the signal set to send.
   dir: null
   name: signal_set
 return:
   return: null
-  return-values: []
+  return-values:
+  - description: |
+      The requested operation was successful.
+    value: ${../../status/if/successful:/name}
+  - description: |
+      The ${.:/params[1]/name} parameter was 0.
+    value: ${../../status/if/invalid-number:/name}
+  - description: |
+      There was no task associated with the identifier specified by
+      ${.:/params[0]/name}.
+    value: ${../../status/if/invalid-id:/name}
+  - description: |
+      The target task had no valid ASR installed.
+    value: ${../../status/if/not-defined:/name}
 type: interface
diff --git a/spec/rtems/signal/if/set.yml b/spec/rtems/signal/if/set.yml
index 5692987..30b743c 100644
--- a/spec/rtems/signal/if/set.yml
+++ b/spec/rtems/signal/if/set.yml
@@ -1,5 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  This integer type represents a bit field which can hold exactly 32 individual
+  signals.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-0.yml b/spec/rtems/signal/if/signal-00.yml
similarity index 84%
rename from spec/rtems/signal/if/signal-0.yml
rename to spec/rtems/signal/if/signal-00.yml
index 6c24939..5bcb3df 100644
--- a/spec/rtems/signal/if/signal-0.yml
+++ b/spec/rtems/signal/if/signal-00.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 0.
+  This signal set constant represents the bit in the signal set associated with
+  signal 0.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-1.yml b/spec/rtems/signal/if/signal-01.yml
similarity index 84%
rename from spec/rtems/signal/if/signal-1.yml
rename to spec/rtems/signal/if/signal-01.yml
index 39b60f7..21fa330 100644
--- a/spec/rtems/signal/if/signal-1.yml
+++ b/spec/rtems/signal/if/signal-01.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 1.
+  This signal set constant represents the bit in the signal set associated with
+  signal 1.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-2.yml b/spec/rtems/signal/if/signal-02.yml
similarity index 84%
rename from spec/rtems/signal/if/signal-2.yml
rename to spec/rtems/signal/if/signal-02.yml
index ae33f46..fcc0d60 100644
--- a/spec/rtems/signal/if/signal-2.yml
+++ b/spec/rtems/signal/if/signal-02.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 2.
+  This signal set constant represents the bit in the signal set associated with
+  signal 2.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-3.yml b/spec/rtems/signal/if/signal-03.yml
similarity index 84%
rename from spec/rtems/signal/if/signal-3.yml
rename to spec/rtems/signal/if/signal-03.yml
index 2531d68..9571661 100644
--- a/spec/rtems/signal/if/signal-3.yml
+++ b/spec/rtems/signal/if/signal-03.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 3.
+  This signal set constant represents the bit in the signal set associated with
+  signal 3.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-4.yml b/spec/rtems/signal/if/signal-04.yml
similarity index 84%
rename from spec/rtems/signal/if/signal-4.yml
rename to spec/rtems/signal/if/signal-04.yml
index badcc35..ddf299a 100644
--- a/spec/rtems/signal/if/signal-4.yml
+++ b/spec/rtems/signal/if/signal-04.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 4.
+  This signal set constant represents the bit in the signal set associated with
+  signal 4.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-5.yml b/spec/rtems/signal/if/signal-05.yml
similarity index 84%
rename from spec/rtems/signal/if/signal-5.yml
rename to spec/rtems/signal/if/signal-05.yml
index f8171f6..c93262f 100644
--- a/spec/rtems/signal/if/signal-5.yml
+++ b/spec/rtems/signal/if/signal-05.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 5.
+  This signal set constant represents the bit in the signal set associated with
+  signal 5.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-6.yml b/spec/rtems/signal/if/signal-06.yml
similarity index 84%
rename from spec/rtems/signal/if/signal-6.yml
rename to spec/rtems/signal/if/signal-06.yml
index 983d563..87a9ae3 100644
--- a/spec/rtems/signal/if/signal-6.yml
+++ b/spec/rtems/signal/if/signal-06.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 6.
+  This signal set constant represents the bit in the signal set associated with
+  signal 6.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-7.yml b/spec/rtems/signal/if/signal-07.yml
similarity index 84%
rename from spec/rtems/signal/if/signal-7.yml
rename to spec/rtems/signal/if/signal-07.yml
index b78052a..81f95a3 100644
--- a/spec/rtems/signal/if/signal-7.yml
+++ b/spec/rtems/signal/if/signal-07.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 7.
+  This signal set constant represents the bit in the signal set associated with
+  signal 7.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-8.yml b/spec/rtems/signal/if/signal-08.yml
similarity index 84%
rename from spec/rtems/signal/if/signal-8.yml
rename to spec/rtems/signal/if/signal-08.yml
index f52d6e5..a2bd9f8 100644
--- a/spec/rtems/signal/if/signal-8.yml
+++ b/spec/rtems/signal/if/signal-08.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 8.
+  This signal set constant represents the bit in the signal set associated with
+  signal 8.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-9.yml b/spec/rtems/signal/if/signal-09.yml
similarity index 84%
rename from spec/rtems/signal/if/signal-9.yml
rename to spec/rtems/signal/if/signal-09.yml
index c9364c5..0a01930 100644
--- a/spec/rtems/signal/if/signal-9.yml
+++ b/spec/rtems/signal/if/signal-09.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 9.
+  This signal set constant represents the bit in the signal set associated with
+  signal 9.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-10.yml b/spec/rtems/signal/if/signal-10.yml
index 16d2147..bbd3021 100644
--- a/spec/rtems/signal/if/signal-10.yml
+++ b/spec/rtems/signal/if/signal-10.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 10.
+  This signal set constant represents the bit in the signal set associated with
+  signal 10.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-11.yml b/spec/rtems/signal/if/signal-11.yml
index f795c8f..8e8b447 100644
--- a/spec/rtems/signal/if/signal-11.yml
+++ b/spec/rtems/signal/if/signal-11.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 11.
+  This signal set constant represents the bit in the signal set associated with
+  signal 11.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-12.yml b/spec/rtems/signal/if/signal-12.yml
index f7a47ae..3836382 100644
--- a/spec/rtems/signal/if/signal-12.yml
+++ b/spec/rtems/signal/if/signal-12.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 12.
+  This signal set constant represents the bit in the signal set associated with
+  signal 12.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-13.yml b/spec/rtems/signal/if/signal-13.yml
index 9fb4c40..a793a35 100644
--- a/spec/rtems/signal/if/signal-13.yml
+++ b/spec/rtems/signal/if/signal-13.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 13.
+  This signal set constant represents the bit in the signal set associated with
+  signal 13.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-14.yml b/spec/rtems/signal/if/signal-14.yml
index 361216b..b0238bc 100644
--- a/spec/rtems/signal/if/signal-14.yml
+++ b/spec/rtems/signal/if/signal-14.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 14.
+  This signal set constant represents the bit in the signal set associated with
+  signal 14.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-15.yml b/spec/rtems/signal/if/signal-15.yml
index 9c501f6..c7c655f 100644
--- a/spec/rtems/signal/if/signal-15.yml
+++ b/spec/rtems/signal/if/signal-15.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 15.
+  This signal set constant represents the bit in the signal set associated with
+  signal 15.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-16.yml b/spec/rtems/signal/if/signal-16.yml
index 4ca6e54..132ce8d 100644
--- a/spec/rtems/signal/if/signal-16.yml
+++ b/spec/rtems/signal/if/signal-16.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 16.
+  This signal set constant represents the bit in the signal set associated with
+  signal 16.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-17.yml b/spec/rtems/signal/if/signal-17.yml
index e9a7310..64506d5 100644
--- a/spec/rtems/signal/if/signal-17.yml
+++ b/spec/rtems/signal/if/signal-17.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 17.
+  This signal set constant represents the bit in the signal set associated with
+  signal 17.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-18.yml b/spec/rtems/signal/if/signal-18.yml
index 54a7f10..4a12ee7 100644
--- a/spec/rtems/signal/if/signal-18.yml
+++ b/spec/rtems/signal/if/signal-18.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 18.
+  This signal set constant represents the bit in the signal set associated with
+  signal 18.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-19.yml b/spec/rtems/signal/if/signal-19.yml
index f0292cd..6f1e24d 100644
--- a/spec/rtems/signal/if/signal-19.yml
+++ b/spec/rtems/signal/if/signal-19.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 19.
+  This signal set constant represents the bit in the signal set associated with
+  signal 19.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-20.yml b/spec/rtems/signal/if/signal-20.yml
index 19388d2..d33aa7f 100644
--- a/spec/rtems/signal/if/signal-20.yml
+++ b/spec/rtems/signal/if/signal-20.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 20.
+  This signal set constant represents the bit in the signal set associated with
+  signal 20.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-21.yml b/spec/rtems/signal/if/signal-21.yml
index b519aac..a242f6a 100644
--- a/spec/rtems/signal/if/signal-21.yml
+++ b/spec/rtems/signal/if/signal-21.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 21.
+  This signal set constant represents the bit in the signal set associated with
+  signal 21.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-22.yml b/spec/rtems/signal/if/signal-22.yml
index b28923b..312d411 100644
--- a/spec/rtems/signal/if/signal-22.yml
+++ b/spec/rtems/signal/if/signal-22.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 22.
+  This signal set constant represents the bit in the signal set associated with
+  signal 22.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-23.yml b/spec/rtems/signal/if/signal-23.yml
index ffb8143..296da7c 100644
--- a/spec/rtems/signal/if/signal-23.yml
+++ b/spec/rtems/signal/if/signal-23.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 23.
+  This signal set constant represents the bit in the signal set associated with
+  signal 23.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-24.yml b/spec/rtems/signal/if/signal-24.yml
index a918a66..70ef9e7 100644
--- a/spec/rtems/signal/if/signal-24.yml
+++ b/spec/rtems/signal/if/signal-24.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 24.
+  This signal set constant represents the bit in the signal set associated with
+  signal 24.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-25.yml b/spec/rtems/signal/if/signal-25.yml
index b8e1b1f..21a9baf 100644
--- a/spec/rtems/signal/if/signal-25.yml
+++ b/spec/rtems/signal/if/signal-25.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 25.
+  This signal set constant represents the bit in the signal set associated with
+  signal 25.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-26.yml b/spec/rtems/signal/if/signal-26.yml
index 4e99552..7301c8a 100644
--- a/spec/rtems/signal/if/signal-26.yml
+++ b/spec/rtems/signal/if/signal-26.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 26.
+  This signal set constant represents the bit in the signal set associated with
+  signal 26.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-27.yml b/spec/rtems/signal/if/signal-27.yml
index 77f6d2a..87548ff 100644
--- a/spec/rtems/signal/if/signal-27.yml
+++ b/spec/rtems/signal/if/signal-27.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 27.
+  This signal set constant represents the bit in the signal set associated with
+  signal 27.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-28.yml b/spec/rtems/signal/if/signal-28.yml
index 5cfb4df..a0bdb7d 100644
--- a/spec/rtems/signal/if/signal-28.yml
+++ b/spec/rtems/signal/if/signal-28.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 28.
+  This signal set constant represents the bit in the signal set associated with
+  signal 28.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-29.yml b/spec/rtems/signal/if/signal-29.yml
index bb1b2c3..1f06a17 100644
--- a/spec/rtems/signal/if/signal-29.yml
+++ b/spec/rtems/signal/if/signal-29.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 29.
+  This signal set constant represents the bit in the signal set associated with
+  signal 29.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-30.yml b/spec/rtems/signal/if/signal-30.yml
index ac370c6..501af7d 100644
--- a/spec/rtems/signal/if/signal-30.yml
+++ b/spec/rtems/signal/if/signal-30.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 30.
+  This signal set constant represents the bit in the signal set associated with
+  signal 30.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/signal/if/signal-31.yml b/spec/rtems/signal/if/signal-31.yml
index 5571471..088be88 100644
--- a/spec/rtems/signal/if/signal-31.yml
+++ b/spec/rtems/signal/if/signal-31.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This constant defines the bit in the signal set associated with signal 31.
+  This signal set constant represents the bit in the signal set associated with
+  signal 31.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)



More information about the vc mailing list