manual: Safety annotations for clock_gettime, clock_getres

Message ID 87v7z9i0zm.fsf@oldenburg.str.redhat.com
State Committed
Commit 6efd6cd46bf2257e674be4933a034542d80944eb
Headers
Series manual: Safety annotations for clock_gettime, clock_getres |

Checks

Context Check Description
redhat-pt-bot/TryBot-apply_patch success Patch applied to master at the time it was sent
redhat-pt-bot/TryBot-32bit success Build for i686
linaro-tcwg-bot/tcwg_glibc_build--master-aarch64 success Build passed
linaro-tcwg-bot/tcwg_glibc_check--master-aarch64 warning Patch is already merged
linaro-tcwg-bot/tcwg_glibc_build--master-arm warning Patch is already merged

Commit Message

Florian Weimer Sept. 6, 2024, 9:29 a.m. UTC
  The annotations are preliminary, for consistency with existing
annotations on gettimeofday etc.

---
 manual/time.texi | 2 ++
 1 file changed, 2 insertions(+)


base-commit: 1b171c942ea066c08a1e5aefb977e35da08ed291
  

Comments

Carlos O'Donell Sept. 6, 2024, 11:43 a.m. UTC | #1
On 9/6/24 5:29 AM, Florian Weimer wrote:
> The annotations are preliminary, for consistency with existing
> annotations on gettimeofday etc.

LGTM.

Reviewed-by: Carlos O'Donell <carlos@redhat.com>

> ---
>  manual/time.texi | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/manual/time.texi b/manual/time.texi
> index 6b1080db06..64aad8fdc5 100644
> --- a/manual/time.texi
> +++ b/manual/time.texi
> @@ -532,6 +532,7 @@ Systems may support more than just these two POSIX clocks.
>  
>  @deftypefun int clock_gettime (clockid_t @var{clock}, struct timespec *@var{ts})
>  @standards{POSIX.1, time.h}
> +@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}

OK. Touches errno which is safe. vsyscall which is safe. reads GLRO which is safe.
converts time which is safe.

>  Get the current time according to the clock identified by @var{clock},
>  storing it as seconds and nanoseconds in @code{*@var{ts}}.
>  @xref{Time Types}, for a description of @code{struct timespec}.
> @@ -553,6 +554,7 @@ clock:
>  
>  @deftypefun int clock_getres (clockid_t @var{clock}, struct timespec *@var{res})
>  @standards{POSIX.1, time.h}
> +@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}

OK. Likewise.

>  Get the actual resolution of the clock identified by @var{clock},
>  storing it in @code{*@var{ts}}.
>  
> 
> base-commit: 1b171c942ea066c08a1e5aefb977e35da08ed291
>
  

Patch

diff --git a/manual/time.texi b/manual/time.texi
index 6b1080db06..64aad8fdc5 100644
--- a/manual/time.texi
+++ b/manual/time.texi
@@ -532,6 +532,7 @@  Systems may support more than just these two POSIX clocks.
 
 @deftypefun int clock_gettime (clockid_t @var{clock}, struct timespec *@var{ts})
 @standards{POSIX.1, time.h}
+@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
 Get the current time according to the clock identified by @var{clock},
 storing it as seconds and nanoseconds in @code{*@var{ts}}.
 @xref{Time Types}, for a description of @code{struct timespec}.
@@ -553,6 +554,7 @@  clock:
 
 @deftypefun int clock_getres (clockid_t @var{clock}, struct timespec *@var{res})
 @standards{POSIX.1, time.h}
+@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
 Get the actual resolution of the clock identified by @var{clock},
 storing it in @code{*@var{ts}}.