From: Junio C Hamano <gitster@pobox.com>
Date: Sun, 19 May 2019 07:45:32 +0000 (+0900)
Subject: Merge branch 'cm/notes-comment-fix'
X-Git-Tag: v2.22.0-rc1~13
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/521d3ef38a17917ad10e71a398e82a13fa1178b5?hp=b3e0981f2865660bfff1172a8f9940b2157ce233

Merge branch 'cm/notes-comment-fix'

A stale in-code comment has been updated.

* cm/notes-comment-fix:
notes: correct documentation of format_display_notes()
---

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