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