]> git.ipfire.org Git - thirdparty/git.git/commit
trailer: document parse_trailers() usage
authorLinus Arver <linus@ucla.edu>
Thu, 2 May 2024 04:54:26 +0000 (04:54 +0000)
committerJunio C Hamano <gitster@pobox.com>
Thu, 2 May 2024 16:57:08 +0000 (09:57 -0700)
commit5f800603a9fa0cbcca83b3eb56dff893582d0ca7
tree6a53a6a5ea62e7e8c45cf4a95630f5e589805f8a
parentcf5c9349de52d8d5fa02f7a5b6d9122260834f26
trailer: document parse_trailers() usage

Explain how to use parse_trailers(), because earlier we made the
trailer_info struct opaque. That is, because clients can no longer peek
inside it, we should give them guidance about how the (pointer to the)
opaque struct can still be useful to them.

Rename "head" struct to "trailer_objects" to make the wording of the new
comments a bit easier to read (because "head" itself doesn't really have
any domain-specific meaning here).

Signed-off-by: Linus Arver <linus@ucla.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
trailer.c
trailer.h