Hi Branden,
On Wed, Oct 25, 2023 at 01:54:24PM -0500, G. Branden Robinson wrote:
> Clean up in preparation for "MR sed".
>
> Format only one man page cross reference per input line.
>
> Also, groff 1.23.0's (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@xxxxxxxxx>
> ---
> man2/open.2 | 9 +++++++--
> man2/perf_event_open.2 | 7 ++++++-
> man5/proc_locks.5 | 10 ++++++----
> man7/credentials.7 | 15 ++++++++++-----
> man7/pty.7 | 5 ++++-
> 5 files changed, 33 insertions(+), 13 deletions(-)
>
> 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
I'm going to disagree with Ingo with his claim that a macro that forces
using \c is bad because it promotes bad style. '(\c' doesn't look bad
to me here. Not more than having the leading punctuation as an Nth
argument.
> +.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 44a2ecbeb..4a0bfe65e 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/man5/proc_locks.5 b/man5/proc_locks.5
> index cf4ff678c..a938e4ad7 100644
> --- a/man5/proc_locks.5
> +++ b/man5/proc_locks.5
> @@ -10,10 +10,12 @@ .SH NAME
> .SH DESCRIPTION
> .TP
> .I /proc/locks
> -This file shows current file locks
> -.RB ( flock "(2) and " fcntl (2))
> -and leases
> -.RB ( fcntl (2)).
> +This file shows current file locks (\c
For consistency with the above two cases, I think you should move that
(\c to a new line. It also reduces the diff (semantic newlines any?) :)
Cheers,
Alex
> +.BR flock (2)
> +and
> +.BR fcntl (2))
> +and leases (\c
> +.BR fcntl (2)).
> .IP
> An example of the content shown in this file is the following:
> .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),
> --
> 2.30.2
>
--
<https://www.alejandro-colomar.es/>
Attachment:
signature.asc
Description: PGP signature
