<feed xmlns='http://www.w3.org/2005/Atom'>
<title>notmuch/doc/man1, branch 0.33.2</title>
<subtitle>thread-based email index, search, and tagging</subtitle>
<id>https://git.notmuchmail.org/git/notmuch/atom?h=0.33.2</id>
<link rel='self' href='https://git.notmuchmail.org/git/notmuch/atom?h=0.33.2'/>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/'/>
<updated>2021-08-21T14:54:44Z</updated>
<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: new notmuch show --sort and related emacs commands</title>
<updated>2021-07-03T23:38:34Z</updated>
<author>
<name>jao</name>
<email>jao@gnu.org</email>
</author>
<published>2021-07-02T20:44:24Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=32f42581e35ee0ebdd89c4cb44292e7979dc5eb7'/>
<id>urn:sha1:32f42581e35ee0ebdd89c4cb44292e7979dc5eb7</id>
<content type='text'>
New --sort CLI option documented in notmuch-show's man page, and
notmuch-search-toggle-order mentioned in doc/notmuch-emacs.rst and
devel/emacs-keybindings.org (in the latter, there's also some
whitespace changes in a table introduced by org-mode).
</content>
</entry>
<entry>
<title>doc: document database.autocommit variable</title>
<updated>2021-06-27T17:04:43Z</updated>
<author>
<name>David Bremner</name>
<email>david@tethera.net</email>
</author>
<published>2021-05-22T01:06:02Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=42b5cb53ef321dc1caec524934d703489bc9c1b2'/>
<id>urn:sha1:42b5cb53ef321dc1caec524934d703489bc9c1b2</id>
<content type='text'>
This exposes some database internals that most users will probably not
understand.
</content>
</entry>
<entry>
<title>Merge branch 'release'</title>
<updated>2021-06-25T12:34:29Z</updated>
<author>
<name>David Bremner</name>
<email>david@tethera.net</email>
</author>
<published>2021-06-25T12:34:29Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=4b0c6fb2f1ba989fee554cb8fa2612046d6414a8'/>
<id>urn:sha1:4b0c6fb2f1ba989fee554cb8fa2612046d6414a8</id>
<content type='text'>
</content>
</entry>
<entry>
<title>doc: tweak hook configuration documentation.</title>
<updated>2021-06-23T11:42:48Z</updated>
<author>
<name>David Bremner</name>
<email>david@tethera.net</email>
</author>
<published>2021-06-22T23:08:13Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=5be9e024d18386f650c7f58f640dfa5f5dcdf066'/>
<id>urn:sha1:5be9e024d18386f650c7f58f640dfa5f5dcdf066</id>
<content type='text'>
Add a historical note, and hint to look below for more about hooks.
Capitalized the heading for consistency, removed blank line.
</content>
</entry>
<entry>
<title>doc: example command-line option reference</title>
<updated>2021-05-22T19:47:32Z</updated>
<author>
<name>Jani Nikula</name>
<email>jani@nikula.org</email>
</author>
<published>2021-05-21T20:44:13Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=1222cba7e4e2d74ed8c5278a898778b8c856f7bc'/>
<id>urn:sha1:1222cba7e4e2d74ed8c5278a898778b8c856f7bc</id>
<content type='text'>
Example reference to a command-line option using the option role
reference. This creates a hyperlink in html, and the usual boldface
style in man page. This could be used throughout the man pages.
</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>
</feed>
