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>
Chris Mayo committed
May 4, 2019 at 19:45 UTC
d4907720a2fc2d096fa0d904f7ee92b0fbc302bf
1 file changed
+3
-5
notes.h
+3
-5
@@ -276,12 +276,10 @@ void init_display_notes(struct display_notes_opt *opt);
276
277
/*
278
* Append notes for the given 'object_sha1' from all trees set up by
279
- * init_display_notes() to 'sb'. The 'flags' are a bitwise
280
- * combination of
279
+ * init_display_notes() to 'sb'.
280
*
282
- * - NOTES_SHOW_HEADER: add a 'Notes (refname):' header
283
- *
284
- * - NOTES_INDENT: indent the notes by 4 places
281
+ * If 'raw' is false the note will be indented by 4 places and
282
+ * a 'Notes (refname):' header added.
283
*
284
* You *must* call init_display_notes() before using this function.
285
*/