[PATCH] membarrier.2: Update prototype

[PATCH] membarrier.2: Update prototype

[Alejandro Colomar]

The Linux kernel now uses 'flags' and added a new argument: 'cpu_id'.
These changes were introduced to the kernel
in commit 2a36ab717e8fe678d98f81c14a0b124712719840.

Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
 man2/membarrier.2 | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/man2/membarrier.2 b/man2/membarrier.2
index 24a24ba86..42b7e2acc 100644
--- a/man2/membarrier.2
+++ b/man2/membarrier.2
@@ -23,6 +23,13 @@
 .\" %%%LICENSE_END
 .\"
 .TH MEMBARRIER 2 2020-06-09 "Linux" "Linux Programmer's Manual"
+.\" FIXME:
+.\" The Linux kernel now uses 'flags' and added a new argument: 'cpu_id'.
+.\" These changes were introduced to the kernel
+.\" in commit 2a36ab717e8fe678d98f81c14a0b124712719840.
+.\" The prototype has been updated,
+.\" but the new features have not yet been documented.
+.\" TODO: Document those new features.
 .SH NAME
 membarrier \- issue memory barriers on a set of threads
 .SH SYNOPSIS
@@ -30,7 +37,7 @@ membarrier \- issue memory barriers on a set of threads
 .PP
 .B #include <linux/membarrier.h>
 .PP
-.BI "int membarrier(int " cmd ", int " flags ");"
+.BI "int membarrier(int " cmd ", unsigned int " flags ", int " cpu_id );
 .fi
 .PP
 .IR Note :
-- 
2.28.0

Re: [PATCH] membarrier.2: Update prototype

[Mathieu Desnoyers]

----- On Nov 1, 2020, at 3:04 PM, Alejandro Colomar colomar.6.4.3@gmail.com wrote:

> The Linux kernel now uses 'flags' and added a new argument: 'cpu_id'.
> These changes were introduced to the kernel
> in commit 2a36ab717e8fe678d98f81c14a0b124712719840.

I doubt the proposed patch with a FIXME and a TODO is appropriate for the man pages project.
It does point out the fact that the membarrier man page needs updating following
Peter's commit though.

Peter (Oskolkov), can you contribute a patch detailing the new membarrier flags and cpu_id
arguments to the man pages project ?

Thanks,

Mathieu

> 
> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
> ---
> man2/membarrier.2 | 9 ++++++++-
> 1 file changed, 8 insertions(+), 1 deletion(-)
> 
> diff --git a/man2/membarrier.2 b/man2/membarrier.2
> index 24a24ba86..42b7e2acc 100644
> --- a/man2/membarrier.2
> +++ b/man2/membarrier.2
> @@ -23,6 +23,13 @@
> .\" %%%LICENSE_END
> .\"
> .TH MEMBARRIER 2 2020-06-09 "Linux" "Linux Programmer's Manual"
> +.\" FIXME:
> +.\" The Linux kernel now uses 'flags' and added a new argument: 'cpu_id'.
> +.\" These changes were introduced to the kernel
> +.\" in commit 2a36ab717e8fe678d98f81c14a0b124712719840.
> +.\" The prototype has been updated,
> +.\" but the new features have not yet been documented.
> +.\" TODO: Document those new features.
> .SH NAME
> membarrier \- issue memory barriers on a set of threads
> .SH SYNOPSIS
> @@ -30,7 +37,7 @@ membarrier \- issue memory barriers on a set of threads
> .PP
> .B #include <linux/membarrier.h>
> .PP
> -.BI "int membarrier(int " cmd ", int " flags ");"
> +.BI "int membarrier(int " cmd ", unsigned int " flags ", int " cpu_id );
> .fi
> .PP
> .IR Note :
> --
> 2.28.0

-- 
Mathieu Desnoyers
EfficiOS Inc.
http://www.efficios.com

Re: [PATCH] membarrier.2: Update prototype

[Alejandro Colomar]

On 2020-11-02 13:30, Mathieu Desnoyers wrote:
> ----- On Nov 1, 2020, at 3:04 PM, Alejandro Colomar colomar.6.4.3@gmail.com wrote:
> 
>> The Linux kernel now uses 'flags' and added a new argument: 'cpu_id'.
>> These changes were introduced to the kernel
>> in commit 2a36ab717e8fe678d98f81c14a0b124712719840.
> 
> I doubt the proposed patch with a FIXME and a TODO is appropriate for the man pages project.
> It does point out the fact that the membarrier man page needs updating following
> Peter's commit though.

Hi Mathieu,

Agree; I didn't intend this to be directly applied,
but to attract the attention of someone who knows the details,
and hopefully fix the whole issue at once :)

Thanks,

Alex

> 
> Peter (Oskolkov), can you contribute a patch detailing the new membarrier flags and cpu_id
> arguments to the man pages project ?
> 
> Thanks,
> 
> Mathieu
> 
>>
>> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
>> ---
>> man2/membarrier.2 | 9 ++++++++-
>> 1 file changed, 8 insertions(+), 1 deletion(-)
>>
>> diff --git a/man2/membarrier.2 b/man2/membarrier.2
>> index 24a24ba86..42b7e2acc 100644
>> --- a/man2/membarrier.2
>> +++ b/man2/membarrier.2
>> @@ -23,6 +23,13 @@
>> .\" %%%LICENSE_END
>> .\"
>> .TH MEMBARRIER 2 2020-06-09 "Linux" "Linux Programmer's Manual"
>> +.\" FIXME:
>> +.\" The Linux kernel now uses 'flags' and added a new argument: 'cpu_id'.
>> +.\" These changes were introduced to the kernel
>> +.\" in commit 2a36ab717e8fe678d98f81c14a0b124712719840.
>> +.\" The prototype has been updated,
>> +.\" but the new features have not yet been documented.
>> +.\" TODO: Document those new features.
>> .SH NAME
>> membarrier \- issue memory barriers on a set of threads
>> .SH SYNOPSIS
>> @@ -30,7 +37,7 @@ membarrier \- issue memory barriers on a set of threads
>> .PP
>> .B #include <linux/membarrier.h>
>> .PP
>> -.BI "int membarrier(int " cmd ", int " flags ");"
>> +.BI "int membarrier(int " cmd ", unsigned int " flags ", int " cpu_id );
>> .fi
>> .PP
>> .IR Note :
>> --
>> 2.28.0
> 

Re: [PATCH] membarrier.2: Update prototype

[Peter Oskolkov]

On Mon, Nov 2, 2020 at 4:30 AM Mathieu Desnoyers
<mathieu.desnoyers@efficios.com> wrote:
>
> ----- On Nov 1, 2020, at 3:04 PM, Alejandro Colomar colomar.6.4.3@gmail.com wrote:
>
> > The Linux kernel now uses 'flags' and added a new argument: 'cpu_id'.
> > These changes were introduced to the kernel
> > in commit 2a36ab717e8fe678d98f81c14a0b124712719840.
>
[...]
> Peter (Oskolkov), can you contribute a patch detailing the new membarrier flags and cpu_id
> arguments to the man pages project ?

Yes, sure, I'll prepare a patch in the next day or two.

Thanks,
Peter

[...]