[PATCH 2/2] manual: Add links to POSIX Semaphores man-pages documentation

Florian Weimer fweimer@redhat.com
Wed Jan 8 13:29:26 GMT 2025


* Arjun Shankar:

> The POSIX Semaphores functions are currently undocumented in our info
> pages.  This commit adds links to the man-pages documentation for all
> the `sem_*' functions (except `sem_clockwait') so that they refer to
> some useful documentation instead of just being stubs.  `sem_clockwait'
> isn't documented by man-pages but thankfully already has a small useful
> blurb in our own docs.
> ---
>  manual/threads.texi | 10 ++++++++++
>  1 file changed, 10 insertions(+)
>
> diff --git a/manual/threads.texi b/manual/threads.texi
> index 806ab866c5..5b6196116b 100644
> --- a/manual/threads.texi
> +++ b/manual/threads.texi
> @@ -622,16 +622,19 @@ Associate the thread-specific @var{value} with @var{key} in the calling thread.
>  
>  @deftypefun int sem_init (sem_t *@var{sem}, int @var{pshared}, unsigned int @var{value})
>  @safety{@prelim{}@mtsafe{}@assafe{}@acunsafe{@acucorrupt{}}}
> +@manpagefunctionstub{sem_init,3}
>  @c Does not atomically update sem_t therefore AC-unsafe
>  @c because it can leave sem_t partially initialized.
>  @end deftypefun
>  
>  @deftypefun int sem_destroy (sem_t *@var{sem})
> +@manpagefunctionstub{sem_destroy,3}
>  @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
>  @c Function does nothing and is therefore always safe.
>  @end deftypefun

@manpagefunctionstub must come after @safety.  Surely the rendered
version looks off?

Thanks,
Florian



More information about the Libc-alpha mailing list