[rtems-central commit] spec: Review directive attributes API

Sebastian Huber sebh at rtems.org
Mon Nov 9 09:49:19 UTC 2020 

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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Mon Nov  9 10:48:55 2020 +0100

spec: Review directive attributes API

---

 spec/rtems/attr/if/application-task.yml                   | 5 +++--
 spec/rtems/attr/if/attribute.yml                          | 2 +-
 spec/rtems/attr/if/barrier-automatic-release.yml          | 4 ++--
 spec/rtems/attr/if/barrier-manual-release.yml             | 4 ++--
 spec/rtems/attr/if/binary-semaphore.yml                   | 4 ++--
 spec/rtems/attr/if/counting-semaphore.yml                 | 4 ++--
 spec/rtems/attr/if/default.yml                            | 2 +-
 spec/rtems/attr/if/floating-point.yml                     | 5 +++--
 spec/rtems/attr/if/global.yml                             | 3 ++-
 spec/rtems/attr/if/header.yml                             | 2 +-
 spec/rtems/attr/if/inherit-priority.yml                   | 6 +++---
 spec/rtems/attr/if/local.yml                              | 3 ++-
 spec/rtems/attr/if/multiprocessor-resource-sharing.yml    | 7 ++++---
 spec/rtems/attr/if/no-floating-point.yml                  | 5 +++--
 spec/rtems/attr/if/no-inherit-priority.yml                | 4 ++--
 spec/rtems/attr/if/no-multiprocessor-resource-sharing.yml | 5 +++--
 spec/rtems/attr/if/no-priority-ceiling.yml                | 4 ++--
 spec/rtems/attr/if/priority-ceiling.yml                   | 6 +++---
 spec/rtems/attr/if/semaphore-class.yml                    | 5 +++--
 spec/rtems/attr/if/simple-binary-semaphore.yml            | 4 ++--
 spec/rtems/attr/if/system-task.yml                        | 5 +++--
 21 files changed, 49 insertions(+), 40 deletions(-)

diff --git a/spec/rtems/attr/if/application-task.yml b/spec/rtems/attr/if/application-task.yml
index 9cd50ec..a413ba6 100644
--- a/spec/rtems/attr/if/application-task.yml
+++ b/spec/rtems/attr/if/application-task.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant is used to indicate that the Classic API Task object
-  shall be an application task.
+  This attribute constant indicates that the Classic API task created by
+  ${../../task/if/create:/name} or ${../../task/if/construct:/name} shall be an
+  application task.
 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/attr/if/attribute.yml b/spec/rtems/attr/if/attribute.yml
index 7364556..b6b30e0 100644
--- a/spec/rtems/attr/if/attribute.yml
+++ b/spec/rtems/attr/if/attribute.yml
@@ -1,6 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This type is used to represent Classic API attributes.
+  This type represents Classic API attributes.
 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/attr/if/barrier-automatic-release.yml b/spec/rtems/attr/if/barrier-automatic-release.yml
index 187269d..1fb0f43 100644
--- a/spec/rtems/attr/if/barrier-automatic-release.yml
+++ b/spec/rtems/attr/if/barrier-automatic-release.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that a Classic API Barrier object shall use
-  the automatic release protocol.
+  This attribute constant indicates that the Classic API barrier created by
+  ${../../barrier/if/create:/name} shall use the automatic release protocol.
 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/attr/if/barrier-manual-release.yml b/spec/rtems/attr/if/barrier-manual-release.yml
index 3379973..0869a34 100644
--- a/spec/rtems/attr/if/barrier-manual-release.yml
+++ b/spec/rtems/attr/if/barrier-manual-release.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the Classic API Barrier object
-  shall use the manual release protocol.
+  This attribute constant indicates that the Classic API barrier created by
+  ${../../barrier/if/create:/name} shall use the manual release protocol.
 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/attr/if/binary-semaphore.yml b/spec/rtems/attr/if/binary-semaphore.yml
index a38a38f..57ed976 100644
--- a/spec/rtems/attr/if/binary-semaphore.yml
+++ b/spec/rtems/attr/if/binary-semaphore.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the Classic API Semaphore object shall
-  be a proper binary semaphore or mutex.
+  This attribute constant indicates that the Classic API semaphore created by
+  ${../../sem/if/create:/name} shall be a proper binary semaphore or mutex.
 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/attr/if/counting-semaphore.yml b/spec/rtems/attr/if/counting-semaphore.yml
index 68ac2fd..db74225 100644
--- a/spec/rtems/attr/if/counting-semaphore.yml
+++ b/spec/rtems/attr/if/counting-semaphore.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the Classic API Semaphore object
-  shall be a counting semaphore.
+  This attribute constant indicates that the Classic API semaphore created by
+  ${../../sem/if/create:/name} shall be a counting semaphore.
 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/attr/if/default.yml b/spec/rtems/attr/if/default.yml
index 60d6fc4..f4bd130 100644
--- a/spec/rtems/attr/if/default.yml
+++ b/spec/rtems/attr/if/default.yml
@@ -1,6 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This is the default value for an attribute set.
+  This attribute constant represents the default attribute set.
 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/attr/if/floating-point.yml b/spec/rtems/attr/if/floating-point.yml
index 4e85cfe..9a204e8 100644
--- a/spec/rtems/attr/if/floating-point.yml
+++ b/spec/rtems/attr/if/floating-point.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the task shall be able to use the
-  floating point hardware.
+  This attribute constant indicates that the Classic API task created by
+  ${../../task/if/create:/name} or ${../../task/if/construct:/name} shall be
+  able to use the floating point hardware.
 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/attr/if/global.yml b/spec/rtems/attr/if/global.yml
index dbf09ba..87d1675 100644
--- a/spec/rtems/attr/if/global.yml
+++ b/spec/rtems/attr/if/global.yml
@@ -18,5 +18,6 @@ links:
 - role: interface-ingroup
   uid: group
 name: RTEMS_GLOBAL
-notes: null
+notes: |
+  This attribute does not refer to SMP systems.
 type: interface
diff --git a/spec/rtems/attr/if/header.yml b/spec/rtems/attr/if/header.yml
index 87d563e..1103e90 100644
--- a/spec/rtems/attr/if/header.yml
+++ b/spec/rtems/attr/if/header.yml
@@ -1,6 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This header file defines attributes provided by the Classic API.
+  This header file provides Classic API directive attributes.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
diff --git a/spec/rtems/attr/if/inherit-priority.yml b/spec/rtems/attr/if/inherit-priority.yml
index 49ae3ac..9d61e2d 100644
--- a/spec/rtems/attr/if/inherit-priority.yml
+++ b/spec/rtems/attr/if/inherit-priority.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the Classic API Semaphore object shall
-  use the Priority Inheritance Protocol.
+  This attribute constant indicates that the Classic API semaphore created by
+  ${../../sem/if/create:/name} shall use the Priority Inheritance Protocol.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
@@ -19,5 +19,5 @@ links:
   uid: group
 name: RTEMS_INHERIT_PRIORITY
 notes: |
-  The semaphore object shall be a binary semaphore (${binary-semaphore:/name}).
+  The semaphore shall be a binary semaphore (${binary-semaphore:/name}).
 type: interface
diff --git a/spec/rtems/attr/if/local.yml b/spec/rtems/attr/if/local.yml
index 857b1e4..e8b7005 100644
--- a/spec/rtems/attr/if/local.yml
+++ b/spec/rtems/attr/if/local.yml
@@ -18,5 +18,6 @@ links:
 - role: interface-ingroup
   uid: group
 name: RTEMS_LOCAL
-notes: null
+notes: |
+  This attribute does not refer to SMP systems.
 type: interface
diff --git a/spec/rtems/attr/if/multiprocessor-resource-sharing.yml b/spec/rtems/attr/if/multiprocessor-resource-sharing.yml
index 696fc2a..bfed6d3 100644
--- a/spec/rtems/attr/if/multiprocessor-resource-sharing.yml
+++ b/spec/rtems/attr/if/multiprocessor-resource-sharing.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the Classic API Semaphore object shall
-  use the Multiprocessor Resource Sharing Protocol.
+  This attribute constant indicates that the Classic API semaphore created by
+  ${../../sem/if/create:/name} shall use the Multiprocessor Resource Sharing
+  Protocol.
 copyrights:
 - Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
 definition:
@@ -18,5 +19,5 @@ links:
   uid: group
 name: RTEMS_MULTIPROCESSOR_RESOURCE_SHARING
 notes: |
-  The semaphore object shall be a binary semaphore (${binary-semaphore:/name}).
+  The semaphore shall be a binary semaphore (${binary-semaphore:/name}).
 type: interface
diff --git a/spec/rtems/attr/if/no-floating-point.yml b/spec/rtems/attr/if/no-floating-point.yml
index 249829d..8b85b3f 100644
--- a/spec/rtems/attr/if/no-floating-point.yml
+++ b/spec/rtems/attr/if/no-floating-point.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the task will not use the floating
-  point hardware.
+  This attribute constant indicates that the Classic API task created by
+  ${../../task/if/create:/name} or ${../../task/if/construct:/name} will not
+  use the floating point hardware.
 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/attr/if/no-inherit-priority.yml b/spec/rtems/attr/if/no-inherit-priority.yml
index 11fdc88..d9b37ff 100644
--- a/spec/rtems/attr/if/no-inherit-priority.yml
+++ b/spec/rtems/attr/if/no-inherit-priority.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the Classic API Semaphore object
-  will not use the Priority Inheritance Protocol.
+  This attribute constant indicates that the Classic API semaphore created by
+  ${../../sem/if/create:/name} will not use the Priority Inheritance Protocol.
 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/attr/if/no-multiprocessor-resource-sharing.yml b/spec/rtems/attr/if/no-multiprocessor-resource-sharing.yml
index b8c2c21..a9de985 100644
--- a/spec/rtems/attr/if/no-multiprocessor-resource-sharing.yml
+++ b/spec/rtems/attr/if/no-multiprocessor-resource-sharing.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the Classic API Semaphore object will
-  not use the Multiprocessor Resource Sharing Protocol.
+  This attribute constant indicates that the Classic API semaphore created by
+  ${../../sem/if/create:/name} will not use the Multiprocessor Resource Sharing
+  Protocol.
 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/attr/if/no-priority-ceiling.yml b/spec/rtems/attr/if/no-priority-ceiling.yml
index 2c0dbb8..7bd065c 100644
--- a/spec/rtems/attr/if/no-priority-ceiling.yml
+++ b/spec/rtems/attr/if/no-priority-ceiling.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the Classic API Semaphore object will
-  not use the Priority Ceiling Protocol.
+  This attribute constant indicates that the Classic API semaphore created by
+  ${../../sem/if/create:/name} will not use the Priority Ceiling Protocol.
 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/attr/if/priority-ceiling.yml b/spec/rtems/attr/if/priority-ceiling.yml
index f42524f..53b0101 100644
--- a/spec/rtems/attr/if/priority-ceiling.yml
+++ b/spec/rtems/attr/if/priority-ceiling.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the Classic API Semaphore object shall
-  use the Priority Ceiling Protocol.
+  This attribute constant indicates that the Classic API semaphore created by
+  ${../../sem/if/create:/name} shall use the Priority Ceiling Protocol.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
@@ -19,5 +19,5 @@ links:
   uid: group
 name: RTEMS_PRIORITY_CEILING
 notes: |
-  The semaphore object shall be a binary semaphore (${binary-semaphore:/name}).
+  The semaphore shall be a binary semaphore (${binary-semaphore:/name}).
 type: interface
diff --git a/spec/rtems/attr/if/semaphore-class.yml b/spec/rtems/attr/if/semaphore-class.yml
index 0931243..373f814 100644
--- a/spec/rtems/attr/if/semaphore-class.yml
+++ b/spec/rtems/attr/if/semaphore-class.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This is the mask for the attribute bits associated with the Classic API
-  Semaphore Manager.
+  This attribute constant represents the mask of bits associated with the
+  Classic API semaphore classes ${binary-semaphore:/name},
+  ${counting-semaphore:/name}, and ${simple-binary-semaphore:/name}.
 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/attr/if/simple-binary-semaphore.yml b/spec/rtems/attr/if/simple-binary-semaphore.yml
index 8a2536c..a3906df 100644
--- a/spec/rtems/attr/if/simple-binary-semaphore.yml
+++ b/spec/rtems/attr/if/simple-binary-semaphore.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the Classic API Semaphore object shall
-  be a simple binary semaphore.
+  This attribute constant indicates that the Classic API semaphore created by
+  ${../../sem/if/create:/name} shall be a simple binary semaphore.
 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/attr/if/system-task.yml b/spec/rtems/attr/if/system-task.yml
index bc4665e..2db25a1 100644
--- a/spec/rtems/attr/if/system-task.yml
+++ b/spec/rtems/attr/if/system-task.yml
@@ -1,7 +1,8 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant is used to indicate that the Classic API Task object
-  shall be a system task.
+  This attribute constant indicates that the Classic API task created by
+  ${../../task/if/create:/name} or ${../../task/if/construct:/name} shall be a
+  system task.
 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