[-v6,2/3] NOT kernel/man-pages man2/set_mempolicy.2: Add mode flag MPOL_F_NUMA_BALANCING

Commit Message

Huang, Ying Nov. 26, 2020, 5:32 a.m. UTC

From: Huang Ying <caritas@localhost>

Signed-off-by: "Huang, Ying" <[e-mail]>
---
 man2/set_mempolicy.2 | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Dave Hansen Nov. 30, 2020, 5:48 p.m. UTC | #1

On 11/25/20 9:32 PM, Huang Ying wrote:
> --- a/man2/set_mempolicy.2
> +++ b/man2/set_mempolicy.2
> @@ -113,6 +113,11 @@ A nonempty
>  .I nodemask
>  specifies node IDs that are relative to the set of
>  node IDs allowed by the process's current cpuset.
> +.TP
> +.BR MPOL_F_NUMA_BALANCING " (since Linux 5.11)"
> +Enable the Linux kernel NUMA balancing for the task if it is supported
> +by kernel.  If the flag isn't supported by Linux kernel, return -1 and
> +errno is set to EINVAL.

The one thing I learned about manpage CodingStyle is that new sentences
go on new lines.  I think this needs to be:

.TP
.BR MPOL_F_NUMA_BALANCING " (since Linux 5.11)"
Enable the Linux kernel NUMA balancing for the task if it is supported
by kernel.
If the flag isn't supported by Linux kernel, return -1 and errno is set
to EINVAL.

Huang, Ying Dec. 1, 2020, 12:27 a.m. UTC | #2

Dave Hansen <[e-mail]> writes:

> On 11/25/20 9:32 PM, Huang Ying wrote:
>> --- a/man2/set_mempolicy.2
>> +++ b/man2/set_mempolicy.2
>> @@ -113,6 +113,11 @@ A nonempty
>>  .I nodemask
>>  specifies node IDs that are relative to the set of
>>  node IDs allowed by the process's current cpuset.
>> +.TP
>> +.BR MPOL_F_NUMA_BALANCING " (since Linux 5.11)"
>> +Enable the Linux kernel NUMA balancing for the task if it is supported
>> +by kernel.  If the flag isn't supported by Linux kernel, return -1 and
>> +errno is set to EINVAL.
>
> The one thing I learned about manpage CodingStyle is that new sentences
> go on new lines.  I think this needs to be:
>
> .TP
> .BR MPOL_F_NUMA_BALANCING " (since Linux 5.11)"
> Enable the Linux kernel NUMA balancing for the task if it is supported
> by kernel.
> If the flag isn't supported by Linux kernel, return -1 and errno is set
> to EINVAL.

Thanks a lot for your information!  I will revise this in the next version.

Best Regards,
Huang, Ying

Patch

diff --git a/man2/set_mempolicy.2 b/man2/set_mempolicy.2
index 68011eecb..fb16bb351 100644
--- a/man2/set_mempolicy.2
+++ b/man2/set_mempolicy.2
@@ -113,6 +113,11 @@  A nonempty
 .I nodemask
 specifies node IDs that are relative to the set of
 node IDs allowed by the process's current cpuset.
+.TP
+.BR MPOL_F_NUMA_BALANCING " (since Linux 5.11)"
+Enable the Linux kernel NUMA balancing for the task if it is supported
+by kernel.  If the flag isn't supported by Linux kernel, return -1 and
+errno is set to EINVAL.
 .PP
 .I nodemask
 points to a bit mask of node IDs that contains up to
@@ -293,6 +298,9 @@  argument specified both
 .B MPOL_F_STATIC_NODES
 and
 .BR MPOL_F_RELATIVE_NODES .
+Or, the
+.B MPOL_F_NUMA_BALANCING
+isn't supported by the Linux kernel.
 .TP
 .B ENOMEM
 Insufficient kernel memory was available.