summaryrefslogtreecommitdiff
path: root/notes.h
diff options
context:
space:
mode:
authorChris Mayo <aklhfex@gmail.com>2019-05-04 19:45:07 +0100
committerJunio C Hamano <gitster@pobox.com>2019-05-07 19:08:10 +0900
commitd4907720a2fc2d096fa0d904f7ee92b0fbc302bf (patch)
tree9f0014484a954579b862b83a33d76e2aff876837 /notes.h
parentaeb582a98374c094361cba1bd756dc6307432c42 (diff)
downloadgit-d4907720a2fc2d096fa0d904f7ee92b0fbc302bf.tar.gz
notes: correct documentation of format_display_notes()
'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>
Diffstat (limited to 'notes.h')
-rw-r--r--notes.h8
1 files changed, 3 insertions, 5 deletions
diff --git a/notes.h b/notes.h
index 414bc6855a..76337f2384 100644
--- a/notes.h
+++ b/notes.h
@@ -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.
*/