[PATCH v2 1/2] manual/memory.texi: Bring aligned allocation docs up to date.

[Will Newton]

On 20 November 2013 11:25, Ondřej Bílka <neleai@seznam.cz> wrote:
> On Wed, Nov 20, 2013 at 11:08:45AM +0000, Will Newton wrote:
>> On 6 November 2013 16:33, Will Newton <will.newton@linaro.org> wrote:
>> >
>> > The current documentation suggests using memalign and valloc which
>> > are now considered obsolete, so suggest using posix_memalign instead.
>> > Also document the possible error return and errno values for memalign
>> > and posix_memalign and improve documentation of __memalign_hook.
>> >
>> > ChangeLog:
>> >
>> > 2013-11-06  Will Newton  <will.newton@linaro.org>
>> >
>> >         * manual/memory.texi (Malloc Examples): Clarify default
>> >         alignment documentation.  Suggest posix_memalign rather
>> >         than memalign or valloc.
>> >         (Aligned Memory Blocks): Remove suggestion to use memalign
>> >         or valloc.  Remove obsolete comment about BSD.
>> >         Document memalign errno values and mark the function obsolete.
>> >         Document posix_memalign returned error codes.  Mark valloc
>> >         as obsolete.  (Hooks for Malloc): __memalign_hook is also
>> >         called for posix_memalign and valloc.
>> >         (Summary of Malloc): Add posix_memalign to function summary.
>> >         __memalign_hook is also called for posix_memalign and valloc.
>> > ---
>> >  manual/memory.texi | 61 +++++++++++++++++++++++++++++++++++++++---------------
>> >  1 file changed, 44 insertions(+), 17 deletions(-)
>> >
>> > Changes in v2:
>> >  - Fix incorrect errno definitions
>>
>> Ping?
>>
>
> Looks ok,
>
> A minor nit is that if we aim for completeness then pvalloc is currently
> undocumented. It could be added as separate patch or should we keep it
> undocumented?

Yes, I would consider documenting pvalloc in a follow on patch.

-- 
Will Newton
Toolchain Working Group, Linaro