[RFC Patch] doc: configure detection of sphinx and rst2man

diff --git a/ed/8324b5a876f47426f5bec09e89126a4689424b b/ed/8324b5a876f47426f5bec09e89126a4689424b
new file mode 100644 (file)
index 0000000..aba52ce
--- /dev/null
+++ b/ed/8324b5a876f47426f5bec09e89126a4689424b
@@ -0,0 +1,147 @@
+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 13360431FBD\r
+       for <notmuch@notmuchmail.org>; Mon, 10 Mar 2014 05:05:29 -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 nRcUHOGdm9Ek for <notmuch@notmuchmail.org>;\r
+       Mon, 10 Mar 2014 05:05:25 -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 C568E431FBC\r
+       for <notmuch@notmuchmail.org>; Mon, 10 Mar 2014 05:05:25 -0700 (PDT)\r
+Received: from remotemail by yantan.tethera.net with local (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1WMyxP-0001OM-Bc; Mon, 10 Mar 2014 09:05:23 -0300\r
+Received: (nullmailer pid 26573 invoked by uid 1000); Mon, 10 Mar 2014\r
+       12:05:19 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [RFC Patch] doc: configure detection of sphinx and rst2man\r
+Date: Mon, 10 Mar 2014 09:04:59 -0300\r
+Message-Id: <1394453099-26505-1-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.8.5.3\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: Mon, 10 Mar 2014 12:05:29 -0000\r
+\r
+Because sphinx-build does not provide a convenient way of listing\r
+which builders exist, and some people actually have pre 1.0 sphinx, we\r
+try loading a relevant python module.\r
+\r
+Currently the assumption is that no python in path -> no sphinx-build\r
+in path.\r
+---\r
+ configure          | 27 +++++++++++++++++++++++++++\r
+ doc/Makefile.local | 22 ++++++++++++++++++++--\r
+ 2 files changed, 47 insertions(+), 2 deletions(-)\r
+\r
+diff --git a/configure b/configure\r
+index 2eaed4a..0976c67 100755\r
+--- a/configure\r
++++ b/configure\r
+@@ -393,6 +393,27 @@ else\r
+     have_emacs=0\r
+ fi\r
+ \r
++printf "Checking if sphinx is available and supports nroff output... "\r
++if hash sphinx-build && python -m sphinx.writers.manpage > /dev/null 2>&1 ; then\r
++    printf "Yes.\n"\r
++    have_sphinx=1\r
++    have_rst2man=0\r
++else\r
++    printf "No (falling back to rst2man).\n"\r
++    have_sphinx=0\r
++\r
++    printf "Checking if rst2man is available... "\r
++    if rst2man -V > /dev/null 2>&1; then\r
++       printf "Yes.\n"\r
++       have_rst2man=1\r
++    else\r
++       printf "No (so will not install man pages).\n"\r
++       have_rst2man=0\r
++    fi\r
++fi\r
++\r
++\r
++\r
+ libdir_in_ldconfig=0\r
+ \r
+ printf "Checking which platform we are on... "\r
+@@ -759,6 +780,12 @@ emacsetcdir=${EMACSETCDIR}\r
+ # Whether there's an emacs binary available for byte-compiling\r
+ HAVE_EMACS = ${have_emacs}\r
+ \r
++# Whether there's a sphinx-build binary available for building documentation\r
++HAVE_SPHINX=${have_sphinx}\r
++\r
++# Whether there's a rst2man binary available and used for building documentation\r
++HAVE_RST2MAN=${have_rst2man}\r
++\r
+ # The directory to which desktop files should be installed\r
+ desktop_dir = \$(prefix)/share/applications\r
+ \r
+diff --git a/doc/Makefile.local b/doc/Makefile.local\r
+index 5be49dc..a5e3000 100644\r
+--- a/doc/Makefile.local\r
++++ b/doc/Makefile.local\r
+@@ -16,7 +16,7 @@ ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(dir)\r
+ .PHONY: sphinx-html sphinx-man sphinx-texinfo sphinx-info\r
+ .PHONY: rst2man\r
+ \r
+-.PHONY: install-man build-man\r
++.PHONY: install-man build-man build-man-real\r
+ \r
+ %.gz: %\r
+       rm -f $@ && gzip --stdout $^ > $@\r
+@@ -41,9 +41,27 @@ rst2man:\r
+ \r
+ MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})\r
+ \r
++build-man-real: ${MAN_GZIP_FILES}\r
++\r
++ifeq ($(HAVE_SPHINX),1)\r
++\r
+ ${MAN_ROFF_FILES} : sphinx-man\r
++build-man: build-man-real\r
++\r
++else ifeq ($(HAVE_RST2MAN),1)\r
++\r
++${MAN_ROFF_FILES} : rst2man\r
++build-man: build-man-real\r
++\r
++else\r
++\r
++install-man:\r
++      @echo "No sphinx or rst2man, will not install man pages."\r
++\r
++endif\r
++\r
++\r
+ \r
+-build-man: ${MAN_GZIP_FILES}\r
+ \r
+ install-man: build-man\r
+       mkdir -p "$(DESTDIR)$(mandir)/man1"\r
+-- \r
+1.8.5.3\r
+\r