ed/8324b5a876f47426f5bec09e89126a4689424b

   1 Return-Path: <bremner@tethera.net>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 13360431FBD\r
   6         for <notmuch@notmuchmail.org>; Mon, 10 Mar 2014 05:05:29 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: 0\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
  12         autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id nRcUHOGdm9Ek for <notmuch@notmuchmail.org>;\r
  16         Mon, 10 Mar 2014 05:05:25 -0700 (PDT)\r
  17 Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155])\r
  18         (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
  19         (No client certificate requested)\r
  20         by olra.theworths.org (Postfix) with ESMTPS id C568E431FBC\r
  21         for <notmuch@notmuchmail.org>; Mon, 10 Mar 2014 05:05:25 -0700 (PDT)\r
  22 Received: from remotemail by yantan.tethera.net with local (Exim 4.80)\r
  23         (envelope-from <bremner@tethera.net>)\r
  24         id 1WMyxP-0001OM-Bc; Mon, 10 Mar 2014 09:05:23 -0300\r
  25 Received: (nullmailer pid 26573 invoked by uid 1000); Mon, 10 Mar 2014\r
  26         12:05:19 -0000\r
  27 From: David Bremner <david@tethera.net>\r
  28 To: notmuch@notmuchmail.org\r
  29 Subject: [RFC Patch] doc: configure detection of sphinx and rst2man\r
  30 Date: Mon, 10 Mar 2014 09:04:59 -0300\r
  31 Message-Id: <1394453099-26505-1-git-send-email-david@tethera.net>\r
  32 X-Mailer: git-send-email 1.8.5.3\r
  33 X-BeenThere: notmuch@notmuchmail.org\r
  34 X-Mailman-Version: 2.1.13\r
  35 Precedence: list\r
  36 List-Id: "Use and development of the notmuch mail system."\r
  37         <notmuch.notmuchmail.org>\r
  38 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  39         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  40 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  41 List-Post: <mailto:notmuch@notmuchmail.org>\r
  42 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  43 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  44         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  45 X-List-Received-Date: Mon, 10 Mar 2014 12:05:29 -0000\r
  46 \r
  47 Because sphinx-build does not provide a convenient way of listing\r
  48 which builders exist, and some people actually have pre 1.0 sphinx, we\r
  49 try loading a relevant python module.\r
  50 \r
  51 Currently the assumption is that no python in path -> no sphinx-build\r
  52 in path.\r
  53 ---\r
  54  configure          | 27 +++++++++++++++++++++++++++\r
  55  doc/Makefile.local | 22 ++++++++++++++++++++--\r
  56  2 files changed, 47 insertions(+), 2 deletions(-)\r
  57 \r
  58 diff --git a/configure b/configure\r
  59 index 2eaed4a..0976c67 100755\r
  60 --- a/configure\r
  61 +++ b/configure\r
  62 @@ -393,6 +393,27 @@ else\r
  63      have_emacs=0\r
  64  fi\r
  65  \r
  66 +printf "Checking if sphinx is available and supports nroff output... "\r
  67 +if hash sphinx-build && python -m sphinx.writers.manpage > /dev/null 2>&1 ; then\r
  68 +    printf "Yes.\n"\r
  69 +    have_sphinx=1\r
  70 +    have_rst2man=0\r
  71 +else\r
  72 +    printf "No (falling back to rst2man).\n"\r
  73 +    have_sphinx=0\r
  74 +\r
  75 +    printf "Checking if rst2man is available... "\r
  76 +    if rst2man -V > /dev/null 2>&1; then\r
  77 +       printf "Yes.\n"\r
  78 +       have_rst2man=1\r
  79 +    else\r
  80 +       printf "No (so will not install man pages).\n"\r
  81 +       have_rst2man=0\r
  82 +    fi\r
  83 +fi\r
  84 +\r
  85 +\r
  86 +\r
  87  libdir_in_ldconfig=0\r
  88  \r
  89  printf "Checking which platform we are on... "\r
  90 @@ -759,6 +780,12 @@ emacsetcdir=${EMACSETCDIR}\r
  91  # Whether there's an emacs binary available for byte-compiling\r
  92  HAVE_EMACS = ${have_emacs}\r
  93  \r
  94 +# Whether there's a sphinx-build binary available for building documentation\r
  95 +HAVE_SPHINX=${have_sphinx}\r
  96 +\r
  97 +# Whether there's a rst2man binary available and used for building documentation\r
  98 +HAVE_RST2MAN=${have_rst2man}\r
  99 +\r
 100  # The directory to which desktop files should be installed\r
 101  desktop_dir = \$(prefix)/share/applications\r
 102  \r
 103 diff --git a/doc/Makefile.local b/doc/Makefile.local\r
 104 index 5be49dc..a5e3000 100644\r
 105 --- a/doc/Makefile.local\r
 106 +++ b/doc/Makefile.local\r
 107 @@ -16,7 +16,7 @@ ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(dir)\r
 108  .PHONY: sphinx-html sphinx-man sphinx-texinfo sphinx-info\r
 109  .PHONY: rst2man\r
 110  \r
 111 -.PHONY: install-man build-man\r
 112 +.PHONY: install-man build-man build-man-real\r
 113  \r
 114  %.gz: %\r
 115         rm -f $@ && gzip --stdout $^ > $@\r
 116 @@ -41,9 +41,27 @@ rst2man:\r
 117  \r
 118  MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})\r
 119  \r
 120 +build-man-real: ${MAN_GZIP_FILES}\r
 121 +\r
 122 +ifeq ($(HAVE_SPHINX),1)\r
 123 +\r
 124  ${MAN_ROFF_FILES} : sphinx-man\r
 125 +build-man: build-man-real\r
 126 +\r
 127 +else ifeq ($(HAVE_RST2MAN),1)\r
 128 +\r
 129 +${MAN_ROFF_FILES} : rst2man\r
 130 +build-man: build-man-real\r
 131 +\r
 132 +else\r
 133 +\r
 134 +install-man:\r
 135 +       @echo "No sphinx or rst2man, will not install man pages."\r
 136 +\r
 137 +endif\r
 138 +\r
 139 +\r
 140  \r
 141 -build-man: ${MAN_GZIP_FILES}\r
 142  \r
 143  install-man: build-man\r
 144         mkdir -p "$(DESTDIR)$(mandir)/man1"\r
 145 -- \r
 146 1.8.5.3\r
 147 \r