Re: [PATCH v2] man*/: srcfix

[Alejandro Colomar <alx@kernel.org>]

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

On 2023-07-30 21:32, G. Branden Robinson wrote:
> Clean up in preparation for "MR sed".
> 
> Format only one man page cross reference per input line.
> 
> Also, since groff 1.23.0 (and Plan 9 from User Space's) `MR` is not a
> font style alternation macro, there is no "reversed" form as with `BR`
> and `RB`.  So when a man page cross reference must be immediately
> preceded by punctuation, put that punctuation on the previous text line
> and use the `\c` escape sequence to connect them.
> 
> Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com>
> ---
>  man2/eventfd.2         |  4 +++-
>  man2/open.2            |  9 +++++++--
>  man2/perf_event_open.2 |  7 ++++++-
>  man2/signalfd.2        |  4 +++-
>  man2/timerfd_create.2  |  4 +++-
>  man5/proc.5            |  4 +++-
>  man7/credentials.7     | 15 ++++++++++-----
>  man7/pty.7             |  5 ++++-
>  man7/spufs.7           |  6 +++++-
>  9 files changed, 44 insertions(+), 14 deletions(-)
> 
> diff --git a/man2/eventfd.2 b/man2/eventfd.2
> index 2bd781bdf..003a64eb6 100644
> --- a/man2/eventfd.2
> +++ b/man2/eventfd.2
> @@ -142,7 +142,9 @@ .SH DESCRIPTION
>  if the size of the supplied buffer is less than 8 bytes,
>  or if an attempt is made to write the value 0xffffffffffffffff.
>  .TP
> -.BR poll "(2), " select "(2) (and similar)"
> +.BR poll (2),\~\c
> +.BR select (2)\~\c
> +(and similar)
>  The returned file descriptor supports
>  .BR poll (2)
>  (and analogously
> diff --git a/man2/open.2 b/man2/open.2
> index 4c921723c..6603dfdff 100644
> --- a/man2/open.2
> +++ b/man2/open.2
> @@ -82,8 +82,13 @@ .SH DESCRIPTION
>  to an entry in the process's table of open file descriptors.
>  The file descriptor is used
>  in subsequent system calls
> -.RB ( read "(2), " write "(2), " lseek "(2), " fcntl (2),
> -etc.) to refer to the open file.
> +(\c
> +.BR read (2),
> +.BR write (2),
> +.BR lseek (2),
> +.BR fcntl (2),
> +etc.)
> +to refer to the open file.
>  The file descriptor returned by a successful call will be
>  the lowest-numbered file descriptor not currently open for the process.
>  .PP
> diff --git a/man2/perf_event_open.2 b/man2/perf_event_open.2
> index aa23a4977..40686917b 100644
> --- a/man2/perf_event_open.2
> +++ b/man2/perf_event_open.2
> @@ -32,7 +32,12 @@ .SH DESCRIPTION
>  Given a list of parameters,
>  .BR perf_event_open ()
>  returns a file descriptor, for use in subsequent system calls
> -.RB ( read "(2), " mmap "(2), " prctl "(2), " fcntl "(2), etc.)."
> +(\c
> +.BR read (2),
> +.BR mmap (2),
> +.BR prctl (2),
> +.BR fcntl (2),
> +etc.).
>  .PP
>  A call to
>  .BR perf_event_open ()
> diff --git a/man2/signalfd.2 b/man2/signalfd.2
> index 2b97c4640..9d0708799 100644
> --- a/man2/signalfd.2
> +++ b/man2/signalfd.2
> @@ -131,7 +131,9 @@ .SH DESCRIPTION
>  .B EAGAIN
>  if the file descriptor has been made nonblocking.
>  .TP
> -.BR poll "(2), " select "(2) (and similar)"
> +.BR poll (2),\~\c
> +.BR select (2)\~\c
> +(and similar)
>  The file descriptor is readable
>  (the
>  .BR select (2)
> diff --git a/man2/timerfd_create.2 b/man2/timerfd_create.2
> index d68206b05..9ba0dd315 100644
> --- a/man2/timerfd_create.2
> +++ b/man2/timerfd_create.2
> @@ -317,7 +317,9 @@ .SS Operating on a timer file descriptor
>  .BR read (2)
>  on the file descriptor.
>  .TP
> -.BR poll "(2), " select "(2) (and similar)"
> +.BR poll (2),\~\c
> +.BR select (2)\~\c
> +(and similar)
>  The file descriptor is readable
>  (the
>  .BR select (2)
> diff --git a/man5/proc.5 b/man5/proc.5
> index 04b45ccb7..fd51dcec0 100644
> --- a/man5/proc.5
> +++ b/man5/proc.5
> @@ -3459,7 +3459,9 @@ .SS Files and directories
>  .TP
>  .I /proc/locks
>  This file shows current file locks
> -.RB ( flock "(2) and " fcntl (2))
> +.RB ( flock (2)

I guess you'll want a \c before flock(2).  RM ain't no macro.  :)

Cheers,
Alex

> +and
> +.BR fcntl (2))
>  and leases
>  .RB ( fcntl (2)).
>  .IP
> diff --git a/man7/credentials.7 b/man7/credentials.7
> index 77cb5e0ef..b07f150bd 100644
> --- a/man7/credentials.7
> +++ b/man7/credentials.7
> @@ -267,21 +267,26 @@ .SS Modifying process user and group IDs
>  Subject to rules described in the relevant manual pages,
>  a process can use the following APIs to modify its user and group IDs:
>  .TP
> -.BR setuid "(2) (" setgid (2))
> +.BR setuid (2)\~(\c
> +.BR setgid (2))
>  Modify the process's real (and possibly effective and saved-set)
>  user (group) IDs.
>  .TP
> -.BR seteuid "(2) (" setegid (2))
> +.BR seteuid (2)\~(\c
> +.BR setegid (2))
>  Modify the process's effective user (group) ID.
>  .TP
> -.BR setfsuid "(2) (" setfsgid (2))
> +.BR setfsuid (2)\~(\c
> +.BR setfsgid (2))
>  Modify the process's filesystem user (group) ID.
>  .TP
> -.BR setreuid "(2) (" setregid (2))
> +.BR setreuid (2)\~(\c
> +.BR setregid (2))
>  Modify the process's real and effective (and possibly saved-set)
>  user (group) IDs.
>  .TP
> -.BR setresuid "(2) (" setresgid (2))
> +.BR setresuid (2)\~(\c
> +.BR setresgid (2))
>  Modify the process's real, effective, and saved-set user (group) IDs.
>  .TP
>  .BR setgroups (2)
> diff --git a/man7/pty.7 b/man7/pty.7
> index bef60e931..3f23be44d 100644
> --- a/man7/pty.7
> +++ b/man7/pty.7
> @@ -122,7 +122,10 @@ .SH FILES
>  BSD slave devices
>  .SH NOTES
>  Pseudoterminals are used by applications such as network login services
> -.RB ( ssh "(1), " rlogin "(1), " telnet (1)),
> +(\c
> +.BR ssh (1),
> +.BR rlogin (1),
> +.BR telnet (1)),
>  terminal emulators such as
>  .BR xterm (1),
>  .BR script (1),
> diff --git a/man7/spufs.7 b/man7/spufs.7
> index 39fdf583a..96b100b8c 100644
> --- a/man7/spufs.7
> +++ b/man7/spufs.7
> @@ -119,7 +119,11 @@ .SS Files
>  file are:
>  .RS
>  .TP
> -.BR read "(2), " pread "(2), " write "(2), " pwrite "(2), " lseek (2)
> +.BR read (2),\~\c
> +.BR pread (2),\~\c
> +.BR write (2),\~\c
> +.BR pwrite (2),\~\c
> +.BR lseek (2)
>  These operate as usual, with the exception that
>  .BR lseek (2),
>  .BR write (2),

-- 
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5


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