Re: [PATCH] doc: replace symlink with duplicate page for nmbug

Subject: Re: [PATCH] doc: replace symlink with duplicate page for nmbug

Date: Thu, 30 Jun 2022 14:39:33 +0200

To: David Bremner

Cc: notmuch@notmuchmail.org

From: Michael J Gruber

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
>
_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: