Re: [PATCH] Fix the man page

[Alejandro Colomar <alx@kernel.org>]

[-- Attachment #1.1: Type: text/plain, Size: 2234 bytes --]

Hi Zijun,

Here goes some review of the patch.

> Subject: [PATCH] Modify the documentation of gettimeofday()

Please use 'gettimeofday.2:' as a prefix for the subject line,
and have a more descriptive subject (most patches do modify
the documentation, but how?).

See CONTRIBUTING:
        -  Write a suitable subject line.  Make sure to mention the
           name(s) of the page(s) being patched.  Example:

              [patch] shmop.2: Add "(void *)" cast to RETURN VALUE

> 
> We find tv arg is allowed to be null in bionic so make the documentation more clear.
> 
> Cc: enh <enh@google.com>
> Signed-off-by: Alejandro Colomar <alx@kernel.org>
> ---
>  man2/gettimeofday.2 | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/man2/gettimeofday.2 b/man2/gettimeofday.2
> index 9d134fa49..43f3fd9ff 100644
> --- a/man2/gettimeofday.2
> +++ b/man2/gettimeofday.2
> @@ -175,6 +175,7 @@ .SS C library/kernel differences
>  .BR gettimeofday ()
>  is provided in the
>  .BR vdso (7).

A blank line should introduce the new paragraph, so add '.PP'.

> +The kernel accepts null for both time and timezone. The timezone argument is ignored by glibc and musl, and not passed to/from the kernel. Android's bionic passes the timezone argument to/from the kernel, but Android does not update the kernel timezone based on the device timezone in Settings, so the kernel's timezone is typically UTC.

Please respect the 80-column right margin.  If you use vim(1),
this may be useful to you:

     set colorcolumn=73,81

Also, please use semantic newlines.  See man-pages(7):

    Use semantic newlines
        In  the  source of a manual page, new sentences should be
        started on new lines, long sentences should be split into
        lines at clause breaks (commas, semicolons,  colons,  and
        so on), and long clauses should be split at phrase bound‐
        aries.   This  convention,  sometimes  known as "semantic
        newlines", makes it easier to see the effect of  patches,
        which often operate at the level of individual sentences,
        clauses, or phrases.

Cheers,
Alex

>  .SH STANDARDS
>  .TP
>  .BR gettimeofday ()
> -- 
> 2.40.1
> 

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]