linux-man.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx@kernel.org>
To: linux-man@vger.kernel.org
Cc: Alejandro Colomar <alx@kernel.org>, Seth McDonald <sethmcmail@pm.me>
Subject: [PATCH v1 00/12] man/man3/posix_memalign.3: Several fixes, and split the page
Date: Wed, 10 Dec 2025 13:39:57 +0100	[thread overview]
Message-ID: <cover.1765370035.git.alx@kernel.org> (raw)

Hi!

After Seth's bug report(s), I've applied several fixes to
posix_memalign.3.  While and after doing that, I've also applied other
patches for improving the page, including a split.

From all of these functions, ISO C's aligned_alloc(3) is the only one
that programmers should be using.  Let's have a page dedicated
exclusively for that function, which documents it well, without noise.

Secondarily, let's have one page for posix_memalign(3), which is still
not officially deprecated, where it is well documented, but point out
that aligned_alloc(3) is preferable.

Then, have one page per each of the other functions, documenting that
they are deprecated, documenting their flaws and subtleties, and
referring to aligned_alloc(3) for the main documentation, as they are
essentially just flawed versions of it.


Have a lovely day!
Alex

Alejandro Colomar (12):
  man/man3/posix_memalign.3: Remove confusing exception
  man/man3/posix_memalign.3: wfix
  man/man3/posix_memalign.3: STANDARDS: aligned_alloc() conforms to ISO
    C17, not C11
  man/man3/posix_memalign.3: STANDARDS: aligned_alloc() conforms to C23
  man/man3/posix_memalign.3: STANDARDS: aligned_alloc() and
    posix_memalign() conform to POSIX.1-2024
  man/man3/{posix_,}memalign.3: Split memalign() from posix_memalign(3)
  man/man3/{posix_memalign,pvalloc}.3: Split pvalloc() from
    posix_memalign(3)
  man/man3/{posix_memalign,valloc}.3: Split valloc() from
    posix_memalign(3)
  man/man3/{aligned_alloc,posix_memalign}.3: Split aligned_alloc() from
    posix_memalign(3)
  man/man3/posix_memalign.3: CAVEATS: Add section, and move paragraph to
    it
  man/man3/posix_memalign.3: Remove redundant text
  man/man3/posix_memalign.3: NOTES: Remove superfluous section

 man/man3/aligned_alloc.3  |  99 +++++++++++++++++-
 man/man3/memalign.3       |  77 +++++++++++++-
 man/man3/posix_memalign.3 | 211 +++-----------------------------------
 man/man3/pvalloc.3        |  49 ++++++++-
 man/man3/valloc.3         |  89 +++++++++++++++-
 5 files changed, 326 insertions(+), 199 deletions(-)

Range-diff against v0:
 -:  --------- >  1:  90f18b452 man/man3/posix_memalign.3: Remove confusing exception
 -:  --------- >  2:  19b5ea61e man/man3/posix_memalign.3: wfix
 -:  --------- >  3:  95f523f48 man/man3/posix_memalign.3: STANDARDS: aligned_alloc() conforms to ISO C17, not C11
 -:  --------- >  4:  9db9d670c man/man3/posix_memalign.3: STANDARDS: aligned_alloc() conforms to C23
 -:  --------- >  5:  032768ed7 man/man3/posix_memalign.3: STANDARDS: aligned_alloc() and posix_memalign() conform to POSIX.1-2024
 -:  --------- >  6:  de49191b8 man/man3/{posix_,}memalign.3: Split memalign() from posix_memalign(3)
 -:  --------- >  7:  af29aac57 man/man3/{posix_memalign,pvalloc}.3: Split pvalloc() from posix_memalign(3)
 -:  --------- >  8:  03408db2f man/man3/{posix_memalign,valloc}.3: Split valloc() from posix_memalign(3)
 -:  --------- >  9:  6da397d5c man/man3/{aligned_alloc,posix_memalign}.3: Split aligned_alloc() from posix_memalign(3)
 -:  --------- > 10:  213710d2c man/man3/posix_memalign.3: CAVEATS: Add section, and move paragraph to it
 -:  --------- > 11:  7960911fc man/man3/posix_memalign.3: Remove redundant text
 -:  --------- > 12:  54e7d20ee man/man3/posix_memalign.3: NOTES: Remove superfluous section
-- 
2.51.0


             reply	other threads:[~2025-12-10 12:40 UTC|newest]

Thread overview: 49+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-12-10 12:39 Alejandro Colomar [this message]
2025-12-10 12:40 ` [PATCH v1 01/12] man/man3/posix_memalign.3: Remove confusing exception Alejandro Colomar
2025-12-10 12:40 ` [PATCH v1 02/12] man/man3/posix_memalign.3: wfix Alejandro Colomar
2025-12-10 12:40 ` [PATCH v1 03/12] man/man3/posix_memalign.3: STANDARDS: aligned_alloc() conforms to ISO C17, not C11 Alejandro Colomar
2025-12-10 12:40 ` [PATCH v1 04/12] man/man3/posix_memalign.3: STANDARDS: aligned_alloc() conforms to C23 Alejandro Colomar
2025-12-10 12:40 ` [PATCH v1 05/12] man/man3/posix_memalign.3: STANDARDS: aligned_alloc() and posix_memalign() conform to POSIX.1-2024 Alejandro Colomar
2025-12-10 12:40 ` [PATCH v1 06/12] man/man3/{posix_,}memalign.3: Split memalign() from posix_memalign(3) Alejandro Colomar
2025-12-10 12:40 ` [PATCH v1 07/12] man/man3/{posix_memalign,pvalloc}.3: Split pvalloc() " Alejandro Colomar
2025-12-10 12:40 ` [PATCH v1 08/12] man/man3/{posix_memalign,valloc}.3: Split valloc() " Alejandro Colomar
2025-12-10 12:40 ` [PATCH v1 09/12] man/man3/{aligned_alloc,posix_memalign}.3: Split aligned_alloc() " Alejandro Colomar
2025-12-10 12:40 ` [PATCH v1 10/12] man/man3/posix_memalign.3: CAVEATS: Add section, and move paragraph to it Alejandro Colomar
2025-12-10 12:40 ` [PATCH v1 11/12] man/man3/posix_memalign.3: Remove redundant text Alejandro Colomar
2025-12-10 12:40 ` [PATCH v1 12/12] man/man3/posix_memalign.3: NOTES: Remove superfluous section Alejandro Colomar
2025-12-10 16:29 ` [PATCH v1 00/12] man/man3/posix_memalign.3: Several fixes, and split the page Eugene Syromyatnikov
2025-12-10 17:12   ` Alejandro Colomar
2025-12-10 22:50     ` Eugene Syromyatnikov
2025-12-11  0:04       ` Alejandro Colomar
2025-12-11  3:46         ` Eugene Syromyatnikov
2025-12-11 10:39           ` Alejandro Colomar
2025-12-15 14:41 ` [PATCH v2 00/14] " Alejandro Colomar
2025-12-15 14:41   ` [PATCH v2 01/14] man/man3/posix_memalign.3: Remove confusing exception Alejandro Colomar
2025-12-15 14:41   ` [PATCH v2 02/14] man/man3/posix_memalign.3: wfix Alejandro Colomar
2025-12-15 14:41   ` [PATCH v2 03/14] man/man3/posix_memalign.3: STANDARDS: aligned_alloc() conforms to C17, not C11 Alejandro Colomar
2025-12-15 14:41   ` [PATCH v2 04/14] man/man3/posix_memalign.3: STANDARDS: aligned_alloc() conforms to C23 Alejandro Colomar
2025-12-15 14:41   ` [PATCH v2 05/14] man/man3/posix_memalign.3: STANDARDS: aligned_alloc() and posix_memalign() conform to POSIX.1-2024 Alejandro Colomar
2025-12-15 14:41   ` [PATCH v2 06/14] man/man3/{posix_,}memalign.3: Split memalign() from posix_memalign(3) Alejandro Colomar
2025-12-15 14:41   ` [PATCH v2 07/14] man/man3/{posix_memalign,pvalloc}.3: Split pvalloc() " Alejandro Colomar
2025-12-15 14:41   ` [PATCH v2 08/14] man/man3/{posix_memalign,valloc}.3: Split valloc() " Alejandro Colomar
2025-12-15 14:41   ` [PATCH v2 09/14] man/man3/{aligned_alloc,posix_memalign}.3: Split aligned_alloc() " Alejandro Colomar
2025-12-15 14:42   ` [PATCH v2 10/14] man/man3/posix_memalign.3: CAVEATS: Add section, and move paragraph to it Alejandro Colomar
2025-12-15 14:42   ` [PATCH v2 11/14] man/man3/posix_memalign.3: Remove redundant text Alejandro Colomar
2025-12-15 14:42   ` [PATCH v2 12/14] man/man3/posix_memalign.3: NOTES: Remove superfluous section Alejandro Colomar
2025-12-15 14:42   ` [PATCH v2 13/14] man/man3/memalign.3: wfix Alejandro Colomar
2025-12-15 14:42   ` [PATCH v2 14/14] man/man3/aligned_alloc.3: HISTORY: Document bogus specification from C11 Alejandro Colomar
2025-12-17 13:03   ` [PATCH v2 00/14] man/man3/posix_memalign.3: Several fixes, and split the page Seth McDonald
2025-12-17 13:28     ` Alejandro Colomar
2025-12-17 13:51 ` [PATCH v3 0/1] man/man3/aligned_alloc.3: HISTORY: Document bogus specification from C11 Alejandro Colomar
2025-12-17 13:51   ` [PATCH v3 1/1] " Alejandro Colomar
2025-12-17 13:53     ` Alejandro Colomar
2025-12-17 14:42     ` Eugene Syromyatnikov
2025-12-17 15:37       ` Eugene Syromyatnikov
2025-12-17 17:05         ` Alejandro Colomar
2025-12-17 20:40           ` Alejandro Colomar
2025-12-17 16:46       ` Alejandro Colomar
2025-12-22 21:33 ` [PATCH v4 0/1] " Alejandro Colomar
2025-12-22 21:33   ` [PATCH v4 1/1] " Alejandro Colomar
2025-12-22 21:36     ` Alejandro Colomar
2025-12-23  0:15   ` G. Branden Robinson
2025-12-23  0:35     ` Alejandro Colomar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1765370035.git.alx@kernel.org \
    --to=alx@kernel.org \
    --cc=linux-man@vger.kernel.org \
    --cc=sethmcmail@pm.me \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).