From: Jani Nikula <jani@nikula.org>
To: notmuch@notmuchmail.org
Cc: jani@nikula.org
Subject: [PATCH 0/5] doc: man page cleanup
Date: Fri, 21 May 2021 23:44:08 +0300 [thread overview]
Message-ID: <20210521204413.554563-1-jani@nikula.org> (raw)
I saw [1] and decided to give it some love. :)
Mostly this is all about adding html cross-references all over the place
while trying to keep the roff man pages roughly the same. Also updating
the man page rst becomes easier by setting a clean example.
BR,
Jani.
[1] https://notmuchmail.org/doc/latest/
Jani Nikula (5):
doc: use manpage role references to external man pages
doc: cross-reference notmuch man pages with actual links
doc: use envvar directive and role for environment variables
doc: use program and option directives to document options
doc: example command-line option reference
doc/conf.py | 5 +
doc/man1/notmuch-address.rst | 204 ++++++++--------
doc/man1/notmuch-compact.rst | 48 ++--
doc/man1/notmuch-config.rst | 147 ++++++------
doc/man1/notmuch-count.rst | 87 ++++---
doc/man1/notmuch-dump.rst | 176 +++++++-------
doc/man1/notmuch-emacs-mua.rst | 101 ++++----
doc/man1/notmuch-insert.rst | 128 +++++-----
doc/man1/notmuch-new.rst | 102 ++++----
doc/man1/notmuch-reindex.rst | 71 +++---
doc/man1/notmuch-reply.rst | 121 +++++-----
doc/man1/notmuch-restore.rst | 154 ++++++------
doc/man1/notmuch-search.rst | 264 +++++++++++----------
doc/man1/notmuch-show.rst | 380 ++++++++++++++++--------------
doc/man1/notmuch-tag.rst | 63 ++---
doc/man1/notmuch.rst | 139 ++++++-----
doc/man5/notmuch-hooks.rst | 54 +++--
doc/man7/notmuch-properties.rst | 36 +--
doc/man7/notmuch-search-terms.rst | 50 ++--
19 files changed, 1245 insertions(+), 1085 deletions(-)
--
2.30.2
next reply other threads:[~2021-05-21 20:44 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-21 20:44 Jani Nikula [this message]
2021-05-21 20:44 ` [PATCH 1/5] doc: use manpage role references to external man pages Jani Nikula
2021-05-21 20:44 ` [PATCH 2/5] doc: cross-reference notmuch man pages with actual links Jani Nikula
2021-05-21 20:44 ` [PATCH 3/5] doc: use envvar directive and role for environment variables Jani Nikula
2021-05-21 20:44 ` [PATCH 4/5] doc: use program and option directives to document options Jani Nikula
2021-05-21 20:44 ` [PATCH 5/5] doc: example command-line option reference Jani Nikula
2021-05-22 19:51 ` [PATCH 0/5] doc: man page cleanup David Bremner
2021-05-22 22:15 ` Jani Nikula
2021-05-22 22:33 ` David Bremner
2021-05-22 22:56 ` Jani Nikula
2021-05-22 23:43 ` David Bremner
2021-05-23 11:13 ` David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210521204413.554563-1-jani@nikula.org \
--to=jani@nikula.org \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).