unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
* [PATCH] lib: document config metadata
@ 2016-06-04 22:17 David Bremner
  2016-06-05 15:44 ` Tomi Ollila
  2016-06-07 10:56 ` David Bremner
  0 siblings, 2 replies; 3+ messages in thread
From: David Bremner @ 2016-06-04 22:17 UTC (permalink / raw)
  To: notmuch

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

^ permalink raw reply related	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2016-06-07 10:56 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-06-04 22:17 [PATCH] lib: document config metadata David Bremner
2016-06-05 15:44 ` Tomi Ollila
2016-06-07 10:56 ` David Bremner

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).