summaryrefslogtreecommitdiff
path: root/spec/if/rtems
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-08-19 10:18:31 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-08-19 11:29:34 +0200
commit6df984ee5fce8a09f3e98b8bc31268b2fcfa1408 (patch)
tree391f3f9d4fd4293cce66fe336f33b06feddfa4b4 /spec/if/rtems
parent4e31483f9c7be725d045f77cae076598ba574bb3 (diff)
spec: Fix item format
Diffstat (limited to 'spec/if/rtems')
-rw-r--r--spec/if/rtems/barrier/group.yml2
-rw-r--r--spec/if/rtems/clock/tick-before.yml4
-rw-r--r--spec/if/rtems/clock/tick-later-usec.yml2
-rw-r--r--spec/if/rtems/clock/tick-later.yml2
-rw-r--r--spec/if/rtems/event/send.yml2
-rw-r--r--spec/if/rtems/event/system-server-resume.yml2
-rw-r--r--spec/if/rtems/event/system-server.yml2
-rw-r--r--spec/if/rtems/event/system-transient.yml2
-rw-r--r--spec/if/rtems/fatal/panic.yml7
-rw-r--r--spec/if/rtems/intr/lock-reference.yml3
-rw-r--r--spec/if/rtems/object/get-local-node.yml23
-rw-r--r--spec/if/rtems/options/no-wait.yml2
-rw-r--r--spec/if/rtems/ratemon/period-status-define.yml4
-rw-r--r--spec/if/rtems/scheduler/get-processor-maximum.yml2
-rw-r--r--spec/if/rtems/timer/service-routine-entry.yml3
15 files changed, 21 insertions, 41 deletions
diff --git a/spec/if/rtems/barrier/group.yml b/spec/if/rtems/barrier/group.yml
index 9b380543..514dacea 100644
--- a/spec/if/rtems/barrier/group.yml
+++ b/spec/if/rtems/barrier/group.yml
@@ -14,7 +14,7 @@ links:
uid: header
- role: interface-ingroup
uid: ../group
+name: Barrier Manager
text: |
The Classic API shall provide an interface to the Barrier Manager.
-name: Barrier Manager
type: interface
diff --git a/spec/if/rtems/clock/tick-before.yml b/spec/if/rtems/clock/tick-before.yml
index 2abb099f..ef7c69f4 100644
--- a/spec/if/rtems/clock/tick-before.yml
+++ b/spec/if/rtems/clock/tick-before.yml
@@ -33,8 +33,8 @@ return:
- description: |
The current ticks counter value indicates a time before the time
specified by the tick value.
- value: "true"
+ value: 'true'
- description: |
Otherwise.
- value: "false"
+ value: 'false'
type: interface
diff --git a/spec/if/rtems/clock/tick-later-usec.yml b/spec/if/rtems/clock/tick-later-usec.yml
index a5a8beca..acb88950 100644
--- a/spec/if/rtems/clock/tick-later-usec.yml
+++ b/spec/if/rtems/clock/tick-later-usec.yml
@@ -36,6 +36,6 @@ params:
name: delta_in_usec
return:
return: |
- The tick counter value delta ticks in the future is returned.
+ The tick counter value delta ticks in the future is returned.
return-values: []
type: interface
diff --git a/spec/if/rtems/clock/tick-later.yml b/spec/if/rtems/clock/tick-later.yml
index b850f9de..5f56a066 100644
--- a/spec/if/rtems/clock/tick-later.yml
+++ b/spec/if/rtems/clock/tick-later.yml
@@ -27,6 +27,6 @@ params:
name: delta
return:
return: |
- The tick counter value delta ticks in the future is returned.
+ The tick counter value delta ticks in the future is returned.
return-values: []
type: interface
diff --git a/spec/if/rtems/event/send.yml b/spec/if/rtems/event/send.yml
index e7f5609a..679a7719 100644
--- a/spec/if/rtems/event/send.yml
+++ b/spec/if/rtems/event/send.yml
@@ -36,7 +36,7 @@ links:
uid: group
name: rtems_event_send
notes: |
- Events can be sent by tasks or an ${/glossary/isr:/term}.
+ Events can be sent by tasks or an ${/glossary/isr:/term}.
Specifying ${../tasks/self-define:/name} for ``${.:/params[0]/name}`` results
in the event set being sent to the calling task.
diff --git a/spec/if/rtems/event/system-server-resume.yml b/spec/if/rtems/event/system-server-resume.yml
index 2aec771c..83217d87 100644
--- a/spec/if/rtems/event/system-server-resume.yml
+++ b/spec/if/rtems/event/system-server-resume.yml
@@ -6,7 +6,7 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
- default: '${event-29:/name}'
+ default: ${event-29:/name}
variants: []
description: null
enabled-by: true
diff --git a/spec/if/rtems/event/system-server.yml b/spec/if/rtems/event/system-server.yml
index b4300340..e628d449 100644
--- a/spec/if/rtems/event/system-server.yml
+++ b/spec/if/rtems/event/system-server.yml
@@ -6,7 +6,7 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
- default: '${event-30:/name}'
+ default: ${event-30:/name}
variants: []
description: null
enabled-by: true
diff --git a/spec/if/rtems/event/system-transient.yml b/spec/if/rtems/event/system-transient.yml
index 94c618c0..a1b4b9e2 100644
--- a/spec/if/rtems/event/system-transient.yml
+++ b/spec/if/rtems/event/system-transient.yml
@@ -5,7 +5,7 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
- default: '${event-31:/name}'
+ default: ${event-31:/name}
variants: []
description: null
enabled-by: true
diff --git a/spec/if/rtems/fatal/panic.yml b/spec/if/rtems/fatal/panic.yml
index 255b46ed..2a119147 100644
--- a/spec/if/rtems/fatal/panic.yml
+++ b/spec/if/rtems/fatal/panic.yml
@@ -8,8 +8,9 @@ definition:
body: null
params:
- const char *${.:/params[0]/name}
- - ...
- return: ${../basedefs/no-return:/name} ${../basedefs/printflike:/name}( 1, 2 ) void
+ - '...'
+ return: |
+ ${../basedefs/no-return:/name} ${../basedefs/printflike:/name}( 1, 2 ) void
variants: []
description: null
enabled-by: true
@@ -27,7 +28,7 @@ params:
name: fmt
- description: '%'
dir: null
- name: ...
+ name: '...'
return:
return: null
return-values: []
diff --git a/spec/if/rtems/intr/lock-reference.yml b/spec/if/rtems/intr/lock-reference.yml
index 502233b3..5e1f6b96 100644
--- a/spec/if/rtems/intr/lock-reference.yml
+++ b/spec/if/rtems/intr/lock-reference.yml
@@ -4,7 +4,8 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
- default: ${/if/impl/isr/lock-reference:/name}( ${.:/params[0]/name}, ${.:/params[1]/name} )
+ default: |
+ ${/if/impl/isr/lock-reference:/name}( ${.:/params[0]/name}, ${.:/params[1]/name} )
variants: []
description: null
enabled-by: true
diff --git a/spec/if/rtems/object/get-local-node.yml b/spec/if/rtems/object/get-local-node.yml
index 8602257e..1c6dcf87 100644
--- a/spec/if/rtems/object/get-local-node.yml
+++ b/spec/if/rtems/object/get-local-node.yml
@@ -2,29 +2,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: '%'
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-definition:
- default: ${/if/impl/object/local-node:/name}
- variants: []
-description: null
-enabled-by: true
-interface-type: macro
-links:
-- role: interface-placement
- uid: header
-- role: interface-ingroup
- uid: group
-name: rtems_object_get_local_node
-notes: null
-params: []
-return:
- return: null
- return-values: []
-type: interface
-SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
definition:
default:
diff --git a/spec/if/rtems/options/no-wait.yml b/spec/if/rtems/options/no-wait.yml
index 6fbe7a20..504128c5 100644
--- a/spec/if/rtems/options/no-wait.yml
+++ b/spec/if/rtems/options/no-wait.yml
@@ -7,7 +7,7 @@ copyrights:
definition:
default: '0x00000001'
variants: []
-description: null
+description: |
If the resource is not available, then directives shall return immediately
with a status to indicate unsatisfied.
enabled-by: true
diff --git a/spec/if/rtems/ratemon/period-status-define.yml b/spec/if/rtems/ratemon/period-status-define.yml
index 20de9dbc..adebb068 100644
--- a/spec/if/rtems/ratemon/period-status-define.yml
+++ b/spec/if/rtems/ratemon/period-status-define.yml
@@ -1,7 +1,7 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This constant is the interval passed to the ${period:/name} directive to
- obtain status information.
+ This constant is the interval passed to the ${period:/name} directive to
+ obtain status information.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
diff --git a/spec/if/rtems/scheduler/get-processor-maximum.yml b/spec/if/rtems/scheduler/get-processor-maximum.yml
index 6ab52a55..3c9f6ae4 100644
--- a/spec/if/rtems/scheduler/get-processor-maximum.yml
+++ b/spec/if/rtems/scheduler/get-processor-maximum.yml
@@ -9,7 +9,7 @@ definition:
description: |
In uniprocessor configurations, this macro evaluates to a compile time
constant of one.
-
+
In SMP configurations, this macro returns the minimum of the processors
(physically or virtually) available by the platform and the configured
processor maximum. Not all processors in the range from processor index zero
diff --git a/spec/if/rtems/timer/service-routine-entry.yml b/spec/if/rtems/timer/service-routine-entry.yml
index 4e4fd04e..580f86c5 100644
--- a/spec/if/rtems/timer/service-routine-entry.yml
+++ b/spec/if/rtems/timer/service-routine-entry.yml
@@ -4,7 +4,8 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
- default: ${service-routine:/name} ( *${.:/name} )( ${../types/id:/name}, void * )
+ default: |
+ ${service-routine:/name} ( *${.:/name} )( ${../types/id:/name}, void * )
variants: []
description: null
enabled-by: true