[01/19] manual: Add missing section and node for clockid_t wait functions

Message ID 640e1350db394fb52655c14c0e287c8059e98a18.1589884403.git.fweimer@redhat.com
State New
Headers show
Series
  • Signal mask for timer helper thread
Related show

Commit Message

Adhemerval Zanella via Libc-alpha May 19, 2020, 10:44 a.m.
Without this, these functions appear under the node Default Thread
Attributes, which is confusing.

Eventually, the documentation should be merged with the (yet to be
documented) standardized functions.
---
 manual/threads.texi | 8 ++++++++
 1 file changed, 8 insertions(+)

-- 
2.25.4

Comments

Adhemerval Zanella via Libc-alpha May 20, 2020, 1:12 p.m. | #1
On 5/19/20 6:44 AM, Florian Weimer via Libc-alpha wrote:
> Without this, these functions appear under the node Default Thread

> Attributes, which is confusing.

> 

> Eventually, the documentation should be merged with the (yet to be

> documented) standardized functions.


OK for master.

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


> ---

>  manual/threads.texi | 8 ++++++++

>  1 file changed, 8 insertions(+)

> 

> diff --git a/manual/threads.texi b/manual/threads.texi

> index 0858ef8f92..a425635179 100644

> --- a/manual/threads.texi

> +++ b/manual/threads.texi

> @@ -625,6 +625,8 @@ the standard.

>  @menu

>  * Default Thread Attributes::             Setting default attributes for

>  					  threads in a process.

> +* Waiting with Explicit Clocks::          Functions for waiting with an

> +                                          explicit clock specification.

>  @end menu

>  

>  @node Default Thread Attributes

> @@ -669,6 +671,12 @@ The system does not have sufficient memory.

>  @end table

>  @end deftypefun

>  

> +@node Waiting with Explicit Clocks

> +@subsubsection Functions for Waiting According to a Specific Clock

> +

> +@Theglibc{} provides several waiting functions that expect an explicit

> +@code{clockid_t} argument.

> +

>  @comment semaphore.h

>  @comment POSIX-proposed

>  @deftypefun int sem_clockwait (sem_t *@var{sem}, clockid_t @var{clockid},

> 



-- 
Cheers,
Carlos.

Patch

diff --git a/manual/threads.texi b/manual/threads.texi
index 0858ef8f92..a425635179 100644
--- a/manual/threads.texi
+++ b/manual/threads.texi
@@ -625,6 +625,8 @@  the standard.
 @menu
 * Default Thread Attributes::             Setting default attributes for
 					  threads in a process.
+* Waiting with Explicit Clocks::          Functions for waiting with an
+                                          explicit clock specification.
 @end menu
 
 @node Default Thread Attributes
@@ -669,6 +671,12 @@  The system does not have sufficient memory.
 @end table
 @end deftypefun
 
+@node Waiting with Explicit Clocks
+@subsubsection Functions for Waiting According to a Specific Clock
+
+@Theglibc{} provides several waiting functions that expect an explicit
+@code{clockid_t} argument.
+
 @comment semaphore.h
 @comment POSIX-proposed
 @deftypefun int sem_clockwait (sem_t *@var{sem}, clockid_t @var{clockid},