[PATCH] mremap.2: Update information about MREMAP_DONTUNMAP restrictions

[PATCH] mremap.2: Update information about MREMAP_DONTUNMAP restrictions

[Alex Henrie]

See "mm: extend MREMAP_DONTUNMAP to non-anonymous mappings":
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=a4609387859f0281951f5e476d9f76d7fb9ab321

Signed-off-by: Alex Henrie <alexhenrie24@gmail.com>
---
 man/man2/mremap.2 | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/man/man2/mremap.2 b/man/man2/mremap.2
index 53e0bcf2d..b99ab9492 100644
--- a/man/man2/mremap.2
+++ b/man/man2/mremap.2
@@ -106,7 +106,13 @@ remaps a mapping to a new address but does not unmap the mapping at
 .IP
 The
 .B MREMAP_DONTUNMAP
-flag can be used only with private anonymous mappings
+flag can only be used with mappings that are not
+.BR VM_DONTEXPAND
+or
+.BR VM_MIXEDMAP .
+Before Linux 5.13, the
+.B MREMAP_DONTUNMAP
+flag could be used only with private anonymous mappings
 (see the description of
 .B MAP_PRIVATE
 and
-- 
2.47.0

Re: [PATCH] mremap.2: Update information about MREMAP_DONTUNMAP restrictions

[Alejandro Colomar]

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

Hi Alex,

On Mon, Nov 04, 2024 at 09:16:41PM GMT, Alex Henrie wrote:
> See "mm: extend MREMAP_DONTUNMAP to non-anonymous mappings":
> https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=a4609387859f0281951f5e476d9f76d7fb9ab321
> 
> Signed-off-by: Alex Henrie <alexhenrie24@gmail.com>
> ---
>  man/man2/mremap.2 | 8 +++++++-
>  1 file changed, 7 insertions(+), 1 deletion(-)
> 
> diff --git a/man/man2/mremap.2 b/man/man2/mremap.2
> index 53e0bcf2d..b99ab9492 100644
> --- a/man/man2/mremap.2
> +++ b/man/man2/mremap.2
> @@ -106,7 +106,13 @@ remaps a mapping to a new address but does not unmap the mapping at
>  .IP
>  The
>  .B MREMAP_DONTUNMAP
> -flag can be used only with private anonymous mappings
> +flag can only be used with mappings that are not

I find the position of "only" a bit inconsistent here.  It probably
would be more appropriate right before "with".  (I'm wondering if I put
"probably" in the right place too... :)

> +.BR VM_DONTEXPAND

Please use .B, not .BR.  You'll find that BR causes a warning in that
file, if you run `make build-all`:

	$ make build-all -j24 -k
	TROFF		.tmp/man/man2/mremap.2.cat.set
	an.tmac:.tmp/man/man2/mremap.2:42: style: .BR expects at least 2 arguments, got 1
	make: *** [/home/alx/src/linux/man-pages/man-pages/contrib/share/mk/build/catman/troff.mk:65: .tmp/man/man2/mremap.2.cat.set] Error 1
	make: *** Deleting file '.tmp/man/man2/mremap.2.cat.set'
	make: Target 'build-all' not remade because of errors.

(You'll need to run a sufficiently recent system that includes
 groff-1.23.0, such as Debian Sid.)

Cheers,
Alex

> +or
> +.BR VM_MIXEDMAP .
> +Before Linux 5.13, the
> +.B MREMAP_DONTUNMAP
> +flag could be used only with private anonymous mappings
>  (see the description of
>  .B MAP_PRIVATE
>  and
> -- 
> 2.47.0
> 
> 

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

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

Re: [PATCH] mremap.2: Update information about MREMAP_DONTUNMAP restrictions

[Alex Henrie]

On Tue, Nov 5, 2024 at 4:50 AM Alejandro Colomar <alx@kernel.org> wrote:
>
> Hi Alex,

Bon dia Alejandro, és un plaer parlar amb tu de nou!

> On Mon, Nov 04, 2024 at 09:16:41PM GMT, Alex Henrie wrote:

> > diff --git a/man/man2/mremap.2 b/man/man2/mremap.2
> > index 53e0bcf2d..b99ab9492 100644
> > --- a/man/man2/mremap.2
> > +++ b/man/man2/mremap.2
> > @@ -106,7 +106,13 @@ remaps a mapping to a new address but does not unmap the mapping at
> >  .IP
> >  The
> >  .B MREMAP_DONTUNMAP
> > -flag can be used only with private anonymous mappings
> > +flag can only be used with mappings that are not
>
> I find the position of "only" a bit inconsistent here.  It probably
> would be more appropriate right before "with".  (I'm wondering if I put
> "probably" in the right place too... :)

It probably is slightly more clear to say "can be used only with..."
instead of "can only be used with...". I'll make that change in v2.

> > +.BR VM_DONTEXPAND
>
> Please use .B, not .BR.  You'll find that BR causes a warning in that
> file, if you run `make build-all`:
>
>         $ make build-all -j24 -k
>         TROFF           .tmp/man/man2/mremap.2.cat.set
>         an.tmac:.tmp/man/man2/mremap.2:42: style: .BR expects at least 2 arguments, got 1
>         make: *** [/home/alx/src/linux/man-pages/man-pages/contrib/share/mk/build/catman/troff.mk:65: .tmp/man/man2/mremap.2.cat.set] Error 1
>         make: *** Deleting file '.tmp/man/man2/mremap.2.cat.set'
>         make: Target 'build-all' not remade because of errors.
>
> (You'll need to run a sufficiently recent system that includes
>  groff-1.23.0, such as Debian Sid.)

Will do, thanks for the tip.

-Alex

[PATCH man-pages v2] mremap.2: Update information about MREMAP_DONTUNMAP restrictions

[Alex Henrie]

Link: <https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=a4609387859f0281951f5e476d9f76d7fb9ab321>
Signed-off-by: Alex Henrie <alexhenrie24@gmail.com>
---
Changes in v2:
- Move link to Link line in commit message
- Consistently position the word "only"
- Use .B instead of .BR for a word followed by a space

Thanks to Alejandro for your feedback.
---
 man/man2/mremap.2 | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/man/man2/mremap.2 b/man/man2/mremap.2
index 53e0bcf2d..62bf17b76 100644
--- a/man/man2/mremap.2
+++ b/man/man2/mremap.2
@@ -106,7 +106,13 @@ remaps a mapping to a new address but does not unmap the mapping at
 .IP
 The
 .B MREMAP_DONTUNMAP
-flag can be used only with private anonymous mappings
+flag can be used only with mappings that are not
+.B VM_DONTEXPAND
+or
+.BR VM_MIXEDMAP .
+Before Linux 5.13, the
+.B MREMAP_DONTUNMAP
+flag could be used only with private anonymous mappings
 (see the description of
 .B MAP_PRIVATE
 and
-- 
2.47.0

Re: [PATCH man-pages v2] mremap.2: Update information about MREMAP_DONTUNMAP restrictions

[Alejandro Colomar]

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

Hi Alex,

On Sun, Nov 10, 2024 at 11:10:19PM GMT, Alex Henrie wrote:
> Link: <https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=a4609387859f0281951f5e476d9f76d7fb9ab321>
> Signed-off-by: Alex Henrie <alexhenrie24@gmail.com>
> ---
> Changes in v2:
> - Move link to Link line in commit message
> - Consistently position the word "only"
> - Use .B instead of .BR for a word followed by a space
> 
> Thanks to Alejandro for your feedback.

Thank you for the patch!

I've applied it.
<https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/commit/?h=contrib&id=5cd75b8958eed06365849fce4d70582e19ab7fdf>

Have a lovely night!
Alex

> ---
>  man/man2/mremap.2 | 8 +++++++-
>  1 file changed, 7 insertions(+), 1 deletion(-)
> 
> diff --git a/man/man2/mremap.2 b/man/man2/mremap.2
> index 53e0bcf2d..62bf17b76 100644
> --- a/man/man2/mremap.2
> +++ b/man/man2/mremap.2
> @@ -106,7 +106,13 @@ remaps a mapping to a new address but does not unmap the mapping at
>  .IP
>  The
>  .B MREMAP_DONTUNMAP
> -flag can be used only with private anonymous mappings
> +flag can be used only with mappings that are not
> +.B VM_DONTEXPAND
> +or
> +.BR VM_MIXEDMAP .
> +Before Linux 5.13, the
> +.B MREMAP_DONTUNMAP
> +flag could be used only with private anonymous mappings
>  (see the description of
>  .B MAP_PRIVATE
>  and
> -- 
> 2.47.0
> 

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

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