* [PATCH] notes: correct documentation of format_display_notes()
@ 2019-05-04 18:45 Chris Mayo
0 siblings, 0 replies; only message in thread
From: Chris Mayo @ 2019-05-04 18:45 UTC (permalink / raw)
To: git
'flags' parameter was replaced by 'raw' in commit:
76141e2e62 ("format_note(): simplify API", 2012-10-17)
Signed-off-by: Chris Mayo <aklhfex@gmail.com>
---
notes.h | 8 +++-----
1 file 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.
*/
--
2.21.0
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2019-05-04 18:52 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-05-04 18:45 [PATCH] notes: correct documentation of format_display_notes() Chris Mayo
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).