]> git.ipfire.org Git - thirdparty/git.git/commit
pretty.h: update and expand docstring for userformat_find_requirements()
authorJeff King <peff@peff.net>
Tue, 22 Jun 2021 16:03:54 +0000 (12:03 -0400)
committerJunio C Hamano <gitster@pobox.com>
Tue, 29 Jun 2021 03:30:17 +0000 (20:30 -0700)
commit3c7e2e8f0acfe94220cdd3bbd3a35a955ae80294
tree9ec29aa07ed36b2b9501e824f0cfc328cda21c9e
parent670b81a890388c60b7032a4f5b879f2ece8c4558
pretty.h: update and expand docstring for userformat_find_requirements()

The comment only mentions "notes", but there are more fields now (and
I'm about to add another). Let's make it more general, and stick the
struct next to the function to make the list of possibilities obvious.

While we're touching this comment, let's also mention the behavior of
NULL, which some callers rely on (though in the long run, this global is
pretty nasty and probably should get moved into rev_info).

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
pretty.h