From: Chris Mayo <aklhfex@gmail.com>
Date: Sat, 4 May 2019 18:45:07 +0000 (+0100)
Subject: notes: correct documentation of format_display_notes()
X-Git-Tag: v2.22.0-rc1~13^2
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/d4907720a2fc2d096fa0d904f7ee92b0fbc302bf?ds=inline;hp=--cc

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>
---

d4907720a2fc2d096fa0d904f7ee92b0fbc302bf
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.
  */