From: DJ Delorie <dj@redhat.com>
To: Paul Eggert <eggert@cs.ucla.edu>
Cc: libc-alpha@sourceware.org, eggert@cs.ucla.edu
Subject: Re: [PATCH 1/2] doc: document max_align_t effect on ABI
Date: Tue, 17 Mar 2026 21:44:01 -0400 [thread overview]
Message-ID: <xncy11ap3y.fsf@greed.delorie.com> (raw)
In-Reply-To: <20260315203255.123865-2-eggert@cs.ucla.edu> (message from Paul Eggert on Sun, 15 Mar 2026 13:32:40 -0700)
Paul Eggert <eggert@cs.ucla.edu> writes:
> -@end deftp
Elsewhere in the manual, it seems that the rule is that text defining
the type goes inside the @deftp, and text describing how to use it goes
outside it. Since @deftp text is indented (in pdf at least), we should
be consistent here. See the first page or so of the Input/Output on
Streams chapter. However, given the rest of the text in this section, I
don't think it matters which way you choose.
> +Code that uses @code{max_align_t} should take into account the
> +variable alignment of the type.
This is a slightly confusing wording, but only because we don't think of
types being aligned, just the objects of that type being aligned, and
"variable" could mean something different than "changing". A type
imposes an alignment, it doesn't "have" one because a type doesn't
occupy memory.
Perhaps "should not rely on its alignment being constant for any given
platform." ?
> +For example, it is unwise for a public interface to rely on @code{max_align_t},
> +as the interface's ABI can change if a different compiler defines
> +@code{max_align_t} differently.
> +
This part is fine.
I don't feel strongly enough about any of the above to hold this back
as-is though, if you don't feel like changing it.
Reviewed-by: DJ Delorie <dj@redhat.com>
next prev parent reply other threads:[~2026-03-18 1:44 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-03-15 20:32 [PATCH 0/2] document improvements for max_align_t, intmax_t Paul Eggert
2026-03-15 20:32 ` [PATCH 1/2] doc: document max_align_t effect on ABI Paul Eggert
2026-03-18 1:44 ` DJ Delorie [this message]
2026-03-15 20:32 ` [PATCH 2/2] doc: document C23 changes to intmax_t Paul Eggert
2026-03-18 1:47 ` DJ Delorie
-- strict thread matches above, loose matches on Subject: below --
2026-02-26 18:41 [PATCH v3 4/4] malloc: alignment might change in future versions Paul Eggert
2026-02-26 18:38 ` [PATCH 1/2] doc: document max_align_t effect on ABI Paul Eggert
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=xncy11ap3y.fsf@greed.delorie.com \
--to=dj@redhat.com \
--cc=eggert@cs.ucla.edu \
--cc=libc-alpha@sourceware.org \
/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 read-only IMAP folder(s) and NNTP newsgroup(s).