From: Tomi Ollila <tomi.ollila@iki.fi>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: Re: [PATCH] lib: document config metadata
In-Reply-To: <1465078661-30810-1-git-send-email-david@tethera.net>
References: <1465078661-30810-1-git-send-email-david@tethera.net>
User-Agent: Notmuch/0.22+32~gd4854c5 (http://notmuchmail.org) Emacs/24.5.1
 (x86_64-unknown-linux-gnu)
Date: Sun, 05 Jun 2016 18:44:19 +0300
Message-ID: <m2vb1n63os.fsf@guru.guru-group.fi>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: list

On Sun, Jun 05 2016, David Bremner <david@tethera.net> wrote:

> 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.

tabs vs spaces... which wins???!!!

> + *			query.notmuch stores the value for the named
> + *			query 'notmuch'), but it is not enforced by the
> + *			API.
> + *
>   * Obsolete metadata
>   * -----------------
>   *
> -- 
> 2.8.1