diff options
Diffstat (limited to 'spec/rtems/clock/if/get-boot-time-timeval.yml')
| -rw-r--r-- | spec/rtems/clock/if/get-boot-time-timeval.yml | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/spec/rtems/clock/if/get-boot-time-timeval.yml b/spec/rtems/clock/if/get-boot-time-timeval.yml index ef94b3ee..1bf51633 100644 --- a/spec/rtems/clock/if/get-boot-time-timeval.yml +++ b/spec/rtems/clock/if/get-boot-time-timeval.yml @@ -1,7 +1,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause brief: | - Gets a time point during system initialization used by - ${/glossary/clock-realtime:/term} in seconds and microseconds format. + Gets the time elapsed since the ${/glossary/unix-epoch:/term} at some time + point during system initialization in seconds and microseconds format. copyrights: - Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) definition: @@ -30,13 +30,14 @@ links: name: rtems_clock_get_boot_time_timeval notes: | See ${get-boot-time:/name} and ${get-boot-time-bintime:/name} to get the boot - time in alternative formats. + time in alternative formats. Setting the ${/glossary/clock-realtime:/term} + will also set the boot time. params: - description: | - is the pointer to a ${/c/if/timeval:/name} object. A time point during - system initialization used by ${/glossary/clock-realtime:/term} will be - stored in this object. Calling the directive with a pointer equal to - ${/c/if/null:/name} is undefined behaviour. + is the pointer to a ${/c/if/timeval:/name} object. The time elapsed since + the ${/glossary/unix-epoch:/term} at some time point during system + initialization call will be stored in this object. Calling the directive + with a pointer equal to ${/c/if/null:/name} is undefined behaviour. dir: out name: boot_time return: null |