* [PATCH] doc: provide nmbug link for notmuch-git info page
@ 2022-06-28 11:57 michaeljgruber+grubix+git
2022-06-30 11:20 ` [PATCH] doc: replace symlink with duplicate page for nmbug David Bremner
0 siblings, 1 reply; 5+ messages in thread
From: michaeljgruber+grubix+git @ 2022-06-28 11:57 UTC (permalink / raw)
To: notmuch; +Cc: Michael J Gruber
From: Michael J Gruber <git@grubix.eu>
8ed68c1b ("CLI/git: change defaults for repo and prefix", 2022-05-07)
introduced an nmbug symlink for the notmuch-git man page. Do the same
for the info page.
Signed-off-by: Michael J Gruber <git@grubix.eu>
---
While I don't use info pages personally, I package them ... Upcoming
Fedora packages will have a notmuch-git subpackage.
This probably needs a debian-specific follow-up patch which I am lacking
the expertise for.
doc/Makefile.local | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/doc/Makefile.local b/doc/Makefile.local
index 2f67f4de..1908eb83 100644
--- a/doc/Makefile.local
+++ b/doc/Makefile.local
@@ -148,7 +148,9 @@ else
install-info: build-info
mkdir -m0755 -p "$(DESTDIR)$(infodir)"
install -m0644 $(INFO_INFO_FILES) $(DESTDIR)$(infodir)
- for file in $(INFO_INFO_FILES); do install-info $$file $(DESTDIR)$(infodir)/dir; done
+ cd $(DESTDIR)$(infodir) && ln -sf notmuch-git.info nmbug.info
+ for file in $(INFO_INFO_FILES) $(DESTDIR)$(infodir)/nmbug.info; do install-info $$file $(DESTDIR)$(infodir)/dir; done
+ cd
endif
$(dir)/config.dox: version.stamp
--
2.37.0.rc2.141.g1312637e40
^ permalink raw reply related [flat|nested] 5+ messages in thread* [PATCH] doc: replace symlink with duplicate page for nmbug 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 2022-06-30 12:39 ` Michael J Gruber 0 siblings, 1 reply; 5+ messages in thread From: David Bremner @ 2022-06-30 11:20 UTC (permalink / raw) To: michaeljgruber+grubix+git, notmuch; +Cc: Michael J Gruber 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 ^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] doc: replace symlink with duplicate page for nmbug 2022-06-30 11:20 ` [PATCH] doc: replace symlink with duplicate page for nmbug David Bremner @ 2022-06-30 12:39 ` Michael J Gruber 2022-07-01 1:14 ` [PATCH v2] doc: replace symlink with copies for nmbug, notmuch-setup David Bremner 0 siblings, 1 reply; 5+ messages in thread From: Michael J Gruber @ 2022-06-30 12:39 UTC (permalink / raw) To: David Bremner; +Cc: notmuch Am Do., 30. Juni 2022 um 13:20 Uhr schrieb David Bremner <david@tethera.net>: > > 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. Looks OK to me. I just followed the man example (by linking), after I had noticed the asymmetry, but copies work fine, too. You probably also want to add them to `make install`. > 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 > ^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH v2] doc: replace symlink with copies for nmbug, notmuch-setup 2022-06-30 12:39 ` Michael J Gruber @ 2022-07-01 1:14 ` David Bremner 2022-07-03 21:07 ` David Bremner 0 siblings, 1 reply; 5+ messages in thread From: David Bremner @ 2022-07-01 1:14 UTC (permalink / raw) To: Michael J Gruber, David Bremner; +Cc: notmuch Previously only man page aliases were being added as symlinks. The addition to man_pages in conf.py automatically propagates to the list of generated info pages. Installation of the new pages is handled by existing recipes. --- doc/Makefile.local | 7 ++++--- doc/conf.py | 8 ++++++++ 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/doc/Makefile.local b/doc/Makefile.local index 2f67f4de..51c729cf 100644 --- a/doc/Makefile.local +++ b/doc/Makefile.local @@ -18,7 +18,9 @@ MAN7_RST := $(wildcard $(srcdir)/doc/man7/*.rst) MAN_RST_FILES := $(MAN1_RST) $(MAN5_RST) $(MAN7_RST) ALL_RST_FILES := $(MAN_RST_FILES) $(srcdir)/doc/notmuch-emacs.rst +COPY_ROFF1 := $(patsubst %,$(DOCBUILDDIR)/man/man1/%.1,nmbug notmuch-setup) MAN1_ROFF := $(patsubst $(srcdir)/doc/%,$(DOCBUILDDIR)/man/%,$(MAN1_RST:.rst=.1)) +MAN1_ROFF := $(MAN1_ROFF) $(COPY_ROFF1) 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) @@ -33,7 +35,8 @@ ifeq ($(WITH_EMACS),1) INFO_TEXI_FILES += $(DOCBUILDDIR)/texinfo/notmuch-emacs.texi endif -INFO_INFO_FILES := $(INFO_TEXI_FILES:.texi=.info) +COPY_INFO1 := $(patsubst $(DOCBUILDDIR)/man/man1/%.1,$(DOCBUILDDIR)/texinfo/%.info,$(COPY_ROFF1)) +INFO_INFO_FILES := $(INFO_TEXI_FILES:.texi=.info) $(COPY_INFO1) .PHONY: sphinx-html sphinx-texinfo sphinx-info @@ -130,8 +133,6 @@ install-man: ${MAN_GZIP_FILES} install -m0644 $(filter %.1.gz,$(MAN_GZIP_FILES)) $(DESTDIR)/$(mandir)/man1 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..7f94cbed 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), @@ -163,6 +167,10 @@ man_pages = [ u'syntax for notmuch queries', [notmuch_authors], 7), + ('man1/notmuch', 'notmuch-setup', + u'getting started with notmuch', + [notmuch_authors], 1), + ('man7/notmuch-sexp-queries', 'notmuch-sexp-queries', u's-expression syntax for notmuch queries', [notmuch_authors], 7), -- 2.35.2 ^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH v2] doc: replace symlink with copies for nmbug, notmuch-setup 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 0 siblings, 0 replies; 5+ messages in thread From: David Bremner @ 2022-07-03 21:07 UTC (permalink / raw) To: Michael J Gruber; +Cc: notmuch David Bremner <david@tethera.net> writes: > Previously only man page aliases were being added as symlinks. The > addition to man_pages in conf.py automatically propagates to the list > of generated info pages. > > Installation of the new pages is handled by existing recipes. applied to master d ^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2022-07-03 21:07 UTC | newest] Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2022-06-28 11:57 [PATCH] doc: provide nmbug link for notmuch-git info page michaeljgruber+grubix+git 2022-06-30 11:20 ` [PATCH] doc: replace symlink with duplicate page for nmbug David Bremner 2022-06-30 12:39 ` 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
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).