rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-10-19 00:37:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

c-user: Replace "precision" with "resolution"

Browse Source 
Resolution is the right term for the documented property.
This commit is contained in:
Sebastian Huber
2021-11-23 15:20:06 +01:00
parent 513b90d7a4
commit 838b78ad5c
2 changed files with 33 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
c-user/clock/directives.rst
View File

@@ -255,9 +255,9 @@ Gets the time elapsed since the :term:`Unix epoch` measured using
.. rubric:: NOTES: .. rubric:: NOTES:
The directive accesses a device provided by the :term:`Clock Driver` to get the The directive accesses a device provided by the :term:`Clock Driver` to get the
time in the highest precision available to the system. Alternatively, the time in the highest resolution available to the system. Alternatively, the
:ref:`InterfaceRtemsClockGetRealtimeCoarse` directive may be used to get the :ref:`InterfaceRtemsClockGetRealtimeCoarse` directive may be used to get the
time with less precision and less runtime overhead. time in a lower resolution and with less runtime overhead.
See :ref:`InterfaceRtemsClockGetRealtimeBintime` and See :ref:`InterfaceRtemsClockGetRealtimeBintime` and
:ref:`InterfaceRtemsClockGetRealtimeTimeval` to get the time in alternative :ref:`InterfaceRtemsClockGetRealtimeTimeval` to get the time in alternative
@@ -307,9 +307,9 @@ Gets the time elapsed since the :term:`Unix epoch` measured using
.. rubric:: NOTES: .. rubric:: NOTES:
The directive accesses a device provided by the :term:`Clock Driver` to get the The directive accesses a device provided by the :term:`Clock Driver` to get the
time in the highest precision available to the system. Alternatively, the time in the highest resolution available to the system. Alternatively, the
:ref:`InterfaceRtemsClockGetRealtimeCoarseBintime` directive may be used to get :ref:`InterfaceRtemsClockGetRealtimeCoarseBintime` directive may be used to get
the time with less precision and less runtime overhead. the time in a lower resolution and with less runtime overhead.
See :ref:`InterfaceRtemsClockGetRealtime` and See :ref:`InterfaceRtemsClockGetRealtime` and
:ref:`InterfaceRtemsClockGetRealtimeTimeval` to get the time in alternative :ref:`InterfaceRtemsClockGetRealtimeTimeval` to get the time in alternative
@@ -360,9 +360,9 @@ Gets the time elapsed since the :term:`Unix epoch` measured using
.. rubric:: NOTES: .. rubric:: NOTES:
The directive accesses a device provided by the :term:`Clock Driver` to get the The directive accesses a device provided by the :term:`Clock Driver` to get the
time in the highest precision available to the system. Alternatively, the time in the highest resolution available to the system. Alternatively, the
:ref:`InterfaceRtemsClockGetRealtimeCoarseTimeval` directive may be used to get :ref:`InterfaceRtemsClockGetRealtimeCoarseTimeval` directive may be used to get
the time with less precision and less runtime overhead. the time in a lower resolution and with less runtime overhead.
See :ref:`InterfaceRtemsClockGetRealtime` and See :ref:`InterfaceRtemsClockGetRealtime` and
:ref:`InterfaceRtemsClockGetRealtimeBintime` to get the time in alternative :ref:`InterfaceRtemsClockGetRealtimeBintime` to get the time in alternative
@@ -392,7 +392,7 @@ rtems_clock_get_realtime_coarse()
--------------------------------- ---------------------------------
Gets the time elapsed since the :term:`Unix epoch` measured using Gets the time elapsed since the :term:`Unix epoch` measured using
:term:`CLOCK_REALTIME` in coarse precision in seconds and nanoseconds format. :term:`CLOCK_REALTIME` in coarse resolution in seconds and nanoseconds format.
.. rubric:: CALLING SEQUENCE: .. rubric:: CALLING SEQUENCE:
@@ -415,8 +415,8 @@ Gets the time elapsed since the :term:`Unix epoch` measured using
The directive does not access a device to get the time. It uses a recent The directive does not access a device to get the time. It uses a recent
snapshot provided by the :term:`Clock Driver`. Alternatively, the snapshot provided by the :term:`Clock Driver`. Alternatively, the
:ref:`InterfaceRtemsClockGetRealtime` directive may be used to get the time :ref:`InterfaceRtemsClockGetRealtime` directive may be used to get the time in
with higher precision and higher runtime overhead. a higher resolution and with a higher runtime overhead.
See :ref:`InterfaceRtemsClockGetRealtimeCoarseBintime` and See :ref:`InterfaceRtemsClockGetRealtimeCoarseBintime` and
:ref:`InterfaceRtemsClockGetRealtimeCoarseTimeval` to get the time in :ref:`InterfaceRtemsClockGetRealtimeCoarseTimeval` to get the time in
@@ -446,7 +446,7 @@ rtems_clock_get_realtime_coarse_bintime()
----------------------------------------- -----------------------------------------
Gets the time elapsed since the :term:`Unix epoch` measured using Gets the time elapsed since the :term:`Unix epoch` measured using
:term:`CLOCK_REALTIME` in coarse precision in binary time format. :term:`CLOCK_REALTIME` in coarse resolution in binary time format.
.. rubric:: CALLING SEQUENCE: .. rubric:: CALLING SEQUENCE:
@@ -469,7 +469,7 @@ Gets the time elapsed since the :term:`Unix epoch` measured using
The directive does not access a device to get the time. It uses a recent The directive does not access a device to get the time. It uses a recent
snapshot provided by the :term:`Clock Driver`. Alternatively, the snapshot provided by the :term:`Clock Driver`. Alternatively, the
:ref:`InterfaceRtemsClockGetRealtimeBintime` directive may be used to get the :ref:`InterfaceRtemsClockGetRealtimeBintime` directive may be used to get the
time with higher precision and higher runtime overhead. time in a higher resolution and with a higher runtime overhead.
See :ref:`InterfaceRtemsClockGetRealtimeCoarse` and See :ref:`InterfaceRtemsClockGetRealtimeCoarse` and
:ref:`InterfaceRtemsClockGetRealtimeCoarseTimeval` to get the time in :ref:`InterfaceRtemsClockGetRealtimeCoarseTimeval` to get the time in
@@ -499,7 +499,7 @@ rtems_clock_get_realtime_coarse_timeval()
----------------------------------------- -----------------------------------------
Gets the time elapsed since the :term:`Unix epoch` measured using Gets the time elapsed since the :term:`Unix epoch` measured using
:term:`CLOCK_REALTIME` in coarse precision in seconds and microseconds format. :term:`CLOCK_REALTIME` in coarse resolution in seconds and microseconds format.
.. rubric:: CALLING SEQUENCE: .. rubric:: CALLING SEQUENCE:
@@ -523,7 +523,7 @@ Gets the time elapsed since the :term:`Unix epoch` measured using
The directive does not access a device to get the time. It uses a recent The directive does not access a device to get the time. It uses a recent
snapshot provided by the :term:`Clock Driver`. Alternatively, the snapshot provided by the :term:`Clock Driver`. Alternatively, the
:ref:`InterfaceRtemsClockGetRealtimeTimeval` directive may be used to get the :ref:`InterfaceRtemsClockGetRealtimeTimeval` directive may be used to get the
time with higher precision and higher runtime overhead. time in a higher resolution and with a higher runtime overhead.
See :ref:`InterfaceRtemsClockGetRealtimeCoarse` and See :ref:`InterfaceRtemsClockGetRealtimeCoarse` and
:ref:`InterfaceRtemsClockGetRealtimeCoarseTimeval` to get the time in :ref:`InterfaceRtemsClockGetRealtimeCoarseTimeval` to get the time in
@@ -574,9 +574,9 @@ the :term:`CLOCK_MONOTONIC` in seconds and nanoseconds format.
.. rubric:: NOTES: .. rubric:: NOTES:
The directive accesses a device provided by the :term:`Clock Driver` to get the The directive accesses a device provided by the :term:`Clock Driver` to get the
time in the highest precision available to the system. Alternatively, the time in the highest resolution available to the system. Alternatively, the
:ref:`InterfaceRtemsClockGetMonotonicCoarse` directive may be used to get the :ref:`InterfaceRtemsClockGetMonotonicCoarse` directive may be used to get the
time with less precision and less runtime overhead. time with in a lower resolution and with less runtime overhead.
See :ref:`InterfaceRtemsClockGetMonotonicBintime`, See :ref:`InterfaceRtemsClockGetMonotonicBintime`,
:ref:`InterfaceRtemsClockGetMonotonicSbintime`, and :ref:`InterfaceRtemsClockGetMonotonicSbintime`, and
@@ -628,9 +628,9 @@ the :term:`CLOCK_MONOTONIC` in binary time format.
.. rubric:: NOTES: .. rubric:: NOTES:
The directive accesses a device provided by the :term:`Clock Driver` to get the The directive accesses a device provided by the :term:`Clock Driver` to get the
time in the highest precision available to the system. Alternatively, the time in the highest resolution available to the system. Alternatively, the
:ref:`InterfaceRtemsClockGetMonotonicCoarseBintime` directive may be used to :ref:`InterfaceRtemsClockGetMonotonicCoarseBintime` directive may be used to
get the time with less precision and less runtime overhead. get the time in a lower resolution and with less runtime overhead.
See :ref:`InterfaceRtemsClockGetMonotonic`, See :ref:`InterfaceRtemsClockGetMonotonic`,
:ref:`InterfaceRtemsClockGetMonotonicSbintime`, and :ref:`InterfaceRtemsClockGetMonotonicSbintime`, and
@@ -677,7 +677,7 @@ the :term:`CLOCK_MONOTONIC` at some time point during the directive call.
.. rubric:: NOTES: .. rubric:: NOTES:
The directive accesses a device provided by the :term:`Clock Driver` to get the The directive accesses a device provided by the :term:`Clock Driver` to get the
time in the highest precision available to the system. time in the highest resolution available to the system.
See :ref:`InterfaceRtemsClockGetMonotonic`, See :ref:`InterfaceRtemsClockGetMonotonic`,
:ref:`InterfaceRtemsClockGetMonotonicBintime`, and :ref:`InterfaceRtemsClockGetMonotonicBintime`, and
@@ -729,9 +729,9 @@ the :term:`CLOCK_MONOTONIC` in seconds and microseconds format.
.. rubric:: NOTES: .. rubric:: NOTES:
The directive accesses a device provided by the :term:`Clock Driver` to get the The directive accesses a device provided by the :term:`Clock Driver` to get the
time in the highest precision available to the system. Alternatively, the time in the highest resolution available to the system. Alternatively, the
:ref:`InterfaceRtemsClockGetMonotonicCoarseTimeval` directive may be used to :ref:`InterfaceRtemsClockGetMonotonicCoarseTimeval` directive may be used to
get the time with less precision and less runtime overhead. get the time in a lower resolution and with less runtime overhead.
See :ref:`InterfaceRtemsClockGetMonotonic`, See :ref:`InterfaceRtemsClockGetMonotonic`,
:ref:`InterfaceRtemsClockGetMonotonicBintime`, and :ref:`InterfaceRtemsClockGetMonotonicBintime`, and
@@ -762,7 +762,7 @@ rtems_clock_get_monotonic_coarse()
---------------------------------- ----------------------------------
Gets the time elapsed since some fixed time point in the past measured using Gets the time elapsed since some fixed time point in the past measured using
the :term:`CLOCK_MONOTONIC` in coarse precision in seconds and nanoseconds the :term:`CLOCK_MONOTONIC` in coarse resolution in seconds and nanoseconds
format. format.
.. rubric:: CALLING SEQUENCE: .. rubric:: CALLING SEQUENCE:
@@ -785,8 +785,8 @@ format.
The directive does not access a device to get the time. It uses a recent The directive does not access a device to get the time. It uses a recent
snapshot provided by the :term:`Clock Driver`. Alternatively, the snapshot provided by the :term:`Clock Driver`. Alternatively, the
:ref:`InterfaceRtemsClockGetMonotonic` directive may be used to get the time :ref:`InterfaceRtemsClockGetMonotonic` directive may be used to get the time in
with higher precision and higher runtime overhead. a higher resolution and with a higher runtime overhead.
See :ref:`InterfaceRtemsClockGetMonotonicCoarseBintime` and See :ref:`InterfaceRtemsClockGetMonotonicCoarseBintime` and
:ref:`InterfaceRtemsClockGetMonotonicCoarseTimeval` to get the time in :ref:`InterfaceRtemsClockGetMonotonicCoarseTimeval` to get the time in
@@ -816,7 +816,7 @@ rtems_clock_get_monotonic_coarse_bintime()
------------------------------------------ ------------------------------------------
Gets the time elapsed since some fixed time point in the past measured using Gets the time elapsed since some fixed time point in the past measured using
the :term:`CLOCK_MONOTONIC` in coarse precision in binary time format. the :term:`CLOCK_MONOTONIC` in coarse resolution in binary time format.
.. rubric:: CALLING SEQUENCE: .. rubric:: CALLING SEQUENCE:
@@ -839,7 +839,7 @@ the :term:`CLOCK_MONOTONIC` in coarse precision in binary time format.
The directive does not access a device to get the time. It uses a recent The directive does not access a device to get the time. It uses a recent
snapshot provided by the :term:`Clock Driver`. Alternatively, the snapshot provided by the :term:`Clock Driver`. Alternatively, the
:ref:`InterfaceRtemsClockGetMonotonicBintime` directive may be used to get the :ref:`InterfaceRtemsClockGetMonotonicBintime` directive may be used to get the
time with higher precision and higher runtime overhead. time in a higher resolution and with a higher runtime overhead.
See :ref:`InterfaceRtemsClockGetMonotonicCoarse` and See :ref:`InterfaceRtemsClockGetMonotonicCoarse` and
:ref:`InterfaceRtemsClockGetMonotonicCoarseTimeval` to get the time in :ref:`InterfaceRtemsClockGetMonotonicCoarseTimeval` to get the time in
@@ -869,7 +869,7 @@ rtems_clock_get_monotonic_coarse_timeval()
------------------------------------------ ------------------------------------------
Gets the time elapsed since some fixed time point in the past measured using Gets the time elapsed since some fixed time point in the past measured using
the :term:`CLOCK_MONOTONIC` in coarse precision in seconds and microseconds the :term:`CLOCK_MONOTONIC` in coarse resolution in seconds and microseconds
format. format.
.. rubric:: CALLING SEQUENCE: .. rubric:: CALLING SEQUENCE:
@@ -893,7 +893,7 @@ format.
The directive does not access a device to get the time. It uses a recent The directive does not access a device to get the time. It uses a recent
snapshot provided by the :term:`Clock Driver`. Alternatively, the snapshot provided by the :term:`Clock Driver`. Alternatively, the
:ref:`InterfaceRtemsClockGetMonotonicTimeval` directive may be used to get the :ref:`InterfaceRtemsClockGetMonotonicTimeval` directive may be used to get the
time with higher precision and higher runtime overhead. time in a higher resolution and with a higher runtime overhead.
See :ref:`InterfaceRtemsClockGetMonotonicCoarse` and See :ref:`InterfaceRtemsClockGetMonotonicCoarse` and
:ref:`InterfaceRtemsClockGetMonotonicCoarseBintime` to get the time in :ref:`InterfaceRtemsClockGetMonotonicCoarseBintime` to get the time in

12
c-user/clock/introduction.rst
View File

@@ -81,16 +81,16 @@ capabilities. The directives provided by the Clock Manager are:
microseconds format. microseconds format.
* :ref:`InterfaceRtemsClockGetRealtimeCoarse` - Gets the time elapsed since the * :ref:`InterfaceRtemsClockGetRealtimeCoarse` - Gets the time elapsed since the
:term:`Unix epoch` measured using :term:`CLOCK_REALTIME` in coarse precision :term:`Unix epoch` measured using :term:`CLOCK_REALTIME` in coarse resolution
in seconds and nanoseconds format. in seconds and nanoseconds format.
* :ref:`InterfaceRtemsClockGetRealtimeCoarseBintime` - Gets the time elapsed * :ref:`InterfaceRtemsClockGetRealtimeCoarseBintime` - Gets the time elapsed
since the :term:`Unix epoch` measured using :term:`CLOCK_REALTIME` in coarse since the :term:`Unix epoch` measured using :term:`CLOCK_REALTIME` in coarse
precision in binary time format. resolution in binary time format.
* :ref:`InterfaceRtemsClockGetRealtimeCoarseTimeval` - Gets the time elapsed * :ref:`InterfaceRtemsClockGetRealtimeCoarseTimeval` - Gets the time elapsed
since the :term:`Unix epoch` measured using :term:`CLOCK_REALTIME` in coarse since the :term:`Unix epoch` measured using :term:`CLOCK_REALTIME` in coarse
precision in seconds and microseconds format. resolution in seconds and microseconds format.
* :ref:`InterfaceRtemsClockGetMonotonic` - Gets the time elapsed since some * :ref:`InterfaceRtemsClockGetMonotonic` - Gets the time elapsed since some
fixed time point in the past measured using the :term:`CLOCK_MONOTONIC` in fixed time point in the past measured using the :term:`CLOCK_MONOTONIC` in
@@ -110,15 +110,15 @@ capabilities. The directives provided by the Clock Manager are:
* :ref:`InterfaceRtemsClockGetMonotonicCoarse` - Gets the time elapsed since * :ref:`InterfaceRtemsClockGetMonotonicCoarse` - Gets the time elapsed since
some fixed time point in the past measured using the :term:`CLOCK_MONOTONIC` some fixed time point in the past measured using the :term:`CLOCK_MONOTONIC`
in coarse precision in seconds and nanoseconds format. in coarse resolution in seconds and nanoseconds format.
* :ref:`InterfaceRtemsClockGetMonotonicCoarseBintime` - Gets the time elapsed * :ref:`InterfaceRtemsClockGetMonotonicCoarseBintime` - Gets the time elapsed
since some fixed time point in the past measured using the since some fixed time point in the past measured using the
:term:`CLOCK_MONOTONIC` in coarse precision in binary time format. :term:`CLOCK_MONOTONIC` in coarse resolution in binary time format.
* :ref:`InterfaceRtemsClockGetMonotonicCoarseTimeval` - Gets the time elapsed * :ref:`InterfaceRtemsClockGetMonotonicCoarseTimeval` - Gets the time elapsed
since some fixed time point in the past measured using the since some fixed time point in the past measured using the
:term:`CLOCK_MONOTONIC` in coarse precision in seconds and microseconds :term:`CLOCK_MONOTONIC` in coarse resolution in seconds and microseconds
format. format.
* :ref:`InterfaceRtemsClockGetBootTime` - Gets the time elapsed since the * :ref:`InterfaceRtemsClockGetBootTime` - Gets the time elapsed since the