From d9e901c080a137e43b8e246eba9a5a3a2c8867a9 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Mon, 9 Nov 2020 09:50:45 +0100 Subject: spec: Review the Classic API types --- spec/rtems/type/if/group.yml | 2 +- spec/rtems/type/if/header.yml | 2 +- spec/rtems/type/if/id.yml | 2 +- spec/rtems/type/if/interval.yml | 2 +- spec/rtems/type/if/mp-packet-classes.yml | 2 +- spec/rtems/type/if/mpci-entry.yml | 2 +- spec/rtems/type/if/mpci-get-packet-entry.yml | 2 +- spec/rtems/type/if/mpci-initialization-entry.yml | 3 +-- spec/rtems/type/if/mpci-receive-packet-entry.yml | 3 +-- spec/rtems/type/if/mpci-return-packet-entry.yml | 2 +- spec/rtems/type/if/mpci-send-packet-entry.yml | 2 +- spec/rtems/type/if/mpci-table.yml | 2 +- spec/rtems/type/if/multiprocessing-table.yml | 2 +- spec/rtems/type/if/name.yml | 6 +++--- spec/rtems/type/if/packet-prefix.yml | 4 ++-- spec/rtems/type/if/time-of-day.yml | 16 ++++++++-------- 16 files changed, 26 insertions(+), 28 deletions(-) diff --git a/spec/rtems/type/if/group.yml b/spec/rtems/type/if/group.yml index af96a4c1..15afdb7e 100644 --- a/spec/rtems/type/if/group.yml +++ b/spec/rtems/type/if/group.yml @@ -1,6 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This group contains basic types of the Classic API. + This group contains basic Classic API types. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) description: null diff --git a/spec/rtems/type/if/header.yml b/spec/rtems/type/if/header.yml index 7b326e76..23691a1e 100644 --- a/spec/rtems/type/if/header.yml +++ b/spec/rtems/type/if/header.yml @@ -1,6 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This header file defines types provided by the Classic API. + This header file provides types used 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.yml b/spec/rtems/type/if/id.yml index f0f68bde..474dccc7 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 RTEMS object. + This type represents RTEMS object identifiers. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) definition: diff --git a/spec/rtems/type/if/interval.yml b/spec/rtems/type/if/interval.yml index 26897081..bb53b980 100644 --- a/spec/rtems/type/if/interval.yml +++ b/spec/rtems/type/if/interval.yml @@ -1,6 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This type is used to represent clock tick intervals. + This type represents clock tick intervals. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) definition: diff --git a/spec/rtems/type/if/mp-packet-classes.yml b/spec/rtems/type/if/mp-packet-classes.yml index 6ca817bb..82ba1ceb 100644 --- a/spec/rtems/type/if/mp-packet-classes.yml +++ b/spec/rtems/type/if/mp-packet-classes.yml @@ -1,6 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This enumerated type defines the packet classes. + This enumeration defines the MPCI packet classes. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2006 On-Line Applications Research Corporation (OAR) diff --git a/spec/rtems/type/if/mpci-entry.yml b/spec/rtems/type/if/mpci-entry.yml index bc24b1ba..91279ee7 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: | - Every MPCI handler routine shall have this return type. + MPCI handler routines 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/mpci-get-packet-entry.yml b/spec/rtems/type/if/mpci-get-packet-entry.yml index ee6f04e1..6df98dd2 100644 --- a/spec/rtems/type/if/mpci-get-packet-entry.yml +++ b/spec/rtems/type/if/mpci-get-packet-entry.yml @@ -1,6 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This type defines the prototype for the get packet entry point in an MPCI. + MPCI get packet routines shall have this type. copyrights: - Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2006 On-Line Applications Research Corporation (OAR) diff --git a/spec/rtems/type/if/mpci-initialization-entry.yml b/spec/rtems/type/if/mpci-initialization-entry.yml index f70cbaf6..169de42d 100644 --- a/spec/rtems/type/if/mpci-initialization-entry.yml +++ b/spec/rtems/type/if/mpci-initialization-entry.yml @@ -1,7 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This type defines the prototype for the initialization entry point in an - MPCI. + MPCI initialization routines shall have this type. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2006 On-Line Applications Research Corporation (OAR) diff --git a/spec/rtems/type/if/mpci-receive-packet-entry.yml b/spec/rtems/type/if/mpci-receive-packet-entry.yml index 744aa0f8..a748dc14 100644 --- a/spec/rtems/type/if/mpci-receive-packet-entry.yml +++ b/spec/rtems/type/if/mpci-receive-packet-entry.yml @@ -1,7 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This type defines the prototype for the receive packet entry point in an - MPCI. + MPCI receive packet routines shall have this type. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2006 On-Line Applications Research Corporation (OAR) diff --git a/spec/rtems/type/if/mpci-return-packet-entry.yml b/spec/rtems/type/if/mpci-return-packet-entry.yml index 503a105f..f6f68dbf 100644 --- a/spec/rtems/type/if/mpci-return-packet-entry.yml +++ b/spec/rtems/type/if/mpci-return-packet-entry.yml @@ -1,6 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This type defines the prototype for the return packet entry point in an MPCI. + MPCI return packet routines shall have this type. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) - Copyright (C) 2006 On-Line Applications Research Corporation (OAR) diff --git a/spec/rtems/type/if/mpci-send-packet-entry.yml b/spec/rtems/type/if/mpci-send-packet-entry.yml index b1afebf2..f8dfd61f 100644 --- a/spec/rtems/type/if/mpci-send-packet-entry.yml +++ b/spec/rtems/type/if/mpci-send-packet-entry.yml @@ -1,6 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This type defines the prototype for the send packet entry point in an MPCI. + MPCI send packet routines shall have this type. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) definition: diff --git a/spec/rtems/type/if/mpci-table.yml b/spec/rtems/type/if/mpci-table.yml index 3a039c2f..10ba1248 100644 --- a/spec/rtems/type/if/mpci-table.yml +++ b/spec/rtems/type/if/mpci-table.yml @@ -1,6 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This type defines the MPCI control. + This type represents the user-provided MPCI control. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) definition: diff --git a/spec/rtems/type/if/multiprocessing-table.yml b/spec/rtems/type/if/multiprocessing-table.yml index fba79669..7936e189 100644 --- a/spec/rtems/type/if/multiprocessing-table.yml +++ b/spec/rtems/type/if/multiprocessing-table.yml @@ -1,6 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This type defines the MPCI configuration table. + This type represents the user-provided MPCI configuration. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) definition: diff --git a/spec/rtems/type/if/name.yml b/spec/rtems/type/if/name.yml index 31e69752..1af51e38 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 a Classic API object name. + This type represents Classic API object names. copyrights: - Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de) definition: @@ -8,8 +8,8 @@ definition: variants: [] description: | It is an unsigned 32-bit integer which can be treated as a numeric value or - initialized using rtems_build_name() to encode four ASCII characters. A - value of zero may have a special meaning in some directives. + initialized using ${../../object/if/build-name:/name} to encode four ASCII + characters. A value of zero may have a special meaning in some directives. enabled-by: true index-entries: [] interface-type: typedef diff --git a/spec/rtems/type/if/packet-prefix.yml b/spec/rtems/type/if/packet-prefix.yml index 7c681364..e02a57f3 100644 --- a/spec/rtems/type/if/packet-prefix.yml +++ b/spec/rtems/type/if/packet-prefix.yml @@ -1,7 +1,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This type defines the prefix found at the beginning of each MPCI packet sent - between nodes. + This type represents the prefix found at the beginning of each MPCI packet + sent between nodes. copyrights: - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) definition: diff --git a/spec/rtems/type/if/time-of-day.yml b/spec/rtems/type/if/time-of-day.yml index 2458b2e7..40e9d41f 100644 --- a/spec/rtems/type/if/time-of-day.yml +++ b/spec/rtems/type/if/time-of-day.yml @@ -1,12 +1,12 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - This type is used to represent the calendar time in the Classic API. + This type represents Classic API calendar times. copyrights: - Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de) definition: - default: brief: | - This member represents the year A.D. + This member contains the year A.D. definition: ${/c/if/uint32_t:/name} ${.:name} description: null kind: member @@ -14,7 +14,7 @@ definition: variants: [] - default: brief: | - This member represents the month of the year with values from 1 to 12. + This member contains the month of the year with values from 1 to 12. definition: ${/c/if/uint32_t:/name} ${.:name} description: null kind: member @@ -22,7 +22,7 @@ definition: variants: [] - default: brief: | - This member represents the day of the month with values from 1 to 31. + This member contains the day of the month with values from 1 to 31. definition: ${/c/if/uint32_t:/name} ${.:name} description: null kind: member @@ -30,7 +30,7 @@ definition: variants: [] - default: brief: | - This member represents the hour of the day with values from 0 to 23. + This member contains the hour of the day with values from 0 to 23. definition: ${/c/if/uint32_t:/name} ${.:name} description: null kind: member @@ -38,7 +38,7 @@ definition: variants: [] - default: brief: | - This member represents the minute of the hour with values from 0 to 59. + This member contains the minute of the hour with values from 0 to 59. definition: ${/c/if/uint32_t:/name} ${.:name} description: null kind: member @@ -46,7 +46,7 @@ definition: variants: [] - default: brief: | - This member represents the second of the minute with values from 0 to 59. + This member contains the second of the minute with values from 0 to 59. definition: ${/c/if/uint32_t:/name} ${.:name} description: null kind: member @@ -54,7 +54,7 @@ definition: variants: [] - default: brief: | - This member represents the clock tick of the second with values from 0 to + This member contains the clock tick of the second with values from 0 to ${../../clock/if/get-ticks-per-second:/name} minus one. definition: ${/c/if/uint32_t:/name} ${.:name} description: null -- cgit v1.2.3