[rtems-central commit] spec: Fix clock manager parameter names

Sebastian Huber sebh at rtems.org
Wed Feb 17 19:24:03 UTC 2021


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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed Feb 17 20:23:13 2021 +0100

spec: Fix clock manager parameter names

---

 spec/rtems/clock/if/get-tod-timeval.yml | 2 +-
 spec/rtems/clock/if/set.yml             | 8 ++++----
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/spec/rtems/clock/if/get-tod-timeval.yml b/spec/rtems/clock/if/get-tod-timeval.yml
index 5b96c2a..01000b0 100644
--- a/spec/rtems/clock/if/get-tod-timeval.yml
+++ b/spec/rtems/clock/if/get-tod-timeval.yml
@@ -38,7 +38,7 @@ params:
     ${/glossary/unix-epoch:/term} and the ${/glossary/clock-realtime:/term} at
     some point during the directive call will be stored in this variable.
   dir: out
-  name: time
+  name: time_of_day
 return:
   return: null
   return-values:
diff --git a/spec/rtems/clock/if/set.yml b/spec/rtems/clock/if/set.yml
index e92167a..14e855e 100644
--- a/spec/rtems/clock/if/set.yml
+++ b/spec/rtems/clock/if/set.yml
@@ -1,6 +1,6 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
 brief: |
-  Sets the ${/glossary/clock-realtime:/term} to the time.
+  Sets the ${/glossary/clock-realtime:/term} to the time of day.
 copyrights:
 - Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
@@ -56,9 +56,9 @@ notes: |
     set at least once, they may return an error status.
 params:
 - description: |
-    is the time to set the clock.
+    is the time of day to set the clock.
   dir: null
-  name: time
+  name: time_of_day
 return:
   return: null
   return-values:
@@ -69,6 +69,6 @@ return:
       The ${.:/params[0]/name} parameter was ${/c/if/null:/name}.
     value: ${../../status/if/invalid-address:/name}
   - description: |
-      The time point specified by ${.:/params[0]/name} was invalid.
+      The time of day specified by ${.:/params[0]/name} was invalid.
     value: ${../../status/if/invalid-clock:/name}
 type: interface



More information about the vc mailing list