Re: [PATCH] lib: document config metadata

diff --git a/1f/8d551d583e3521450670c0933575e37dd49014 b/1f/8d551d583e3521450670c0933575e37dd49014
new file mode 100644 (file)
index 0000000..00bd11b
--- /dev/null
+++ b/1f/8d551d583e3521450670c0933575e37dd49014
@@ -0,0 +1,81 @@
+Return-Path: <tomi.ollila@iki.fi>\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 13EF66DE0140\r
+ for <notmuch@notmuchmail.org>; Sun,  5 Jun 2016 08:44:44 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.577\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.577 tagged_above=-999 required=5 tests=[AWL=-0.075,\r
+  SPF_NEUTRAL=0.652] 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 LK9Dp-uBRp1i for <notmuch@notmuchmail.org>;\r
+ Sun,  5 Jun 2016 08:44:35 -0700 (PDT)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+ by arlo.cworth.org (Postfix) with ESMTP id 9EE146DE01C2\r
+ for <notmuch@notmuchmail.org>; Sun,  5 Jun 2016 08:44:35 -0700 (PDT)\r
+Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
+ by guru.guru-group.fi (Postfix) with ESMTP id 47B68100104;\r
+ Sun,  5 Jun 2016 18:44:19 +0300 (EEST)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH] lib: document config metadata\r
+In-Reply-To: <1465078661-30810-1-git-send-email-david@tethera.net>\r
+References: <1465078661-30810-1-git-send-email-david@tethera.net>\r
+User-Agent: Notmuch/0.22+32~gd4854c5 (http://notmuchmail.org) Emacs/24.5.1\r
+ (x86_64-unknown-linux-gnu)\r
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
+ $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
+ !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
+Date: Sun, 05 Jun 2016 18:44:19 +0300\r
+Message-ID: <m2vb1n63os.fsf@guru.guru-group.fi>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\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: Sun, 05 Jun 2016 15:44:44 -0000\r
+\r
+On Sun, Jun 05 2016, David Bremner <david@tethera.net> wrote:\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
+\r
+tabs vs spaces... which wins???!!!\r
+\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