]> git.ipfire.org Git - thirdparty/git.git/commit
Documentation: mention the amlog in howto/maintain-git.txt
authorTaylor Blau <me@ttaylorr.com>
Thu, 3 Oct 2024 01:09:56 +0000 (21:09 -0400)
committerJunio C Hamano <gitster@pobox.com>
Thu, 3 Oct 2024 19:00:21 +0000 (12:00 -0700)
commitddfb5bcfc69265d62358c0ab939e313b861e8470
tree57b7dfffbf8bdef26d04b5dda80fb91ed8d95b07
parent3857aae53f3633b7de63ad640737c657387ae0c6
Documentation: mention the amlog in howto/maintain-git.txt

Part of the maintainer's job is to keep up-to-date and publish the
'amlog' which stores a mapping between a patch's 'Message-Id' e-mail
header and the commit generated by applying said patch.

But our Documentation/howto/maintain-git.txt does not mention the amlog,
or the scripts which exist to help the maintainer keep the amlog
up-to-date.

(This bit me during the first integration round I did as interim
maintainer[1] involved a lot of manual clean-up. More recently it has
come up as part of a research effort to better understand a patch's
lifecycle on the list[2].)

Address this gap by briefly documenting the existence and purpose of the
'post-applypatch' hook in maintaining the amlog entries.

[1]: https://lore.kernel.org/git/Y19dnb2M+yObnftj@nand.local/
[2]: https://lore.kernel.org/git/CAJoAoZ=4ARuH3aHGe5yC_Xcnou_c396q_ZienYPY7YnEzZcyEg@mail.gmail.com/

Suggested-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Taylor Blau <me@ttaylorr.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/howto/maintain-git.txt