[PATCH v2] proc.5: document 'subset' mount option.

[PATCH v2] proc.5: document 'subset' mount option.

[technoboy85]

From: Matteo Croce <teknoraver@meta.com>

The 'subset=pid' option was added in commit 6814ef2d, document it.

Signed-off-by: Matteo Croce <teknoraver@meta.com>
---
 man/man5/proc.5 | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/man/man5/proc.5 b/man/man5/proc.5
index 8022ca49e..2567387d3 100644
--- a/man/man5/proc.5
+++ b/man/man5/proc.5
@@ -105,7 +105,12 @@ This group should be used instead of approaches such as putting
 nonroot users into the
 .BR sudoers (5)
 file.
-.\"
+.RE
+.TP
+.BR subset "=\fBpid\fP (since Linux 5.8)"
+.\" commit 6814ef2d992af09451bbeda4770daa204461329e
+Show only the specified subset of procfs hiding all top level files
+and directories in the procfs that are not related to tasks.
 .SS Overview
 Underneath
 .IR /proc ,
-- 
2.43.0

Re: [PATCH v2] proc.5: document 'subset' mount option.

[Alejandro Colomar]

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

On Tue, May 14, 2024 at 09:21:10PM GMT, technoboy85@gmail.com wrote:
> From: Matteo Croce <teknoraver@meta.com>
> 
> The 'subset=pid' option was added in commit 6814ef2d, document it.
> 
> Signed-off-by: Matteo Croce <teknoraver@meta.com>
> ---
>  man/man5/proc.5 | 7 ++++++-
>  1 file changed, 6 insertions(+), 1 deletion(-)
> 
> diff --git a/man/man5/proc.5 b/man/man5/proc.5
> index 8022ca49e..2567387d3 100644
> --- a/man/man5/proc.5
> +++ b/man/man5/proc.5
> @@ -105,7 +105,12 @@ This group should be used instead of approaches such as putting
>  nonroot users into the
>  .BR sudoers (5)
>  file.
> -.\"
> +.RE
> +.TP
> +.BR subset "=\fBpid\fP (since Linux 5.8)"

This can be simplified as:

.BR subset = pid " (since Linux 5.8)"

> +.\" commit 6814ef2d992af09451bbeda4770daa204461329e
> +Show only the specified subset of procfs hiding all top level files
> +and directories in the procfs that are not related to tasks.
>  .SS Overview
>  Underneath
>  .IR /proc ,
> -- 
> 2.43.0
> 

-- 
<https://www.alejandro-colomar.es/>
A client is hiring kernel driver, mm, and/or crypto developers;
contact me if interested.

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

Re: [PATCH v2] proc.5: document 'subset' mount option.

[G. Branden Robinson]

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

Hi Alex,

At 2024-05-14T21:54:42+0200, Alejandro Colomar wrote:
> > +.BR subset "=\fBpid\fP (since Linux 5.8)"
> 
> This can be simplified as:
> 
> .BR subset = pid " (since Linux 5.8)"

It appears to me that all of the equals signs in mount options in this
page should be bold.  They are literal, after all...

So this would simplify further to:

.BR subset=pid " (since Linux 5.8)"

...which might look almost non-mystical to man(7) novices.

Regards,
Branden

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

Re: [PATCH v2] proc.5: document 'subset' mount option.

[Matteo Croce]

Il giorno mar 14 mag 2024 alle ore 22:15 G. Branden Robinson
<g.branden.robinson@gmail.com> ha scritto:
>
> Hi Alex,
>
> At 2024-05-14T21:54:42+0200, Alejandro Colomar wrote:
> > > +.BR subset "=\fBpid\fP (since Linux 5.8)"
> >
> > This can be simplified as:
> >
> > .BR subset = pid " (since Linux 5.8)"
>
> It appears to me that all of the equals signs in mount options in this
> page should be bold.  They are literal, after all...
>
> So this would simplify further to:
>
> .BR subset=pid " (since Linux 5.8)"
>
> ...which might look almost non-mystical to man(7) novices.
>
> Regards,
> Branden

Could be, but that could be done all in once in a further refactor, I
don't want to change the document style within this change.

Regards,
-- 
Matteo Croce

perl -e 'for($t=0;;$t++){print chr($t*($t>>8|$t>>13)&255)}' |aplay

Re: [PATCH v2] proc.5: document 'subset' mount option.

[Alejandro Colomar]

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

On Tue, May 14, 2024 at 10:25:50PM GMT, Matteo Croce wrote:
> Il giorno mar 14 mag 2024 alle ore 22:15 G. Branden Robinson
> <g.branden.robinson@gmail.com> ha scritto:
> >
> > Hi Alex,
> >
> > At 2024-05-14T21:54:42+0200, Alejandro Colomar wrote:
> > > > +.BR subset "=\fBpid\fP (since Linux 5.8)"
> > >
> > > This can be simplified as:
> > >
> > > .BR subset = pid " (since Linux 5.8)"
> >
> > It appears to me that all of the equals signs in mount options in this
> > page should be bold.  They are literal, after all...
> >
> > So this would simplify further to:
> >
> > .BR subset=pid " (since Linux 5.8)"
> >
> > ...which might look almost non-mystical to man(7) novices.
> >
> > Regards,
> > Branden
> 
> Could be, but that could be done all in once in a further refactor, I
> don't want to change the document style within this change.

Agree; a separate patch is better for that refactor.

And yep, the = is better as bold, since it's also literal.

Have a lovely night!
Alex

-- 
<https://www.alejandro-colomar.es/>
A client is hiring kernel driver, mm, and/or crypto developers;
contact me if interested.

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