Re: [PATCH v3] man2: add MPOL_WEIGHTED_INTERLEAVE documentation

[Alejandro Colomar <alx@kernel.org>]

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

Hi Svetly,

On Sat, Mar 16, 2024 at 07:21:21PM +0000, Svetly Todorov wrote:
> Hi Alex,
> 
> Happy Saturday.

Have a lovely Saturday!

> >> diff --git a/man2/get_mempolicy.2 b/man2/get_mempolicy.2
> >> index 5248f04ba..03550331d 100644
> >> --- a/man2/get_mempolicy.2
> >> +++ b/man2/get_mempolicy.2
> >> @@ -137,7 +137,9 @@ specifies
> >> but not
> >> .BR MPOL_F_ADDR ,
> >> and the thread's current policy is
> >> -.BR MPOL_INTERLEAVE ,
> >> +.BR MPOL_INTERLEAVE
> > 
> > This should be B, not BR (BR is for alternating Bold and Roman).
> 
> Can’t believe I missed that!
> 
> > Or,
> >> 
> >> .I flags
> >> specified
> >> diff --git a/man2/mbind.2 b/man2/mbind.2
> >> index b0e961f9c..6f85dec0e 100644
> >> --- a/man2/mbind.2
> >> +++ b/man2/mbind.2
> >> @@ -105,6 +105,7 @@ argument must specify one of
> >> .BR MPOL_DEFAULT ,
> >> .BR MPOL_BIND ,
> >> .BR MPOL_INTERLEAVE ,
> >> +.BR MPOL_WEIGHTED_INTERLEAVE ,
> >> .BR MPOL_PREFERRED ,
> >> or
> >> .B MPOL_LOCAL
> >> @@ -243,6 +244,22 @@ at least 1\ MB or bigger with a fairly uniform access pattern.
> >> Accesses to a single page of the area will still be limited to
> >> the memory bandwidth of a single node.
> >> .TP
> >> +.B MPOL_WEIGHTED_INTERLEAVE
> >> +This mode interleaves page allocations across the nodes specified in
> >> +.I nodemask
> >> +according to the weights in
> >> +.IR /sys/kernel/mm/mempolicy/weighted_interleave .
> >> +For example, if bits 0, 2, and 5 are raised in
> >> +.IR nodemask ,
> >> +and the contents of
> >> +.IR /sys/kernel/mm/mempolicy/weighted_interleave/node0 ,
> >> +.IR /sys/.../node2 ,
> > 
> > Since ... is variable stuff inside an italicised word, according to the
> > groff_man_style(7) paragraph I quoted, it should be in Roman.  So,
> > 
> > .IR /sys/ ... /node2 ,
> > 
> > Also, for better formatting of the '...', we use \| between the dots,
> > which on proportional fonts (in PDF, or HTML, for example) will produce
> > nicer elipses.  So,
> > 
> > .IR /sys/ .\|.\|. /node2 ,
> 
> This I was more unsure about.
> I saw the quoted portion of groff (7) but since
> the ellipses are a stand-in 'kernel/mm/mempolicy’, I figured
> they technically *weren’t* a variable region, so I left them italicized...
> 
> I dunno. I was pretty fried yesterday. I’ll follow your lead on this,
> and thank you for the \| tip.

The rule I follow to not have to think too much about it is:
if the user can copy it verbatim, then it's not a variable; otherwise,
it is.  :)

Cheers,
Alex

> 
> Svetly
> 

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

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