From: Florian Weimer <fweimer@redhat.com>
To: libc-alpha@sourceware.org
Cc: "Nilgün Belma Bugüner" <nillguine@gmail.com>
Subject: [PATCH] manual: Remove unsupported line breaks in waiting-with-clock section
Date: Mon, 08 May 2023 13:21:20 +0200 [thread overview]
Message-ID: <87h6snrrv3.fsf@oldenburg.str.redhat.com> (raw)
The argument to @deftypefun must be on a single line.
Also add the missing @safety for sem_clockwait.
Reported-by: Nilgün Belma Bugüner <nillguine@gmail.com>
---
manual/threads.texi | 29 ++++++++---------------------
1 file changed, 8 insertions(+), 21 deletions(-)
diff --git a/manual/threads.texi b/manual/threads.texi
index 48fd562923..a721c7f464 100644
--- a/manual/threads.texi
+++ b/manual/threads.texi
@@ -754,8 +754,8 @@ freed.
@comment semaphore.h
@comment POSIX-proposed
-@deftypefun int sem_clockwait (sem_t *@var{sem}, clockid_t @var{clockid},
- const struct timespec *@var{abstime})
+@deftypefun int sem_clockwait (sem_t *@var{sem}, clockid_t @var{clockid}, const struct timespec *@var{abstime})
+@safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}}
Behaves like @code{sem_timedwait} except the time @var{abstime} is measured
against the clock specified by @var{clockid} rather than
@code{CLOCK_REALTIME}. Currently, @var{clockid} must be either
@@ -764,8 +764,7 @@ against the clock specified by @var{clockid} rather than
@comment pthread.h
@comment POSIX-proposed
-@deftypefun int pthread_cond_clockwait (pthread_cond_t *@var{cond}, pthread_mutex_t *@var{mutex},
- clockid_t @var{clockid}, const struct timespec *@var{abstime})
+@deftypefun int pthread_cond_clockwait (pthread_cond_t *@var{cond}, pthread_mutex_t *@var{mutex}, clockid_t @var{clockid}, const struct timespec *@var{abstime})
@safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}}
@c If exactly the same function with arguments is called from a signal
@c handler that interrupts between the mutex unlock and sleep then it
@@ -784,10 +783,7 @@ specified or defaulted when @code{pthread_cond_init} was called. Currently,
@comment pthread.h
@comment POSIX-proposed
-@deftypefun int pthread_rwlock_clockrdlock (pthread_rwlock_t *@var{rwlock},
- clockid_t @var{clockid},
- const struct timespec *@var{abstime})
-
+@deftypefun int pthread_rwlock_clockrdlock (pthread_rwlock_t *@var{rwlock}, clockid_t @var{clockid}, const struct timespec *@var{abstime})
@safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}}
Behaves like @code{pthread_rwlock_timedrdlock} except the time
@var{abstime} is measured against the clock specified by @var{clockid}
@@ -798,10 +794,7 @@ returned.
@comment pthread.h
@comment POSIX-proposed
-@deftypefun int pthread_rwlock_clockwrlock (pthread_rwlock_t *@var{rwlock},
- clockid_t @var{clockid},
- const struct timespec *@var{abstime})
-
+@deftypefun int pthread_rwlock_clockwrlock (pthread_rwlock_t *@var{rwlock}, clockid_t @var{clockid}, const struct timespec *@var{abstime})
@safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}}
Behaves like @code{pthread_rwlock_timedwrlock} except the time
@var{abstime} is measured against the clock specified by @var{clockid}
@@ -812,8 +805,7 @@ returned.
@comment pthread.h
@comment GNU extension
-@deftypefun int pthread_tryjoin_np (pthread_t *@var{thread},
- void **@var{thread_return})
+@deftypefun int pthread_tryjoin_np (pthread_t *@var{thread}, void **@var{thread_return})
@standards{GNU, pthread.h}
@safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}}
Behaves like @code{pthread_join} except that it will return @code{EBUSY}
@@ -822,9 +814,7 @@ immediately if the thread specified by @var{thread} has not yet terminated.
@comment pthread.h
@comment GNU extension
-@deftypefun int pthread_timedjoin_np (pthread_t *@var{thread},
- void **@var{thread_return},
- const struct timespec *@var{abstime})
+@deftypefun int pthread_timedjoin_np (pthread_t *@var{thread}, void **@var{thread_return}, const struct timespec *@var{abstime})
@standards{GNU, pthread.h}
@safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}}
Behaves like @code{pthread_tryjoin_np} except that it will block until the
@@ -836,10 +826,7 @@ will wait forever in the same way as @code{pthread_join}.
@comment pthread.h
@comment GNU extension
-@deftypefun int pthread_clockjoin_np (pthread_t *@var{thread},
- void **@var{thread_return},
- clockid_t @var{clockid},
- const struct timespec *@var{abstime})
+@deftypefun int pthread_clockjoin_np (pthread_t *@var{thread}, void **@var{thread_return}, clockid_t @var{clockid}, const struct timespec *@var{abstime})
@standards{GNU, pthread.h}
@safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}}
Behaves like @code{pthread_timedjoin_np} except that the absolute time in
base-commit: a26238d3ca21fda6d7d41b4d56541fcf4546fbe7
next reply other threads:[~2023-05-08 11:21 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-08 11:21 Florian Weimer [this message]
2023-05-08 11:45 ` Andreas Schwab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87h6snrrv3.fsf@oldenburg.str.redhat.com \
--to=fweimer@redhat.com \
--cc=libc-alpha@sourceware.org \
--cc=nillguine@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).