[rtems-central commit] spec: Review types

[Sebastian Huber]

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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Fri Sep 25 19:46:30 2020 +0200

spec: Review types

---

 spec/rtems/type/if/header.yml      | 3 ++-
 spec/rtems/type/if/id-none.yml     | 4 ++--
 spec/rtems/type/if/id.yml          | 2 +-
 spec/rtems/type/if/mpci-entry.yml  | 2 +-
 spec/rtems/type/if/name.yml        | 2 +-
 spec/rtems/type/if/no-timeout.yml  | 5 +++--
 spec/rtems/type/if/time-of-day.yml | 2 +-
 7 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/spec/rtems/type/if/header.yml b/spec/rtems/type/if/header.yml
index c7427c7..3f2f69f 100644
--- a/spec/rtems/type/if/header.yml
+++ b/spec/rtems/type/if/header.yml
@@ -1,5 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: This header file defines types provided by the API.
+brief: |
+  This header file defines types 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/type/if/id-none.yml b/spec/rtems/type/if/id-none.yml
index 30f7e94..12fa38d 100644
--- a/spec/rtems/type/if/id-none.yml
+++ b/spec/rtems/type/if/id-none.yml
@@ -1,13 +1,13 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This is an invalid object identifier.
+  This constant represents an invalid RTEMS object identifier.
 copyrights:
 - Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de)
 definition:
   default: ${/score/object/if/id-none:/name}
   variants: []
 description: |
-  No object can have this identifier.
+  No RTEMS object can have this identifier.
 enabled-by: true
 interface-type: define
 links:
diff --git a/spec/rtems/type/if/id.yml b/spec/rtems/type/if/id.yml
index f342a3d..625a11f 100644
--- a/spec/rtems/type/if/id.yml
+++ b/spec/rtems/type/if/id.yml
@@ -1,6 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  Values of this type identify an object.
+  Values of this type identify an RTEMS object.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 definition:
diff --git a/spec/rtems/type/if/mpci-entry.yml b/spec/rtems/type/if/mpci-entry.yml
index 79c8119..9f46c49 100644
--- a/spec/rtems/type/if/mpci-entry.yml
+++ b/spec/rtems/type/if/mpci-entry.yml
@@ -1,6 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  Return type of every MPCI handler routine.
+  Every MPCI handler routine shall have this return type.
 copyrights:
 - Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/rtems/type/if/name.yml b/spec/rtems/type/if/name.yml
index e55d9ee..9e2bf30 100644
--- a/spec/rtems/type/if/name.yml
+++ b/spec/rtems/type/if/name.yml
@@ -1,6 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  This type is used to represent an Classic API object name.
+  This type is used to represent a Classic API object name.
 copyrights:
 - Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de)
 definition:
diff --git a/spec/rtems/type/if/no-timeout.yml b/spec/rtems/type/if/no-timeout.yml
index 9e5ff7b..a81b889 100644
--- a/spec/rtems/type/if/no-timeout.yml
+++ b/spec/rtems/type/if/no-timeout.yml
@@ -1,8 +1,9 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+  This clock tick interval constant indicates that the calling task is willing
+  to wait potentially forever on a resource.
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 definition:
   default: |
     ( (${interval:/name}) ${/score/watchdog/if/no-timeout:/name} )
diff --git a/spec/rtems/type/if/time-of-day.yml b/spec/rtems/type/if/time-of-day.yml
index 5fb8f8c..54534dc 100644
--- a/spec/rtems/type/if/time-of-day.yml
+++ b/spec/rtems/type/if/time-of-day.yml
@@ -55,7 +55,7 @@ definition:
 - default:
     brief: |
       This member represents the clock tick of the second with values from 0 to
-      rtems_clock_get_ticks_per_second() minus one.
+      ${../../clock/if/get-ticks-per-second:/name} minus one.
     definition: ${/c/if/uint32_t:/name} ${.:name}
     description: null
     kind: member