show: More aggressively document the presence of devel/schemata
authorAustin Clements <amdragon@MIT.EDU>
Wed, 7 Nov 2012 15:27:01 +0000 (10:27 -0500)
committerDavid Bremner <bremner@debian.org>
Thu, 8 Nov 2012 13:49:41 +0000 (09:49 -0400)
Previously, the only mention of devel/schemata was a comment at the
top of format_part_json, but the JSON output code is spread across
several functions that are distributed across notmuch-show.c.  Add
references from the other three key JSON output functions.

notmuch-show.c

index f758f56b1587d4e7626b74e5159af5e55c9ca9ce..2fa229257ea99645d778a134c35861c3398665e5 100644 (file)
@@ -110,6 +110,9 @@ _get_one_line_summary (const void *ctx, notmuch_message_t *message)
 static void
 format_message_json (sprinter_t *sp, notmuch_message_t *message)
 {
 static void
 format_message_json (sprinter_t *sp, notmuch_message_t *message)
 {
+    /* Any changes to the JSON format should be reflected in the file
+     * devel/schemata. */
+
     void *local = talloc_new (NULL);
     notmuch_tags_t *tags;
     time_t date;
     void *local = talloc_new (NULL);
     notmuch_tags_t *tags;
     time_t date;
@@ -208,6 +211,9 @@ void
 format_headers_json (sprinter_t *sp, GMimeMessage *message,
                     notmuch_bool_t reply)
 {
 format_headers_json (sprinter_t *sp, GMimeMessage *message,
                     notmuch_bool_t reply)
 {
+    /* Any changes to the JSON format should be reflected in the file
+     * devel/schemata. */
+
     InternetAddressList *recipients;
     const char *recipients_string;
     const char *reply_to_string;
     InternetAddressList *recipients;
     const char *recipients_string;
     const char *reply_to_string;
@@ -359,6 +365,9 @@ signer_status_to_string (GMimeSignerStatus x)
 static void
 format_part_sigstatus_json (sprinter_t *sp, mime_node_t *node)
 {
 static void
 format_part_sigstatus_json (sprinter_t *sp, mime_node_t *node)
 {
+    /* Any changes to the JSON format should be reflected in the file
+     * devel/schemata. */
+
     GMimeSignatureList *siglist = node->sig_list;
 
     sp->begin_list (sp);
     GMimeSignatureList *siglist = node->sig_list;
 
     sp->begin_list (sp);