From: David Bremner <david@tethera.net>
Date: Sat, 4 Jun 2016 22:17:41 +0000 (-0300)
Subject: lib: document config metadata
X-Git-Url: http://rtime.felk.cvut.cz/gitweb/notmuch.git/commitdiff_plain/ba0b95f846820b1d71f67731a8c38ac2866c921a

lib: document config metadata

This probably should have been part of 3458e3c89c, but I missed it.
---

diff --git a/lib/database.cc b/lib/database.cc
index 86bf2619..2b2d8219 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
  * -----------------
  *