Re: [PATCH v1 3/4] man/man2/utime.2: SYNOPSIS: ffix

[Alejandro Colomar <alx@kernel.org>]

[-- Attachment #1: Type: text/plain, Size: 1943 bytes --]

Hi Seth,

On Tue, Dec 30, 2025 at 04:42:02PM +1000, seth.i.mcdonald@gmail.com wrote:
> From: Seth McDonald <sethmcmail@pm.me>
> 
> Increments the indentation of the times parameter in the utimes(2)
> prototype by one space.
> 
> Signed-off-by: Seth McDonald <sethmcmail@pm.me>
> ---
>  man/man2/utime.2 | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/man/man2/utime.2 b/man/man2/utime.2
> index 94307a5b90..e044f15b06 100644
> --- a/man/man2/utime.2
> +++ b/man/man2/utime.2
> @@ -18,7 +18,7 @@ .SH SYNOPSIS
>  .B #include <sys/time.h>
>  .P
>  .BI "int utimes(const char *" path ,
> -.BI "          const struct timeval " times "[_Nullable 2]);"
> +.BI "           const struct timeval " times "[_Nullable 2]);"

The current formatting is intended, and documented in man-pages(7):

     In  the SYNOPSIS, a long function prototype may need to be
     continued over to the next line.  The continuation line is
     indented according to the following rules:

[...]

     (2)  But, where multiple functions in the SYNOPSIS require
          continuation  lines, and the function names have dif‐
          ferent lengths, then align all continuation lines  to
          start in the same column.  This provides a nicer ren‐
          dering  in  PDF  output  (because the SYNOPSIS uses a
          variable width font where spaces render narrower than
          most characters).  As an example:

              int getopt(int argc, char * const argv[],
                         const char *optstring);
              int getopt_long(int argc, char * const argv[],
                         const char *optstring,
                         const struct option *longopts, int *longindex);


Have a lovely day!
Alex

P.S.:  These patches work correctly.  :)

>  .fi
>  .SH DESCRIPTION
>  .B Note:
> -- 
> 2.47.3
> 
> 

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

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