[PATCH] mmap.2: fix missing text

[PATCH] mmap.2: fix missing text

[Avinesh Kumar]

Signed-off-by: Avinesh Kumar <akumar@suse.de>
---
 man2/mmap.2 | 1 +
 1 file changed, 1 insertion(+)

diff --git a/man2/mmap.2 b/man2/mmap.2
index d0530be0f..9de6b2796 100644
--- a/man2/mmap.2
+++ b/man2/mmap.2
@@ -629,6 +629,7 @@ and is not a member of the
 group; see the description of
 .I /proc/sys/vm/sysctl_hugetlb_shm_group
 in
+.BR proc (5).
 .TP
 .B ETXTBSY
 .B MAP_DENYWRITE
-- 
2.41.0

Re: [PATCH] mmap.2: fix missing text

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 853 bytes --]

Hi Avinesh,

On 2023-08-25 17:59, Avinesh Kumar wrote:
> Signed-off-by: Avinesh Kumar <akumar@suse.de>
> ---
>  man2/mmap.2 | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/man2/mmap.2 b/man2/mmap.2
> index d0530be0f..9de6b2796 100644
> --- a/man2/mmap.2
> +++ b/man2/mmap.2
> @@ -629,6 +629,7 @@ and is not a member of the
>  group; see the description of
>  .I /proc/sys/vm/sysctl_hugetlb_shm_group
>  in
> +.BR proc (5).

Was this text accidentally lost in some patch, or was it never added?
If it was there once, please add a "Fixes: ..." tag for it.

Also, proc(5) was recently cut into little sashimi pieces.  You want
to refer to proc_sys(5).

Cheers,
Alex

>  .TP
>  .B ETXTBSY
>  .B MAP_DENYWRITE

-- 
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5


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

Re: [PATCH] mmap.2: fix missing text

[Avinesh Kumar]

Hi Alex,

On Friday, August 25, 2023 11:22:29 PM IST Alejandro Colomar wrote:
> Hi Avinesh,
> 
> On 2023-08-25 17:59, Avinesh Kumar wrote:
> > Signed-off-by: Avinesh Kumar <akumar@suse.de>
> > ---
> > 
> >  man2/mmap.2 | 1 +
> >  1 file changed, 1 insertion(+)
> > 
> > diff --git a/man2/mmap.2 b/man2/mmap.2
> > index d0530be0f..9de6b2796 100644
> > --- a/man2/mmap.2
> > +++ b/man2/mmap.2
> > @@ -629,6 +629,7 @@ and is not a member of the
> > 
> >  group; see the description of
> >  .I /proc/sys/vm/sysctl_hugetlb_shm_group
> >  in
> > 
> > +.BR proc (5).
> 
> Was this text accidentally lost in some patch, or was it never added?
> If it was there once, please add a "Fixes: ..." tag for it.
I am not sure if it was ever there.
> 
> Also, proc(5) was recently cut into little sashimi pieces.  You want
> to refer to proc_sys(5).
Ah.. Thanks for pointing this out, I just checked that thread. I'll send the 
updated patch if you are fine with no "Fixes:" tag for this.
> 
> Cheers,
> Alex
> 
> >  .TP
> >  .B ETXTBSY
> >  .B MAP_DENYWRITE

--
Regards,
Avinesh

Re: [PATCH] mmap.2: fix missing text

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 1796 bytes --]

Hi Avinesh,

On 2023-08-28 15:28, Avinesh Kumar wrote:
>> Was this text accidentally lost in some patch, or was it never added?
>> If it was there once, please add a "Fixes: ..." tag for it.
> I am not sure if it was ever there.

It was never there, it seems.

$ git show 090fdddb43 -- man2/mmap.2
commit 090fdddb4342f92a1dbeba687462f4bcee816232
Author: Michael Kerrisk <mtk.manpages@gmail.com>
Date:   Mon May 17 15:31:08 2021 +1200

    memfd_create.2, mmap.2, shmget.2: Document the EPERM for huge page allocations
    
    This error can occur if the caller is does not have CAP_IPC_LOCK
    and is not a member of the sysctl_hugetlb_shm_group.
    
    Reported-by: Yang Xu <xuyang2018.jy@fujitsu.com>
    Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>

diff --git a/man2/mmap.2 b/man2/mmap.2
index 03f2eeb2c..4ee2f4f96 100644
--- a/man2/mmap.2
+++ b/man2/mmap.2
@@ -628,6 +628,18 @@ .SH ERRORS
 The operation was prevented by a file seal; see
 .BR fcntl (2).
 .TP
+.B EPERM
+The
+.B MAP_HUGETLB
+flag was specified, but the caller was not privileged (did not have the
+.B CAP_IPC_LOCK
+capability)
+and is not a member of the
+.I sysctl_hugetlb_shm_group
+group; see the description of
+.I /proc/sys/vm/sysctl_hugetlb_shm_group
+in
+.TP
 .B ETXTBSY
 .B MAP_DENYWRITE
 was set but the object specified by

>>
>> Also, proc(5) was recently cut into little sashimi pieces.  You want
>> to refer to proc_sys(5).
> Ah.. Thanks for pointing this out, I just checked that thread. I'll send the 
> updated patch if you are fine with no "Fixes:" tag for this.


Please add a Fixes mentioning that commit above.

Cheers,
Alex

-- 
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5


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

Re: [PATCH] mmap.2: fix missing text

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 2111 bytes --]

On 2023-08-29 11:43, Alejandro Colomar wrote:
> Hi Avinesh,
> 
> On 2023-08-28 15:28, Avinesh Kumar wrote:
>>> Was this text accidentally lost in some patch, or was it never added?
>>> If it was there once, please add a "Fixes: ..." tag for it.
>> I am not sure if it was ever there.
> 
> It was never there, it seems.
> 
> $ git show 090fdddb43 -- man2/mmap.2
> commit 090fdddb4342f92a1dbeba687462f4bcee816232
> Author: Michael Kerrisk <mtk.manpages@gmail.com>
> Date:   Mon May 17 15:31:08 2021 +1200
> 
>     memfd_create.2, mmap.2, shmget.2: Document the EPERM for huge page allocations
>     
>     This error can occur if the caller is does not have CAP_IPC_LOCK
>     and is not a member of the sysctl_hugetlb_shm_group.
>     
>     Reported-by: Yang Xu <xuyang2018.jy@fujitsu.com>
>     Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
> 
> diff --git a/man2/mmap.2 b/man2/mmap.2
> index 03f2eeb2c..4ee2f4f96 100644
> --- a/man2/mmap.2
> +++ b/man2/mmap.2
> @@ -628,6 +628,18 @@ .SH ERRORS
>  The operation was prevented by a file seal; see
>  .BR fcntl (2).
>  .TP
> +.B EPERM
> +The
> +.B MAP_HUGETLB
> +flag was specified, but the caller was not privileged (did not have the
> +.B CAP_IPC_LOCK
> +capability)
> +and is not a member of the
> +.I sysctl_hugetlb_shm_group
> +group; see the description of
> +.I /proc/sys/vm/sysctl_hugetlb_shm_group
> +in
> +.TP
>  .B ETXTBSY
>  .B MAP_DENYWRITE
>  was set but the object specified by
> 
>>>
>>> Also, proc(5) was recently cut into little sashimi pieces.  You want
>>> to refer to proc_sys(5).
>> Ah.. Thanks for pointing this out, I just checked that thread. I'll send the 
>> updated patch if you are fine with no "Fixes:" tag for this.
> 
> 
> Please add a Fixes mentioning that commit above.

Never mind.  I'll do it myself while applying.

Fixes: 090fdddb4342 ("memfd_create.2, mmap.2, shmget.2: Document the EPERM for huge page allocations")

> 
> Cheers,
> Alex
> 

-- 
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5


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

Re: [PATCH] mmap.2: fix missing text

[Avinesh Kumar]

Hi Alex,

On Tuesday, August 29, 2023 3:13:17 PM IST Alejandro Colomar wrote:
> Hi Avinesh,
> 
> On 2023-08-28 15:28, Avinesh Kumar wrote:
> >> Was this text accidentally lost in some patch, or was it never added?
> >> If it was there once, please add a "Fixes: ..." tag for it.
> > 
> > I am not sure if it was ever there.
> 
> It was never there, it seems.
Thank you for digging and confirming this. I've send the v2 with "Fixes: ...".
> 
> $ git show 090fdddb43 -- man2/mmap.2
> commit 090fdddb4342f92a1dbeba687462f4bcee816232
> Author: Michael Kerrisk <mtk.manpages@gmail.com>
> Date:   Mon May 17 15:31:08 2021 +1200
> 
>     memfd_create.2, mmap.2, shmget.2: Document the EPERM for huge page
> allocations
> 
>     This error can occur if the caller is does not have CAP_IPC_LOCK
>     and is not a member of the sysctl_hugetlb_shm_group.
> 
>     Reported-by: Yang Xu <xuyang2018.jy@fujitsu.com>
>     Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
> 
> diff --git a/man2/mmap.2 b/man2/mmap.2
> index 03f2eeb2c..4ee2f4f96 100644
> --- a/man2/mmap.2
> +++ b/man2/mmap.2
> @@ -628,6 +628,18 @@ .SH ERRORS
>  The operation was prevented by a file seal; see
>  .BR fcntl (2).
>  .TP
> +.B EPERM
> +The
> +.B MAP_HUGETLB
> +flag was specified, but the caller was not privileged (did not have the
> +.B CAP_IPC_LOCK
> +capability)
> +and is not a member of the
> +.I sysctl_hugetlb_shm_group
> +group; see the description of
> +.I /proc/sys/vm/sysctl_hugetlb_shm_group
> +in
> +.TP
>  .B ETXTBSY
>  .B MAP_DENYWRITE
>  was set but the object specified by
> 
> >> Also, proc(5) was recently cut into little sashimi pieces.  You want
> >> to refer to proc_sys(5).
> > 
> > Ah.. Thanks for pointing this out, I just checked that thread. I'll send
> > the updated patch if you are fine with no "Fixes:" tag for this.
> 
> Please add a Fixes mentioning that commit above.
> 
> Cheers,
> Alex

--
Regards,
Avinesh