Re: [PATCH v2] man/man3/timespec_get.3: Correct return value and clarify description

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Mark,

On Sat, Feb 08, 2025 at 05:24:14PM -0800, Mark Harris wrote:
> Range-diff against v1:

Thanks a lot!  :-)

I've applied the patch, with a minor tweak (see below).
<https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/commit/?h=contrib&id=48cbc739e8c0bec4049fd2ae58a270101a77b7b6>

> 1:  c6990f9c9 ! 1:  5f8dc5d2d man/man3/timespec_get.3: Correct return value and clarify description
>     @@ Commit message
>            it repeatedly) (C23 7.29.2.7).
>          - Calls to these functions are not technically equivalent to any
>            clock_* function call; at least the return value will be different.
>     +      Clarify that it is the time and resolution that are the same.

LGTM.

>          - The ERRORS section is removed, because it states only what is true
>            for every function that does not state otherwise (i.e., errno might
>            be affected by underlying system calls).
>      
>     +    Fixes: 7bda5119fe5e (2024-09-08; "timespec_get.3, timespec_getres.3: Add page and link page")
>     +    Cc: наб <nabijaczleweli@xxxxxxxxxxxxxxxxxx>
>          Signed-off-by: Mark Harris <mark.hsj@xxxxxxxxx>
>      
>       ## man/man3/timespec_get.3 ##
>     @@ man/man3/timespec_get.3: .SH SYNOPSIS
>      +The
>      +.BR timespec_get ()
>      +function stores the current time, based on the specified time base, in the
>     -+.I struct timespec
>     -+pointed to by
>     ++.BR timespec (3type)
>     ++structure pointed to by
>      +.IR res .
>       .P
>      -.I timespec_getres(res, TIME_UTC)
>     @@ man/man3/timespec_get.3: .SH SYNOPSIS
>      +function stores the resolution of times retrieved by
>      +.BR timespec_get ()
>      +with the specified time base in the
>     -+.I struct timespec
>     -+pointed to by
>     ++.BR timespec (3type)
>     ++structure pointed to by
>      +.IR tp ,
>      +if
>      +.I tp
>     @@ man/man3/timespec_get.3: .SH SYNOPSIS
>      -Some other systems support different time bases.
>      +is always a supported time base,
>      +and is the only time base supported on Linux.
>     -+The time and resolution in this time base is the same as that retrieved by
>     -+.I clock_gettime(CLOCK_REALTIME, res)
>     ++The time and resolution in this time base
>     ++are the same as those retrieved by
>     ++.I clock_gettime(CLOCK_REALTIME,\~res)
>      +and
>     -+.IR "clock_getres(CLOCK_REALTIME, tp)" ,
>     ++.IR "clock_getres(CLOCK_REALTIME,\~tp)" ,

The quotes here are unnecessary, because now there's no white space in
the quoted text.  I've applied this minor tweak to your patch:

	diff --git c/man/man3/timespec_get.3 i/man/man3/timespec_get.3
	index ecac06d99..95a1833e1 100644
	--- c/man/man3/timespec_get.3
	+++ i/man/man3/timespec_get.3
	@@ -46,7 +46,7 @@ .SH DESCRIPTION
	 are the same as those retrieved by
	 .I clock_gettime(CLOCK_REALTIME,\~res)
	 and
	-.IR "clock_getres(CLOCK_REALTIME,\~tp)" ,
	+.IR clock_getres(CLOCK_REALTIME,\~tp) ,
	 respectively.
	 Other systems may support additional time bases.
	 .SH RETURN VALUE

>      +respectively.
>      +Other systems may support additional time bases.
>       .SH RETURN VALUE
>      -On success,
>      +.BR timespec_get ()
>     -+returns the nonzero value
>     ++returns the nonzero
>      +.I base
>     -+if it represents a supported time base
>     ++if it is a supported time base
>      +and the current time was successfully retrieved, or 0 otherwise.
>      +.P
>      +.BR timespec_getres ()
>     -+returns the nonzero value
>     ++returns the nonzero
>       .I base
>      -is returned.
>      -On error,
>     @@ man/man3/timespec_get.3: .SH SYNOPSIS
>      -Neither C nor POSIX specify this,
>      -but they don't really indicate it shouldn't happen, either.
>      -Don't rely on this.
>     -+if it represents a supported time base, or 0 otherwise.
>     ++if it is a supported time base, or 0 otherwise.
>       .SH ATTRIBUTES
>       For an explanation of the terms used in this section, see
>       .BR attributes (7).

LGTM.


Have a lovely day!
Alex

-- 
<https://www.alejandro-colomar.es/>

Attachment: signature.asc
Description: PGP signature


[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux