[Bug manual/27547] New: "Summary of malloc-Related Functions" shows wrong argument order for `aligned_alloc` and `memalign`

[Bug manual/27547] New: "Summary of malloc-Related Functions" shows wrong argument order for `aligned_alloc` and `memalign`

[adriaan.jacobs7 at gmail dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=27547

            Bug ID: 27547
           Summary: "Summary of malloc-Related Functions" shows wrong
                    argument order for  `aligned_alloc` and `memalign`
           Product: glibc
           Version: unspecified
            Status: UNCONFIRMED
          Severity: normal
          Priority: P2
         Component: manual
          Assignee: unassigned at sourceware dot org
          Reporter: adriaan.jacobs7 at gmail dot com
                CC: mtk.manpages at gmail dot com
  Target Milestone: ---

>From the overview at
https://www.gnu.org/software/libc/manual/html_node/Summary-of-Malloc.html:

void *aligned_alloc (size_t size, size_t alignment)
    Allocate a block of size bytes, starting on an address that is a multiple
of alignment. See Aligned Memory Blocks.

void *memalign (size_t size, size_t boundary)
    Allocate a block of size bytes, starting on an address that is a multiple
of boundary. See Aligned Memory Blocks.

According to the manpages (https://linux.die.net/man/3/memalign) for these
functions, the arguments are the other way around (first boundary/alignment,
then size). In the implementation version I checked, the order from the
manpages was respected, leading me to believe that this one overview contained
a mistake there.

It's obviously nothing big since chances are low someone only consults this
overview, but I stumbled upon it and would've almost introduced a bug if I
hadn't double checked with the manpages.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/27547] "Summary of malloc-Related Functions" shows wrong argument order for `aligned_alloc` and `memalign`

[adriaan.jacobs7 at gmail dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=27547

adriaan.jacobs7 at gmail dot com changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |adriaan.jacobs7 at gmail dot com

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/27547] "Summary of malloc-Related Functions" shows wrong argument order for `aligned_alloc` and `memalign`

[adriaan.jacobs7 at gmail dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=27547

--- Comment #1 from adriaan.jacobs7 at gmail dot com ---
Upon further checking, it seems the __memalign_hook suffers from the same issue
on the same page.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/27547] "Summary of malloc-Related Functions" shows wrong argument order for `aligned_alloc` and `memalign`

[dbrendel at redhat dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=27547

Dennis Brendel <dbrendel at redhat dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |dbrendel at redhat dot com

--- Comment #2 from Dennis Brendel <dbrendel at redhat dot com> ---
I posted a fix 9 days ago which should fix the current state of the manual. I
did not see more related problems.

https://sourceware.org/pipermail/libc-alpha/2024-January/154042.html

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/27547] "Summary of malloc-Related Functions" shows wrong argument order for `aligned_alloc` and `memalign`

[carlos at redhat dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=27547

Carlos O'Donell <carlos at redhat dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|UNCONFIRMED                 |RESOLVED
         Resolution|---                         |FIXED
                 CC|                            |carlos at redhat dot com
   Target Milestone|---                         |2.39

--- Comment #3 from Carlos O'Donell <carlos at redhat dot com> ---
Fixed in the upcoming glibc 2.39.

-- 
You are receiving this mail because:
You are on the CC list for the bug.