public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: Salvatore Bonaccorso <carnil@debian.org>
To: Alejandro Colomar <alx@kernel.org>
Cc: linux-man@vger.kernel.org
Subject: Re: proc.5: Still refers to "described in more detail below" for splitted out manpages
Date: Fri, 12 Apr 2024 20:37:24 +0200	[thread overview]
Message-ID: <Zhl_ZOqOGkJizieb@eldamar.lan> (raw)
In-Reply-To: <ZhlzmymKd3XBq9Yh@debian>

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

Hi Alex,

On Fri, Apr 12, 2024 at 07:47:07PM +0200, Alejandro Colomar wrote:
> Hi Salvatore,
> 
> On Fri, Apr 12, 2024 at 07:21:11PM +0200, Salvatore Bonaccorso wrote:
> > Hi Alejandro
> > 
> > Back in August 2023, various parts were split out of proc(5) into
> > separate manpage. What seems to have remained from the split is the
> > mentioning:
> > 
> > [...]
> > 178 .P
> > 179 All of the above are described in more detail below.
> > [...]
> > 
> > I'm not sure what you would like to prefer, so I have no explict patch
> > here. But maybe this can be reworded to "All of the above are desribed
> > in sepate manpages prefixes with proc_"?
> 
> Thanks for catching this.  Yeah, something like that makes sense.
> 
> You could add to the commit message:
> 
> Fixes: 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page")

Thanks for the quick feedback. So please find attached the proposed
change. Let me know if you want something changed.

Regards,
Salvatore

[-- Attachment #2: 0001-proc.5-Refer-to-split-out-manpages-for-detailed-desc.patch --]
[-- Type: text/x-diff, Size: 1222 bytes --]

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
+.BR proc_.
+.TP
 .\"
 .\" .SH FILES
 .\" FIXME Describe /proc/[pid]/sessionid
-- 
2.43.0


  reply	other threads:[~2024-04-12 18:37 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-12 17:21 proc.5: Still refers to "described in more detail below" for splitted out manpages Salvatore Bonaccorso
2024-04-12 17:47 ` Alejandro Colomar
2024-04-12 18:37   ` Salvatore Bonaccorso [this message]
2024-04-12 19:51     ` Alejandro Colomar
2024-04-12 20:04       ` Salvatore Bonaccorso
2024-04-12 20:57         ` Alejandro Colomar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=Zhl_ZOqOGkJizieb@eldamar.lan \
    --to=carnil@debian.org \
    --cc=alx@kernel.org \
    --cc=linux-man@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox