spec: Review attributes

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 b33293e2..930e2817 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 f60760d0..e0aed7e6 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 27c3d02b..ab084073 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 f994060e..1faa03a3 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 9d7c69ad..cf25f850 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 4df3d6e7..5724d408 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 40b8ea94..5e3fba67 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 a88b886c..acff0c6b 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 ae4340e8..52fb64b6 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 161472d2..07fcd370 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 9147f3cf..12bc9b05 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 3cb4c0c6..8c9f3fa4 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 c3d8656f..4ee7825e 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 050627d5..c4c2ab91 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 ee71f3f3..29dd88f8 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 c5e8ba7b..576efe0b 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 363b548c..eeca081e 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 4853914e..ff0434f4 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 f3e775ca..cdc9e169 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)