<feed xmlns='http://www.w3.org/2005/Atom'>
<title>notmuch/doc/man1/notmuch-dump.rst, branch master</title>
<subtitle>thread-based email index, search, and tagging</subtitle>
<id>https://git.notmuchmail.org/git/notmuch/atom?h=master</id>
<link rel='self' href='https://git.notmuchmail.org/git/notmuch/atom?h=master'/>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/'/>
<updated>2021-10-25T11:25:22Z</updated>
<entry>
<title>doc: remove explicit formatting of terms in definition lists</title>
<updated>2021-10-25T11:25:22Z</updated>
<author>
<name>David Bremner</name>
<email>david@tethera.net</email>
</author>
<published>2021-10-11T12:56:14Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=00fdf10937a3ef0292424fb67208b74c753b35fd'/>
<id>urn:sha1:00fdf10937a3ef0292424fb67208b74c753b35fd</id>
<content type='text'>
Sphinx-doc already formats the terms appropriately for a given
backend (bold in html and man). `makeinfo` complains noisily about
formatting inside a @item if we add our own explicit formatting.

This change may change the formatting in the info output. On the other
hand, the existing use of quotes for bold is not that great anyway.

In some places blank lines were removed to preserve the logical
structure of a definition list.
</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: 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>doc: clean up manpages</title>
<updated>2018-06-25T00:59:37Z</updated>
<author>
<name>Daniel Kahn Gillmor</name>
<email>dkg@fifthhorseman.net</email>
</author>
<published>2018-06-19T22:36:16Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=fd3c93650d976f630ba0a60341a1a695422e4969'/>
<id>urn:sha1:fd3c93650d976f630ba0a60341a1a695422e4969</id>
<content type='text'>
Many of the manpages didn't treat literal text as literal text.  I've
tried to normalize some of the restructured text to make it a bit more
regular.

several of the synopsis lines are still untouched by this cleanup, but
i'm not sure what the right way to represent those is in .rst,
actually.

In particular find that if i rebuild the manpages, sometimes i end up
with some of the synopsis lines showing – (U+2013 EN DASH) where they
should have -- (2 × U+002D HYPHEN-MINUS) in the generated nroff
output, though i have not tracked down the source of this error yet.
</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: add notmuch-properties(7)</title>
<updated>2017-10-21T22:52:55Z</updated>
<author>
<name>Daniel Kahn Gillmor</name>
<email>dkg@fifthhorseman.net</email>
</author>
<published>2017-10-21T02:25:39Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=6575b7eb31a710c8215be698d5cf31be20d4356e'/>
<id>urn:sha1:6575b7eb31a710c8215be698d5cf31be20d4356e</id>
<content type='text'>
We will want a user-facing place to record details about the use of
notmuch properties shortly.  This establishes a new manual page for
that purpose.
</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: fix documentation typos and copy/paste-os</title>
<updated>2017-10-19T01:36:09Z</updated>
<author>
<name>Daniel Kahn Gillmor</name>
<email>dkg@fifthhorseman.net</email>
</author>
<published>2017-10-17T16:57:20Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=5fb0f5f113e7cb7422fb44bb7abcba2bcadfc0c8'/>
<id>urn:sha1:5fb0f5f113e7cb7422fb44bb7abcba2bcadfc0c8</id>
<content type='text'>
</content>
</entry>
<entry>
<title>cli/dump: bump dump format version to 3</title>
<updated>2017-04-01T12:10:15Z</updated>
<author>
<name>David Bremner</name>
<email>david@tethera.net</email>
</author>
<published>2017-03-31T10:55:17Z</published>
<link rel='alternate' type='text/html' href='https://git.notmuchmail.org/git/notmuch/commit/?id=d47e18411807b57cac9aaa29a7435a9f83720b81'/>
<id>urn:sha1:d47e18411807b57cac9aaa29a7435a9f83720b81</id>
<content type='text'>
No changes to the format of the body, but the header format was
fixed, and version 2 headers probably shouldn't be relied on.
</content>
</entry>
</feed>
