[rtems-central commit] spec: Review attributes

Sebastian Huber sebh at rtems.org
Fri Sep 25 15:28:32 UTC 2020 

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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Fri Sep 25 17:27:05 2020 +0200

spec: Review attributes

---

 spec/rtems/attr/if/application-task.yml                   | 4 ++--
 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/fifo.yml                               | 4 ++--
 spec/rtems/attr/if/floating-point.yml                     | 4 ++--
 spec/rtems/attr/if/global.yml                             | 3 ++-
 spec/rtems/attr/if/header.yml                             | 3 ++-
 spec/rtems/attr/if/inherit-priority.yml                   | 6 +++---
 spec/rtems/attr/if/local.yml                              | 3 ++-
 spec/rtems/attr/if/multiprocessor-resource-sharing.yml    | 6 +++---
 spec/rtems/attr/if/no-inherit-priority.yml                | 4 ++--
 spec/rtems/attr/if/no-multiprocessor-resource-sharing.yml | 4 ++--
 spec/rtems/attr/if/no-priority-ceiling.yml                | 4 ++--
 spec/rtems/attr/if/priority-ceiling.yml                   | 6 +++---
 spec/rtems/attr/if/priority.yml                           | 4 ++--
 spec/rtems/attr/if/simple-binary-semaphore.yml            | 4 ++--
 spec/rtems/attr/if/system-task.yml                        | 4 ++--
 19 files changed, 41 insertions(+), 38 deletions(-)

diff --git a/spec/rtems/attr/if/application-task.yml b/spec/rtems/attr/if/application-task.yml
index b33293e..930e281 100644
--- a/spec/rtems/attr/if/application-task.yml
+++ b/spec/rtems/attr/if/application-task.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the task was created by the
-  application using normal Classic API methods.
+  This attribute constant is used to indicate that the Classic API Task object
+  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/barrier-automatic-release.yml b/spec/rtems/attr/if/barrier-automatic-release.yml
index f60760d..e0aed7e 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 the Classic API Barrier instance
-  created will use an automatic release protocol.
+  This attribute constant indicates that a Classic API Barrier object 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 27c3d02..ab08407 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 instance
-  created will use the manual release protocol.
+  This attribute constant indicates that the Classic API Barrier object
+  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 f994060..1faa03a 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 instance
-  created will be a proper binary semaphore or mutex.
+  This attribute constant indicates that the Classic API Semaphore object 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 9d7c69a..cf25f85 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 instance
-  created will be a counting semaphore.
+  This attribute constant indicates that the Classic API Semaphore object
+  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/fifo.yml b/spec/rtems/attr/if/fifo.yml
index 4df3d6e..5724d40 100644
--- a/spec/rtems/attr/if/fifo.yml
+++ b/spec/rtems/attr/if/fifo.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This is the attribute constant which reflects that blocking tasks will be
-  managed using FIFO discipline.
+  This attribute constant indicates that the Classic API object shall manage
+  blocking tasks using the FIFO discipline.
 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 40b8ea9..5e3fba6 100644
--- a/spec/rtems/attr/if/floating-point.yml
+++ b/spec/rtems/attr/if/floating-point.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the task will use the floating point
-  hardware.
+  This attribute constant indicates that the task 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 a88b886..acff0c6 100644
--- a/spec/rtems/attr/if/global.yml
+++ b/spec/rtems/attr/if/global.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This is the attribute constant to indicate global resource.
+  This attribute constant indicates that the Classic API object shall be a
+  global resource in a multiprocessing network.
 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/header.yml b/spec/rtems/attr/if/header.yml
index ae4340e..52fb64b 100644
--- a/spec/rtems/attr/if/header.yml
+++ b/spec/rtems/attr/if/header.yml
@@ -1,5 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: This header file defines attributes provided by the API.
+brief: |
+  This header file defines attributes provided by the Classic API.
 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 161472d..07fcd37 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 instance
-  created will use the Priority Inheritance Protocol.
+  This attribute constant indicates that the Classic API Semaphore object 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)
@@ -18,5 +18,5 @@ links:
   uid: group
 name: RTEMS_INHERIT_PRIORITY
 notes: |
-  The semaphore instance must be a binary semaphore.
+  The semaphore object 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 9147f3c..12bc9b0 100644
--- a/spec/rtems/attr/if/local.yml
+++ b/spec/rtems/attr/if/local.yml
@@ -1,6 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This is the attribute constant to indicate local resource.
+  This attribute constant indicates that the Classic API object shall be a
+  local resource in a multiprocessing network.
 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/multiprocessor-resource-sharing.yml b/spec/rtems/attr/if/multiprocessor-resource-sharing.yml
index 3cb4c0c..8c9f3fa 100644
--- a/spec/rtems/attr/if/multiprocessor-resource-sharing.yml
+++ b/spec/rtems/attr/if/multiprocessor-resource-sharing.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 instance
-  created will use the Multiprocessor Resource Sharing Protocol.
+  This attribute constant indicates that the Classic API Semaphore object shall
+  use the Multiprocessor Resource Sharing Protocol.
 copyrights:
 - Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
 definition:
@@ -17,5 +17,5 @@ links:
   uid: group
 name: RTEMS_MULTIPROCESSOR_RESOURCE_SHARING
 notes: |
-  The semaphore instance must be a binary semaphore.
+  The semaphore object shall be a binary semaphore (${binary-semaphore:/name}).
 type: interface
diff --git a/spec/rtems/attr/if/no-inherit-priority.yml b/spec/rtems/attr/if/no-inherit-priority.yml
index c3d8656..4ee7825 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 instance
-  created will not use the Priority Inheritance Protocol.
+  This attribute constant indicates that the Classic API Semaphore object
+  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 050627d..c4c2ab9 100644
--- a/spec/rtems/attr/if/no-multiprocessor-resource-sharing.yml
+++ b/spec/rtems/attr/if/no-multiprocessor-resource-sharing.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 instance
-  created will not use the Multiprocessor Resource Sharing Protocol.
+  This attribute constant indicates that the Classic API Semaphore object 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 ee71f3f..29dd88f 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 instance
-  created will not use the Priority Ceiling Protocol.
+  This attribute constant indicates that the Classic API Semaphore object 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 c5e8ba7..576efe0 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 instance
-  created will use the Priority Ceiling Protocol.
+  This attribute constant indicates that the Classic API Semaphore object 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)
@@ -18,5 +18,5 @@ links:
   uid: group
 name: RTEMS_PRIORITY_CEILING
 notes: |
-  The semaphore instance must be a binary semaphore.
+  The semaphore object shall be a binary semaphore (${binary-semaphore:/name}).
 type: interface
diff --git a/spec/rtems/attr/if/priority.yml b/spec/rtems/attr/if/priority.yml
index 363b548..eeca081 100644
--- a/spec/rtems/attr/if/priority.yml
+++ b/spec/rtems/attr/if/priority.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This is the attribute constant which reflects that blocking tasks will be
-  managed using task priority discipline.
+  This attribute constant indicates that the Classic API object shall manage
+  blocking tasks using the task priority discipline.
 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 4853914..ff0434f 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 instance
-  created will be a simple binary semaphore.
+  This attribute constant indicates that the Classic API Semaphore object 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 f3e775c..cdc9e16 100644
--- a/spec/rtems/attr/if/system-task.yml
+++ b/spec/rtems/attr/if/system-task.yml
@@ -1,7 +1,7 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This attribute constant indicates that the task was created by RTEMS as a
-  support task.
+  This attribute constant is used to indicate that the Classic API Task object
+  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