[PATCH 1/3] doc: build man pages at build time; introduce HAVE_SPHINX, HAVE_RST2MAN

diff --git a/5d/2ba0981f464554fd791122e90da20f2a9900cd b/5d/2ba0981f464554fd791122e90da20f2a9900cd
new file mode 100644 (file)
index 0000000..1d698a5
--- /dev/null
+++ b/5d/2ba0981f464554fd791122e90da20f2a9900cd
@@ -0,0 +1,159 @@
+Return-Path: <bremner@tethera.net>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id BA7FF431FBF\r
+       for <notmuch@notmuchmail.org>; Mon, 10 Mar 2014 19:20:15 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id Q27-w1-ES1N1 for <notmuch@notmuchmail.org>;\r
+       Mon, 10 Mar 2014 19:20:11 -0700 (PDT)\r
+Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155])\r
+       (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id B3B89431FBC\r
+       for <notmuch@notmuchmail.org>; Mon, 10 Mar 2014 19:20:11 -0700 (PDT)\r
+Received: from remotemail by yantan.tethera.net with local (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1WNCIa-0005Q4-Md; Mon, 10 Mar 2014 23:20:08 -0300\r
+Received: (nullmailer pid 7587 invoked by uid 1000); Tue, 11 Mar 2014\r
+       02:20:05 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 1/3] doc: build man pages at build time; introduce\r
+       HAVE_SPHINX, HAVE_RST2MAN\r
+Date: Mon, 10 Mar 2014 23:18:27 -0300\r
+Message-Id: <1394504309-7433-1-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.8.5.3\r
+In-Reply-To: <m2y50hisnb.fsf@guru.guru-group.fi>\r
+References: <m2y50hisnb.fsf@guru.guru-group.fi>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Tue, 11 Mar 2014 02:20:15 -0000\r
+\r
+This helps avoid build artifacts (namely, nroff and gzipped-nroff man\r
+pages) owned by root.\r
+\r
+The variables allow choosing which generator to use for the man page.\r
+These will be hooked to configure in a following commit.\r
+---\r
+ Makefile.local     |  2 +-\r
+ doc/Makefile.local | 31 ++++++++++++++++++-------------\r
+ doc/mkdocdeps.py   |  3 +++\r
+ 3 files changed, 22 insertions(+), 14 deletions(-)\r
+\r
+diff --git a/Makefile.local b/Makefile.local\r
+index 5f797ad..cb7b106 100644\r
+--- a/Makefile.local\r
++++ b/Makefile.local\r
+@@ -53,7 +53,7 @@ endif\r
+ FINAL_LIBNOTMUCH_LDFLAGS = $(LDFLAGS) $(AS_NEEDED_LDFLAGS) $(CONFIGURE_LDFLAGS)\r
+ \r
+ .PHONY: all\r
+-all: notmuch notmuch-shared\r
++all: notmuch notmuch-shared build-man\r
+ ifeq ($(MAKECMDGOALS),)\r
+ ifeq ($(shell cat .first-build-message 2>/dev/null),)\r
+       @NOTMUCH_FIRST_BUILD=1 $(MAKE) --no-print-directory all\r
+diff --git a/doc/Makefile.local b/doc/Makefile.local\r
+index fd64f70..23f4095 100644\r
+--- a/doc/Makefile.local\r
++++ b/doc/Makefile.local\r
+@@ -13,10 +13,9 @@ mkdocdeps := python $(dir)/mkdocdeps.py\r
+ # Internal variables.\r
+ ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(dir)\r
+ \r
+-.PHONY: sphinx-html sphinx-man sphinx-texinfo sphinx-info\r
+-.PHONY: rst2man\r
++.PHONY: sphinx-html sphinx-texinfo sphinx-info\r
+ \r
+-.PHONY: install-man\r
++.PHONY: install-man build-man\r
+ \r
+ %.gz: %\r
+       rm -f $@ && gzip --stdout $^ > $@\r
+@@ -24,24 +23,30 @@ ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(dir)\r
+ sphinx-html:\r
+       $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOCBUILDDIR)/html\r
+ \r
+-sphinx-man:\r
+-      $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man\r
+-\r
+ sphinx-texinfo:\r
+       $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(DOCBUILDDIR)/texinfo\r
+ \r
+ sphinx-info: sphinx-texinfo\r
+       make -C $(DOCBUILDDIR)/texinfo info\r
+ \r
+-# fallback target in case sphinx not installed\r
+-rst2man:\r
+-      $(prerst2man) $(DOCBUILDDIR)/.. $(DOCBUILDDIR)/man\r
+-\r
+ -include $(dir)/docdeps.mk\r
+ \r
+ MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})\r
+ \r
+-${MAN_ROFF_FILES} : sphinx-man\r
++build-man: ${MAN_GZIP_FILES}\r
++\r
++${MAN_ROFF_FILES}: ${dir}/man.stamp\r
++\r
++$(dir)/man.stamp: ${MAN_RST_FILES}\r
++ifeq ($(HAVE_SPHINX),1)\r
++      $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man\r
++      touch $@\r
++else ifeq ($(HAVE_RST2MAN),1)\r
++      $(prerst2man) $(DOCBUILDDIR)/.. $(DOCBUILDDIR)/man\r
++      touch $@\r
++else\r
++      @echo "No sphinx or rst2man, will not install man pages."\r
++endif\r
+ \r
+ install-man: ${MAN_GZIP_FILES}\r
+       mkdir -p "$(DESTDIR)$(mandir)/man1"\r
+@@ -52,8 +57,8 @@ install-man: ${MAN_GZIP_FILES}\r
+       install -m0644 $(DOCBUILDDIR)/man/*.7.gz $(DESTDIR)/$(mandir)/man7\r
+       cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz\r
+ \r
+-\r
+ $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py\r
+       $(mkdocdeps) $< $(DOCBUILDDIR) $@\r
+ \r
+-CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk\r
++CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(dir)/man.stamp\r
++CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES)\r
+diff --git a/doc/mkdocdeps.py b/doc/mkdocdeps.py\r
+index 2f4a959..e61bea6 100644\r
+--- a/doc/mkdocdeps.py\r
++++ b/doc/mkdocdeps.py\r
+@@ -6,8 +6,11 @@ outfile = argv[3]\r
+ execfile(conffile)\r
+ \r
+ roff_files = []\r
++rst_files = []\r
+ out=open(outfile,'w')\r
+ for page in man_pages:\r
++    rst_files = rst_files + ["doc/{0:s}.rst".format(page[0])]\r
+     roff_files = roff_files + ["{0:s}/man/{1:s}.{2:d}".format(builddir,page[1],page[4])]\r
+ \r
+ out.write ('MAN_ROFF_FILES := ' + ' \\\n\t'.join(roff_files)+'\n')\r
++out.write ('MAN_RST_FILES := ' + ' \\\n\t'.join(rst_files)+'\n')\r
+-- \r
+1.8.5.3\r
+\r