From fdf8dbcd341fda5f327146d2c2852ba1a3ee03ec Mon Sep 17 00:00:00 2001 From: David Bremner Date: Wed, 12 Mar 2014 09:05:55 +2100 Subject: [PATCH] [Patch v2 3/3] doc: configure detection of sphinx and rst2man --- 5c/08b99f2e417618a93273ea0f8f20aae50452bc | 158 ++++++++++++++++++++++ 1 file changed, 158 insertions(+) create mode 100644 5c/08b99f2e417618a93273ea0f8f20aae50452bc diff --git a/5c/08b99f2e417618a93273ea0f8f20aae50452bc b/5c/08b99f2e417618a93273ea0f8f20aae50452bc new file mode 100644 index 000000000..2b89a260b --- /dev/null +++ b/5c/08b99f2e417618a93273ea0f8f20aae50452bc @@ -0,0 +1,158 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id C365A431FD0 + for ; Tue, 11 Mar 2014 05:06:27 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0 +X-Spam-Level: +X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none] + autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id zaegCz0F77+Y for ; + Tue, 11 Mar 2014 05:06:25 -0700 (PDT) +Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155]) + (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 97A3A431FD2 + for ; Tue, 11 Mar 2014 05:06:13 -0700 (PDT) +Received: from remotemail by yantan.tethera.net with local (Exim 4.80) + (envelope-from ) + id 1WNLRl-0007Jt-9G; Tue, 11 Mar 2014 09:06:13 -0300 +Received: (nullmailer pid 28627 invoked by uid 1000); Tue, 11 Mar 2014 + 12:05:59 -0000 +From: David Bremner +To: notmuch@notmuchmail.org +Subject: [Patch v2 3/3] doc: configure detection of sphinx and rst2man +Date: Tue, 11 Mar 2014 09:05:55 -0300 +Message-Id: <1394539555-28334-4-git-send-email-david@tethera.net> +X-Mailer: git-send-email 1.8.5.3 +In-Reply-To: <1394539555-28334-1-git-send-email-david@tethera.net> +References: <1394539555-28334-1-git-send-email-david@tethera.net> +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Tue, 11 Mar 2014 12:06:28 -0000 + +Because sphinx-build does not provide a convenient way of listing +which builders exist, and some people actually have pre 1.0 sphinx, we +try loading a relevant python module. + +Currently the assumption is that no python in path -> no sphinx-build +in path. +--- + configure | 27 +++++++++++++++++++++++++++ + doc/Makefile.local | 24 +++++++++++++++--------- + 2 files changed, 42 insertions(+), 9 deletions(-) + +diff --git a/configure b/configure +index 2eaed4a..4aaecc6 100755 +--- a/configure ++++ b/configure +@@ -393,6 +393,27 @@ else + have_emacs=0 + fi + ++printf "Checking if sphinx is available and supports nroff output... " ++if hash sphinx-build > /dev/null 2>&1 && python -m sphinx.writers.manpage > /dev/null 2>&1 ; then ++ printf "Yes.\n" ++ have_sphinx=1 ++ have_rst2man=0 ++else ++ printf "No (falling back to rst2man).\n" ++ have_sphinx=0 ++ ++ printf "Checking if rst2man is available... " ++ if rst2man -V > /dev/null 2>&1; then ++ printf "Yes.\n" ++ have_rst2man=1 ++ else ++ printf "No (so will not install man pages).\n" ++ have_rst2man=0 ++ fi ++fi ++ ++ ++ + libdir_in_ldconfig=0 + + printf "Checking which platform we are on... " +@@ -759,6 +780,12 @@ emacsetcdir=${EMACSETCDIR} + # Whether there's an emacs binary available for byte-compiling + HAVE_EMACS = ${have_emacs} + ++# Whether there's a sphinx-build binary available for building documentation ++HAVE_SPHINX=${have_sphinx} ++ ++# Whether there's a rst2man binary available for building documentation ++HAVE_RST2MAN=${have_rst2man} ++ + # The directory to which desktop files should be installed + desktop_dir = \$(prefix)/share/applications + +diff --git a/doc/Makefile.local b/doc/Makefile.local +index 23f4095..4883c4a 100644 +--- a/doc/Makefile.local ++++ b/doc/Makefile.local +@@ -33,21 +33,26 @@ sphinx-info: sphinx-texinfo + + MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES}) + +-build-man: ${MAN_GZIP_FILES} +- +-${MAN_ROFF_FILES}: ${dir}/man.stamp +- +-$(dir)/man.stamp: ${MAN_RST_FILES} ++# Use the man page converter that is available. We should never depend ++# on MAN_ROFF_FILES if a converter is not available. ++${MAN_ROFF_FILES}: ${MAN_RST_FILES} + ifeq ($(HAVE_SPHINX),1) + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man +- touch $@ + else ifeq ($(HAVE_RST2MAN),1) + $(prerst2man) $(DOCBUILDDIR)/.. $(DOCBUILDDIR)/man +- touch $@ + else +- @echo "No sphinx or rst2man, will not install man pages." ++ @echo "Fatal: build dependency fail." ++ @false + endif + ++# Do not try to build or install man pages if a man page converter is ++# not available. ++ifeq ($(HAVE_SPHINX)$(HAVE_RST2MAN),00) ++build-man: ++install-man: ++ @echo "No sphinx or rst2man, will not install man pages." ++else ++build-man: ${MAN_GZIP_FILES} + install-man: ${MAN_GZIP_FILES} + mkdir -p "$(DESTDIR)$(mandir)/man1" + mkdir -p "$(DESTDIR)$(mandir)/man5" +@@ -56,9 +61,10 @@ install-man: ${MAN_GZIP_FILES} + install -m0644 $(DOCBUILDDIR)/man/*.5.gz $(DESTDIR)/$(mandir)/man5 + install -m0644 $(DOCBUILDDIR)/man/*.7.gz $(DESTDIR)/$(mandir)/man7 + cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz ++endif + + $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py + $(mkdocdeps) $< $(DOCBUILDDIR) $@ + +-CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(dir)/man.stamp ++CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk + CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) +-- +1.8.5.3 + -- 2.26.2