<feed xmlns='http://www.w3.org/2005/Atom'>
<title>notmuch/doc/man1/notmuch.rst, branch release</title>
<subtitle>thread-based email index, search, and tagging</subtitle>
<id>https://git.notmuchmail.org/git/notmuch/atom?h=release</id>
<link rel='self' href='https://git.notmuchmail.org/git/notmuch/atom?h=release'/>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/'/>
<updated>2022-08-11T10:32:04Z</updated>
<entry>
<title>doc: add some documentation about duplicate files.</title>
<updated>2022-08-11T10:32:04Z</updated>
<author>
<name>David Bremner</name>
<email>david@tethera.net</email>
</author>
<published>2022-07-30T23:45:51Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=bf64c48855f41833b57e0a770ad37f6a16a1193b'/>
<id>urn:sha1:bf64c48855f41833b57e0a770ad37f6a16a1193b</id>
<content type='text'>
This is mainly motivated by the new emacs-UI features to select
duplicates, but hopefully it will help demystify things for users of
the CLI as well.
</content>
</entry>
<entry>
<title>doc/notmuch: merge two sections on external commands.</title>
<updated>2022-08-06T12:20:24Z</updated>
<author>
<name>David Bremner</name>
<email>david@tethera.net</email>
</author>
<published>2022-07-30T23:45:49Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=429924b28ffe80872a49f254adb2e456ec61c953'/>
<id>urn:sha1:429924b28ffe80872a49f254adb2e456ec61c953</id>
<content type='text'>
When adding the description of the propagation of NOTMUCH_CONFIG, I
missed that there was already a section on external commands, with a
different title.
</content>
</entry>
<entry>
<title>CLI: document handling of --config for external commands</title>
<updated>2022-06-13T10:28:35Z</updated>
<author>
<name>David Bremner</name>
<email>david@tethera.net</email>
</author>
<published>2022-05-31T11:51:00Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=a5504e8b1cfd8dddfe395ba4a46da3ea6008e714'/>
<id>urn:sha1:a5504e8b1cfd8dddfe395ba4a46da3ea6008e714</id>
<content type='text'>
Create a section of the notmuch(1) manpage to have some place to put
this documentation.
</content>
</entry>
<entry>
<title>doc: document database search algorithm.</title>
<updated>2021-08-21T14:54:44Z</updated>
<author>
<name>David Bremner</name>
<email>david@tethera.net</email>
</author>
<published>2021-08-04T10:42:36Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=be6edee49660308131cbc7a6eb51e38c642cc098'/>
<id>urn:sha1:be6edee49660308131cbc7a6eb51e38c642cc098</id>
<content type='text'>
Essentially a translation of the function _choose_database_path for
human consumption. As a bonus, document environment variable
NOTMUCH_DATABASE
</content>
</entry>
<entry>
<title>replace references to freenode with references to libera</title>
<updated>2021-07-06T20:20:03Z</updated>
<author>
<name>David Bremner</name>
<email>david@tethera.net</email>
</author>
<published>2021-07-06T20:19:03Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=dd91621d808589e90168fb410c2c4b3b924f1eb8'/>
<id>urn:sha1:dd91621d808589e90168fb410c2c4b3b924f1eb8</id>
<content type='text'>
I left the reference to freenode in the test suite data, since it is
historical.
</content>
</entry>
<entry>
<title>doc: use program and option directives to document options</title>
<updated>2021-05-22T19:43:24Z</updated>
<author>
<name>Jani Nikula</name>
<email>jani@nikula.org</email>
</author>
<published>2021-05-21T20:44:12Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=f2e2f2aa96cb0d40c6fb85cde2ab82380c367485'/>
<id>urn:sha1:f2e2f2aa96cb0d40c6fb85cde2ab82380c367485</id>
<content type='text'>
Use the program and option directives to document the subcommand
options. This unifies a lot of option documentation throughout.

This also makes it possible to reference options with :option:`--foo`
(within .. program::) or :option:`subcommand --foo` (globally). This
is left for later work.

See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program

Note: There is a lot of indentation change, but intentionally there is
no reflow. Using 'git diff -w' or 'git show -w' to ignore white space
changes makes this a very easy change to review.
</content>
</entry>
<entry>
<title>doc: use envvar directive and role for environment variables</title>
<updated>2021-05-22T19:41:20Z</updated>
<author>
<name>Jani Nikula</name>
<email>jani@nikula.org</email>
</author>
<published>2021-05-21T20:44:11Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=574b2436eeabf60c930ba227931ee87b0b151a65'/>
<id>urn:sha1:574b2436eeabf60c930ba227931ee87b0b151a65</id>
<content type='text'>
Make man1/notmuch.rst the single point of truth for describing notmuch
environment variables. Use the envvar directive for that, and
reference them with the envvar role.

Drive-by cleanup configuration file and hook directory search order
documentation.
</content>
</entry>
<entry>
<title>doc: cross-reference notmuch man pages with actual links</title>
<updated>2021-05-22T19:38:56Z</updated>
<author>
<name>Jani Nikula</name>
<email>jani@nikula.org</email>
</author>
<published>2021-05-21T20:44:10Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=ff4e81ac57dee5a62f35093c2966f931a7b7580c'/>
<id>urn:sha1:ff4e81ac57dee5a62f35093c2966f931a7b7580c</id>
<content type='text'>
Add internal hyperlink targets for man pages and cross-reference them
using the any role reference. There are a number of alternatives to
accomplish this, but this seems like the combination that retains the
man page section number and the same boldface style in the man pages.

As a bonus, we get sanity checking on the links; for example
notmuch-search-terms.rst had a reference to notmuch-properties(1)
i.e. the wrong section.

The obvious semantic follow-up change would be to only have meaningful
"see also" references instead of having them all everywhere.
</content>
</entry>
<entry>
<title>doc: use manpage role references to external man pages</title>
<updated>2021-05-22T12:56:52Z</updated>
<author>
<name>Jani Nikula</name>
<email>jani@nikula.org</email>
</author>
<published>2021-05-21T20:44:09Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=3baa61e0e58402bc50c5df529fcf669bf4b2facb'/>
<id>urn:sha1:3baa61e0e58402bc50c5df529fcf669bf4b2facb</id>
<content type='text'>
Using manpage role references generates helpful links in html
documentation, while retaining the same boldface style in the man
pages.

The external man page site is configurable. The Debian manpage site
seems like a good fit for Notmuch.
</content>
</entry>
<entry>
<title>CLI/config: default to storing all config in external files</title>
<updated>2021-03-27T12:26:14Z</updated>
<author>
<name>David Bremner</name>
<email>david@tethera.net</email>
</author>
<published>2021-02-19T12:41:36Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=dd9112e7d8e89e8566b90379f5f3b1461a2d2845'/>
<id>urn:sha1:dd9112e7d8e89e8566b90379f5f3b1461a2d2845</id>
<content type='text'>
Previously the fact that some configuration options were only stored
in the database (and thus editing the config file had no effect) was a
source of user confusion. This was fixed with the series ending at
d9af0af1646.

On the other hand, the underlying partition of config options into
those stored by default in the database and those stored in the config
file remained. This is also confusing, since now some invocations of
"notmuch config set" modify the config file, and others silently
modify the database instead.

With this commit, it is up to the user to decide which configuration
to modify. A new "--database" option is provided for notmuch config to
enable modifying the configuration information in the database;
otherwise the default is to update an external config file.
</content>
</entry>
</feed>
