From: David Bremner <david@tethera.net>
To: michaeljgruber+grubix+git@gmail.com, notmuch@notmuchmail.org
Cc: Michael J Gruber <git@grubix.eu>
Subject: [PATCH] doc: replace symlink with duplicate page for nmbug
Date: Thu, 30 Jun 2022 08:20:34 -0300 [thread overview]
Message-ID: <20220630112034.3923518-1-david@tethera.net> (raw)
In-Reply-To: <0dce59bb4edc9c10ab2baf8d6d33cb3f204fc1f3.1656411268.git.git@grubix.eu>
This automatically propagates to the info version of the pages, which
saves having maintain two sets of symlinks.
---
What do you think about this as an alternative approach? It seems
slightly more maintainable to me, although I am willing to be
convinced otherwise. If it is an improvement we could do the same for
the notmuch-setup page.
doc/Makefile.local | 3 ++-
doc/conf.py | 4 ++++
2 files changed, 6 insertions(+), 1 deletion(-)
diff --git a/doc/Makefile.local b/doc/Makefile.local
index 2f67f4de..123ef10b 100644
--- a/doc/Makefile.local
+++ b/doc/Makefile.local
@@ -19,6 +19,7 @@ MAN_RST_FILES := $(MAN1_RST) $(MAN5_RST) $(MAN7_RST)
ALL_RST_FILES := $(MAN_RST_FILES) $(srcdir)/doc/notmuch-emacs.rst
MAN1_ROFF := $(patsubst $(srcdir)/doc/%,$(DOCBUILDDIR)/man/%,$(MAN1_RST:.rst=.1))
+MAN1_ROFF := $(MAN1_ROFF) $(DOCBUILDDIR)/man/man1/nmbug.1
MAN5_ROFF := $(patsubst $(srcdir)/doc/%,$(DOCBUILDDIR)/man/%,$(MAN5_RST:.rst=.5))
MAN7_ROFF := $(patsubst $(srcdir)/doc/%,$(DOCBUILDDIR)/man/%,$(MAN7_RST:.rst=.7))
MAN_ROFF_FILES := $(MAN1_ROFF) $(MAN5_ROFF) $(MAN7_ROFF)
@@ -26,6 +27,7 @@ MAN_ROFF_FILES := $(MAN1_ROFF) $(MAN5_ROFF) $(MAN7_ROFF)
MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})
MAN1_TEXI := $(patsubst $(srcdir)/doc/man1/%.rst,$(DOCBUILDDIR)/texinfo/%.texi,$(MAN1_RST))
+MAN1_TEXI := $(MAN1_TEXI) $(DOCBUILDDIR)/texinfo/nmbug.info
MAN5_TEXI := $(patsubst $(srcdir)/doc/man5/%.rst,$(DOCBUILDDIR)/texinfo/%.texi,$(MAN5_RST))
MAN7_TEXI := $(patsubst $(srcdir)/doc/man7/%.rst,$(DOCBUILDDIR)/texinfo/%.texi,$(MAN7_RST))
INFO_TEXI_FILES := $(MAN1_TEXI) $(MAN5_TEXI) $(MAN7_TEXI)
@@ -131,7 +133,6 @@ install-man: ${MAN_GZIP_FILES}
install -m0644 $(filter %.5.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man5
install -m0644 $(filter %.7.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man7
cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz
- cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch-git.1.gz nmbug.1.gz
endif
ifneq ($(HAVE_SPHINX)$(HAVE_MAKEINFO),11)
diff --git a/doc/conf.py b/doc/conf.py
index f01c0058..ed27c3f4 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -127,6 +127,10 @@ man_pages = [
u'manage notmuch tags with git',
[notmuch_authors], 1),
+ ('man1/notmuch-git', 'nmbug',
+ u'manage notmuch bugs with git',
+ [notmuch_authors], 1),
+
('man5/notmuch-hooks', 'notmuch-hooks',
u'hooks for notmuch',
[notmuch_authors], 5),
--
2.35.2
next prev parent reply other threads:[~2022-06-30 11:20 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-28 11:57 [PATCH] doc: provide nmbug link for notmuch-git info page michaeljgruber+grubix+git
2022-06-30 11:20 ` David Bremner [this message]
2022-06-30 12:39 ` [PATCH] doc: replace symlink with duplicate page for nmbug Michael J Gruber
2022-07-01 1:14 ` [PATCH v2] doc: replace symlink with copies for nmbug, notmuch-setup David Bremner
2022-07-03 21:07 ` 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=20220630112034.3923518-1-david@tethera.net \
--to=david@tethera.net \
--cc=git@grubix.eu \
--cc=michaeljgruber+grubix+git@gmail.com \
--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).