[PATCH] lib: document config metadata

diff --git a/fe/caa1b86255507cf9b64c2bab5a9f9cbe125b99 b/fe/caa1b86255507cf9b64c2bab5a9f9cbe125b99
new file mode 100644 (file)
index 0000000..bad74fb
--- /dev/null
+++ b/fe/caa1b86255507cf9b64c2bab5a9f9cbe125b99
@@ -0,0 +1,72 @@
+Return-Path: <bremner@tethera.net>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by arlo.cworth.org (Postfix) with ESMTP id 273646DE01F7\r
+ for <notmuch@notmuchmail.org>; Sat,  4 Jun 2016 15:18:04 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.012\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.012 tagged_above=-999 required=5\r
+ tests=[AWL=-0.001, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01]\r
+ autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id Rw_lOtj4QjE7 for <notmuch@notmuchmail.org>;\r
+ Sat,  4 Jun 2016 15:17:56 -0700 (PDT)\r
+Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197])\r
+ by arlo.cworth.org (Postfix) with ESMTPS id 544476DE01D0\r
+ for <notmuch@notmuchmail.org>; Sat,  4 Jun 2016 15:17:56 -0700 (PDT)\r
+Received: from remotemail by fethera.tethera.net with local (Exim 4.84)\r
+ (envelope-from <bremner@tethera.net>)\r
+ id 1b9Jt0-0003nR-9U; Sat, 04 Jun 2016 18:17:42 -0400\r
+Received: (nullmailer pid 30853 invoked by uid 1000);\r
+ Sat, 04 Jun 2016 22:17:51 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] lib: document config metadata\r
+Date: Sat,  4 Jun 2016 19:17:41 -0300\r
+Message-Id: <1465078661-30810-1-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 2.8.1\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.20\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <https://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch/>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sat, 04 Jun 2016 22:18:04 -0000\r
+\r
+This probably should have been part of 3458e3c89c, but I missed it.\r
+---\r
+ lib/database.cc | 8 ++++++++\r
+ 1 file changed, 8 insertions(+)\r
+\r
+diff --git a/lib/database.cc b/lib/database.cc\r
+index 9630000..ecf576f 100644\r
+--- a/lib/database.cc\r
++++ b/lib/database.cc\r
+@@ -185,6 +185,14 @@ typedef struct {\r
+  *                    generated is 1 and the value will be\r
+  *                    incremented for each thread ID.\r
+  *\r
++ *      C*              metadata keys starting with C indicate\r
++ *                      configuration data. It can be managed with the\r
++ *                      n_database_*config* API.  There is a convention\r
++ *                    of hierarchical keys separated by '.' (e.g.\r
++ *                    query.notmuch stores the value for the named\r
++ *                    query 'notmuch'), but it is not enforced by the\r
++ *                    API.\r
++ *\r
+  * Obsolete metadata\r
+  * -----------------\r
+  *\r
+-- \r
+2.8.1\r
+\r