Re: [PATCH] Add default configuration values to the man page

[Michal Sojka <sojkam1@fel.cvut.cz>]

On Wed, Oct 01 2014, Sergei Shilovsky wrote:
> ---
>  doc/man1/notmuch-config.rst | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
>
> diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
> index 3c9a568..9de5534 100644
> --- a/doc/man1/notmuch-config.rst
> +++ b/doc/man1/notmuch-config.rst
> @@ -49,19 +49,31 @@ The available configuration items are described below.
>          within a sub-directory of the path configured here named
>          ``.notmuch``.
>
> +        Default: ``$MAILDIR``, otherwise ``$HOME/mail``.

To be consistent with the rest, this should be "``$MAILDIR`` variable if
set"

> +
>      **user.name**
>          Your full name.
>
> +        Default: ``$NAME`` variable if set, otherwise read from
> +        ``/etc/passwd``.
> +
>      **user.primary\_email**
>          Your primary email address.
>
> +        Default: ``$EMAIL`` variable if set, otherwise constructed from the
> +        username and hostname of the current machine.
> +
>      **user.other\_email**
>          A list of other email addresses at which you receive email.
>
> +        Default: not set.
> +
>      **new.tags**
>          A list of tags that will be added to all messages incorporated
>          by **notmuch new**.
>
> +        Default: ``unread;inbox``.
> +
>      **new.ignore**
>          A list of file and directory names, without path, that will not
>          be searched for messages by **notmuch new**. All the files and
> @@ -69,11 +81,15 @@ The available configuration items are described below.
>          ignored, regardless of the location in the mail store directory
>          hierarchy.
>
> +        Default: no tags.

This should be "empty list".

> +
>      **search.exclude\_tags**
>          A list of tags that will be excluded from search results by
>          default. Using an excluded tag in a query will override that
>          exclusion.
>
> +        Default: ``deleted;spam``.
> +
>      **maildir.synchronize\_flags**
>          If true, then the following maildir flags (in message filenames)
>          will be synchronized with the corresponding notmuch tags:
> @@ -104,6 +120,8 @@ The available configuration items are described below.
>          are properly synchronized to the maildir flags, as the commands
>          expect the database and maildir to be in sync.
>
> +        Default: ``true``.
> +
>  ENVIRONMENT
>  ===========

Cheers,
-Michal