Re: [PATCH v5] mmap.2: MAP_FIXED updated documentation
From: Michael Kerrisk (man-pages)
Date: Tue Dec 19 2017 - 00:36:04 EST
On 12/18/2017 10:27 PM, John Hubbard wrote:
> On 12/18/2017 11:15 AM, Michael Kerrisk (man-pages) wrote:
>> On 12/12/2017 01:23 AM, john.hubbard@xxxxxxxxx wrote:
>>> From: John Hubbard <jhubbard@xxxxxxxxxx>
>>> -- Expand the documentation to discuss the hazards in
>>> enough detail to allow avoiding them.
>>> -- Mention the upcoming MAP_FIXED_SAFE flag.
>>> -- Enhance the alignment requirement slightly.
>>> CC: Michael Ellerman <mpe@xxxxxxxxxxxxxx>
>>> CC: Jann Horn <jannh@xxxxxxxxxx>
>>> CC: Matthew Wilcox <willy@xxxxxxxxxxxxx>
>>> CC: Michal Hocko <mhocko@xxxxxxxxxx>
>>> CC: Mike Rapoport <rppt@xxxxxxxxxxxxxxxxxx>
>>> CC: Cyril Hrubis <chrubis@xxxxxxx>
>>> CC: Michal Hocko <mhocko@xxxxxxxx>
>>> CC: Pavel Machek <pavel@xxxxxx>
>>> Signed-off-by: John Hubbard <jhubbard@xxxxxxxxxx>
>> Thanks for the patch. I think you win the prize for the
>> most iterations ever on a man-pages patch! (And Michal,
>> thanks for helping out.) I've applied your patch, made
>> some minor tweaks, and removed the mention of
>> MAP_FIXED_SAFE, since I don't like to document stuff
>> that hasn't yet been merged. (I only later noticed the
>> fuss about the naming...)
> Hi Michael,
> The final result looks nice, thanks for all the editing fixes.
> One last thing: reading through this, I think it might need a wording
> fix (this is my fault), in order to avoid implying that brk() or
> malloc() use dlopen().
> Something approximately like this:
> diff --git a/man2/mmap.2 b/man2/mmap.2
> index 79681b31e..1c0bd80de 100644
> --- a/man2/mmap.2
> +++ b/man2/mmap.2
> @@ -250,8 +250,9 @@ suffice.
> .BR dlopen (3)
> call will map the library into the process's address space.
> -Furthermore, almost any library call may be implemented using this technique.
> -Examples include
> +Furthermore, almost any library call may be implemented in a way that
> +adds memory mappings to the address space, either with this technique,
> +or by simply allocating memory. Examples include
> .BR brk (2),
> .BR malloc (3),
> .BR pthread_create (3),
> ...or does the current version seem OK to other people?
Thanks. Looks good to me. Applied.
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/