[PATCH] manual: Fix a format tag for a return value from 'nanosleep'

Florian Weimer fweimer@redhat.com
Wed Jun 4 17:11:07 GMT 2025


* Maciej W. Rozycki:

> We use @code rather than @math for non-arithmetic function return 
> values, so adjust one quoted for 'nanosleep' in the description of 
> 'clock_nanosleep'.
> ---
>  manual/time.texi |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> glibc-doc-clock-nanosleep-format.diff
>
> Index: glibc/manual/time.texi
> ===================================================================
> --- glibc.orig/manual/time.texi
> +++ glibc/manual/time.texi
> @@ -3237,7 +3237,7 @@ the caller with a way to specify the clo
>  time and express the sleep interval in absolute or relative terms.  It
>  returns zero when returning because the interval is over, and a positive
>  error number corresponding to the error encountered otherwise.  This is
> -different from @code{nanosleep}, which returns @math{-1} upon failure and
> +different from @code{nanosleep}, which returns @code{-1} upon failure and
>  sets the global variable @code{errno} according to the error encountered
>  instead.

Them manual isn't consistent.  Three random examples:

manual/llio.texi-
manual/llio.texi-The normal return value from @code{fcntl} with this command is 
either @math{0}
manual/llio.texi:on success or @math{-1}, which indicates an error. The followin
g @code{errno}
manual/llio.texi-error conditions are defined for this command:
manual/llio.texi-

manual/terminal.texi-
manual/terminal.texi-The return value is normally zero.  In the event of an erro
r, a value
manual/terminal.texi:of @math{-1} is returned.  The following @code{errno} error
 conditions
manual/terminal.texi-are defined for this function:
manual/terminal.texi-

manual/time.texi-
manual/time.texi-If the function returns because the interval is over, it returns zero.
manual/time.texi:Otherwise it returns @math{-1} and sets the global variable @code{errno} to
manual/time.texi-one of the following values:
manual/time.texi-

Thanks,
Florian



More information about the Libc-alpha mailing list