summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2019-05-19 16:45:32 +0900
committerLibravatar Junio C Hamano <gitster@pobox.com>2019-05-19 16:45:32 +0900
commit521d3ef38a17917ad10e71a398e82a13fa1178b5 (patch)
treea780a11c2866c89fe788b851a700f9405d6eba68
parentMerge branch 'tt/no-ipv6-fallback-for-winxp' (diff)
parentnotes: correct documentation of format_display_notes() (diff)
downloadtgif-521d3ef38a17917ad10e71a398e82a13fa1178b5.tar.xz
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()
-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.
*/