lib: document config metadata

This probably should have been part of 3458e3c89c, but I missed it.
This commit is contained in:
David Bremner 2016-06-04 19:17:41 -03:00
parent 6a833a6e83
commit ba0b95f846

View file

@ -185,6 +185,14 @@ typedef struct {
* generated is 1 and the value will be * generated is 1 and the value will be
* incremented for each thread ID. * 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 * Obsolete metadata
* ----------------- * -----------------
* *