diff options
| author | David Bremner <david@tethera.net> | 2016-06-04 19:17:41 -0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2016-06-07 07:51:57 -0300 |
| commit | ba0b95f846820b1d71f67731a8c38ac2866c921a (patch) | |
| tree | e9f27f21324494f28785f5726d371deeb32b256c /lib/database.cc | |
| parent | 6a833a6e83865f6999707cc30768d07e1351c2cb (diff) | |
lib: document config metadata
This probably should have been part of 3458e3c89c, but I missed it.
Diffstat (limited to 'lib/database.cc')
| -rw-r--r-- | lib/database.cc | 8 |
1 files changed, 8 insertions, 0 deletions
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 * ----------------- * |