Doc User-Manual: Patch cover letter, three dashes, and --notes

diff --git a/notes.c b/notes.c
index 93e9868d5d1aa536b70e981d3a4cd3c7969764d3..97097db9dc45a6dc81a29844aea61330c59cab11 100644 (file)
--- a/notes.c
+++ b/notes.c
@@ -1196,8 +1196,19 @@ void free_notes(struct notes_tree *t)
        memset(t, 0, sizeof(struct notes_tree));
 }
 
-void format_note(struct notes_tree *t, const unsigned char *object_sha1,
-               struct strbuf *sb, const char *output_encoding, int flags)
+/*
+ * Fill the given strbuf with the notes associated with the given object.
+ *
+ * If the given notes_tree structure is not initialized, it will be auto-
+ * initialized to the default value (see documentation for init_notes() above).
+ * If the given notes_tree is NULL, the internal/default notes_tree will be
+ * used instead.
+ *
+ * (raw != 0) gives the %N userformat; otherwise, the note message is given
+ * for human consumption.
+ */
+static void format_note(struct notes_tree *t, const unsigned char *object_sha1,
+                       struct strbuf *sb, const char *output_encoding, int raw)
 {
        static const char utf8[] = "utf-8";
        const unsigned char *sha1;
@@ -1234,7 +1245,7 @@ void format_note(struct notes_tree *t, const unsigned char *object_sha1,
        if (msglen && msg[msglen - 1] == '\n')
                msglen--;
 
-       if (flags & NOTES_SHOW_HEADER) {
+       if (!raw) {
                const char *ref = t->ref;
                if (!ref || !strcmp(ref, GIT_NOTES_DEFAULT_REF)) {
                        strbuf_addstr(sb, "\nNotes:\n");
@@ -1250,7 +1261,7 @@ void format_note(struct notes_tree *t, const unsigned char *object_sha1,
        for (msg_p = msg; msg_p < msg + msglen; msg_p += linelen + 1) {
                linelen = strchrnul(msg_p, '\n') - msg_p;
 
-               if (flags & NOTES_INDENT)
+               if (!raw)
                        strbuf_addstr(sb, "    ");
                strbuf_add(sb, msg_p, linelen);
                strbuf_addch(sb, '\n');
@@ -1260,13 +1271,13 @@ void format_note(struct notes_tree *t, const unsigned char *object_sha1,
 }
 
 void format_display_notes(const unsigned char *object_sha1,
-                         struct strbuf *sb, const char *output_encoding, int flags)
+                         struct strbuf *sb, const char *output_encoding, int raw)
 {
        int i;
        assert(display_notes_trees);
        for (i = 0; display_notes_trees[i]; i++)
                format_note(display_notes_trees[i], object_sha1, sb,
-                           output_encoding, flags);
+                           output_encoding, raw);
 }
 
 int copy_note(struct notes_tree *t,