Re: proc.5: Still refers to "described in more detail below" for splitted out manpages

[Alejandro Colomar <alx@kernel.org>]

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

Hi Salvatore,

On Fri, Apr 12, 2024 at 10:04:27PM +0200, Salvatore Bonaccorso wrote:
> Hi,
> 
> On Fri, Apr 12, 2024 at 09:51:56PM +0200, Alejandro Colomar wrote:
> > Hi Salvatore,
> > 
> > On Fri, Apr 12, 2024 at 08:37:24PM +0200, Salvatore Bonaccorso wrote:
> > > Thanks for the quick feedback. So please find attached the proposed
> > > change. Let me know if you want something changed.
> > 
> > You're welcome!
> > 
> > > From 07bf84cbb2e78595b4514fe820ae5574bba8d0ec Mon Sep 17 00:00:00 2001
> > > From: Salvatore Bonaccorso <carnil@debian.org>
> > > Date: Fri, 12 Apr 2024 20:29:06 +0200
> > > Subject: [PATCH] proc.5: Refer to split out manpages for detailed description
> > > 
> > > Back in August 2023 various parts of proc(5) were split out int separate
> > > manpages. The final cleanup in 92cdcec79df0 ("proc.5: Clean up after
> > > making sashimi of this page") missed to as well refer to the split out
> > > manpages and retained the wording that details are found further below
> > > in the manpages for the various files.
> > > 
> > > Fixes: 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page")
> > > Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
> > > ---
> > >  man5/proc.5 | 5 ++++-
> > >  1 file changed, 4 insertions(+), 1 deletion(-)
> > > 
> > > diff --git a/man5/proc.5 b/man5/proc.5
> > > index bdc47456bdce..4c20920e1e3c 100644
> > > --- a/man5/proc.5
> > > +++ b/man5/proc.5
> > > @@ -176,7 +176,10 @@ Various other files and subdirectories under
> > >  .I /proc
> > >  expose system-wide information.
> > >  .P
> > > -All of the above are described in more detail below.
> > > +All of the above are described in more detail in separate manpages
> > > +prefixed with
> > 
> > Maybe I'd reword to say "whose name starts with".
> 
> So "whose names start with" as there are multiple manpages?

Sure.

> > > +.BR proc_.
> > 
> > This would need a space before the '.'.
> 
> Ah right added.
> 
> > > +.TP
> > 
> > Why TP?
> 
> Because I stupidly copy-pasted lines and did not properly adjust and
> rechecked.

:)

> 
> > Have a lovely night!
> > Alex
> > 
> > >  .\"
> > >  .\" .SH FILES
> > >  .\" FIXME Describe /proc/[pid]/sessionid
> > > -- 
> > > 2.43.0
> 
> Quite imbarassing doing so many errors in one go.

Not so many.  And a patch applied in v2 is rather rare here.  ;)

> Attached is the
> revisited version.
> 
> Changes in v2:
> - Reword as suggested "whose names start with"
> - Add missing space in hilighted proc_ 
> - Drop superflous .TP (from a copy paste error)
> 
> Regards,
> Salvatore

> From 7753658486c2ee2b1d50df2811dcef6af335378b Mon Sep 17 00:00:00 2001
> From: Salvatore Bonaccorso <carnil@debian.org>
> Date: Fri, 12 Apr 2024 20:29:06 +0200
> Subject: [PATCH] proc.5: Refer to split out manpages for detailed description
> 
> Back in August 2023 various parts of proc(5) were split out int separate
> manpages. The final cleanup in 92cdcec79df0 ("proc.5: Clean up after
> making sashimi of this page") missed to as well refer to the split out
> manpages and retained the wording that details are found further below
> in the manpages for the various files.
> 
> Fixes: 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page")
> Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>

LGTM.  Patch applied!  Thanks.
<https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/commit/?h=contrib&id=79a0af0c9091cb2e1bd09cd4492480b12be89089>


Have a lovely night!
Alex

> ---
>  man5/proc.5 | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/man5/proc.5 b/man5/proc.5
> index bdc47456bdce..8022ca49ee68 100644
> --- a/man5/proc.5
> +++ b/man5/proc.5
> @@ -176,7 +176,9 @@ Various other files and subdirectories under
>  .I /proc
>  expose system-wide information.
>  .P
> -All of the above are described in more detail below.
> +All of the above are described in more detail in separate manpages
> +whose names start with
> +.BR proc_ .
>  .\"
>  .\" .SH FILES
>  .\" FIXME Describe /proc/[pid]/sessionid
> -- 
> 2.43.0
> 


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

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