undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

notes: correct documentation of format_display_notes()

Browse Source 
'flags' parameter was replaced by 'raw' in commit:
76141e2e62 ("format_note(): simplify API", 2012-10-17)

Signed-off-by: Chris Mayo <aklhfex@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Chris Mayo 2019-05-04 19:45:07 +01:00 committed by Junio C Hamano
parent aeb582a983
commit d4907720a2
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
notes.h
View File

@ -276,12 +276,10 @@ void init_display_notes(struct display_notes_opt *opt);
/*
* Append notes for the given 'object_sha1' from all trees set up by
* init_display_notes() to 'sb'. The 'flags' are a bitwise
* combination of
* init_display_notes() to 'sb'.
*
* - NOTES_SHOW_HEADER: add a 'Notes (refname):' header
*
* - NOTES_INDENT: indent the notes by 4 places
* If 'raw' is false the note will be indented by 4 places and
* a 'Notes (refname):' header added.
*
* You *must* call init_display_notes() before using this function.
*/