<feed xmlns='http://www.w3.org/2005/Atom'>
<title>notmuch/doc/man1/notmuch-compact.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>2021-05-22T19:43:24Z</updated>
<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: unify definition list usage across man pages</title>
<updated>2017-12-31T13:06:11Z</updated>
<author>
<name>Jani Nikula</name>
<email>jani@nikula.org</email>
</author>
<published>2017-12-30T17:16:11Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=e5e252de5560fee386bd46f8f279c800b953c667'/>
<id>urn:sha1:e5e252de5560fee386bd46f8f279c800b953c667</id>
<content type='text'>
Make all parameter descriptions etc. use reStructuredText definition
lists with uniform style and indentation. Remove redundant indentation
from around the lists. Remove blank lines between term lines and
definition blocks. Use four spaces for indentation.

This is almost completely whitespace and paragraph reflow changes.
</content>
</entry>
<entry>
<title>doc: make SEE ALSO references one-per-line</title>
<updated>2017-10-19T01:36:39Z</updated>
<author>
<name>Daniel Kahn Gillmor</name>
<email>dkg@fifthhorseman.net</email>
</author>
<published>2017-10-17T16:57:21Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=6499fce3911df2646db67c0f1ff65672324904f0'/>
<id>urn:sha1:6499fce3911df2646db67c0f1ff65672324904f0</id>
<content type='text'>
This will make future diffs cleaner, make it easier to keep them
alphabetical, and make it easier to scan and search the documentation
sources.
</content>
</entry>
<entry>
<title>doc: convert sphinx based docs</title>
<updated>2014-03-09T13:41:08Z</updated>
<author>
<name>David Bremner</name>
<email>david@tethera.net</email>
</author>
<published>2014-01-28T16:12:37Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=d736260385a689b5c77d8121f48e29440e3adfa4'/>
<id>urn:sha1:d736260385a689b5c77d8121f48e29440e3adfa4</id>
<content type='text'>
This is the output from sphinx-quickstart, massaged a bit, along with
our existing man pages converted to rst.

A skeleton notmuch-emacs manual is also included. It is not suitable
for end user use yet.
</content>
</entry>
</feed>
