]> git.ipfire.org Git - thirdparty/binutils-gdb.git/commit
libctf: archive: comment improvements
authorNick Alcock <nick.alcock@oracle.com>
Mon, 7 Jul 2025 14:39:54 +0000 (15:39 +0100)
committerNick Alcock <nick.alcock@oracle.com>
Mon, 7 Jul 2025 14:39:54 +0000 (15:39 +0100)
commit175d437a9dd39f4bab88882f8b692d0744a547f9
tree935c0d2c3afaba91279f395539d10db0b6461623
parent99e037e0bfd4a2e66bd778ef1b5b66b1b409b115
libctf: archive: comment improvements

A file format-defining header such as ctf.h should not describe
internal implementation details of how some fields are reused inside libctf.

Describe the modent table as what it is, an array, and mention that it is
sorted by name.

include/
* ctf.h (struct ctf_archive) [ctfa_modents]: Mention sort order.
[ctfa_magic]: Improve comment.
(struct ctf_archive_v1) [ctfa_magic]: Likewise.  Mention the
off-the-end nature of the modent array in this format.
include/ctf.h