b2/59c8bd36a49cddaa77517d484f157c1a320966

   1 Return-Path: <wking@tremily.us>\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 84F20431FAE\r
   6         for <notmuch@notmuchmail.org>; Sat,  5 Apr 2014 10:31:49 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"\r
   9 X-Spam-Flag: NO\r
  10 X-Spam-Score: 0\r
  11 X-Spam-Level: \r
  12 X-Spam-Status: No, score=0 tagged_above=-999 required=5\r
  13         tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001]\r
  14         autolearn=disabled\r
  15 Received: from olra.theworths.org ([127.0.0.1])\r
  16         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  17         with ESMTP id xqXxD9ajZEbf for <notmuch@notmuchmail.org>;\r
  18         Sat,  5 Apr 2014 10:31:43 -0700 (PDT)\r
  19 Received: from qmta06.westchester.pa.mail.comcast.net\r
  20         (qmta06.westchester.pa.mail.comcast.net [76.96.62.56])\r
  21         by olra.theworths.org (Postfix) with ESMTP id 33B4D431FC3\r
  22         for <notmuch@notmuchmail.org>; Sat,  5 Apr 2014 10:31:29 -0700 (PDT)\r
  23 Received: from omta15.westchester.pa.mail.comcast.net ([76.96.62.87])\r
  24         by qmta06.westchester.pa.mail.comcast.net with comcast\r
  25         id mHGf1n0061swQuc56HXUeP; Sat, 05 Apr 2014 17:31:28 +0000\r
  26 Received: from odin.tremily.us ([24.18.63.50])\r
  27         by omta15.westchester.pa.mail.comcast.net with comcast\r
  28         id mHXT1n010152l3L3bHXUeu; Sat, 05 Apr 2014 17:31:28 +0000\r
  29 Received: from mjolnir.tremily.us (unknown [192.168.0.140])\r
  30         by odin.tremily.us (Postfix) with ESMTPS id 87F921103C1F;\r
  31         Sat,  5 Apr 2014 10:31:27 -0700 (PDT)\r
  32 Received: (nullmailer pid 16926 invoked by uid 1000);\r
  33         Sat, 05 Apr 2014 17:31:16 -0000\r
  34 From: "W. Trevor King" <wking@tremily.us>\r
  35 To: notmuch@notmuchmail.org\r
  36 Subject: [PATCH 7/7] doc/INSTALL: Remove rst2man reference and other updates\r
  37 Date: Sat,  5 Apr 2014 10:31:11 -0700\r
  38 Message-Id:\r
  39  <edf9a674bc1f41917caead8d38b5f09295a9d1bd.1396718720.git.wking@tremily.us>\r
  40 X-Mailer: git-send-email 1.9.1.353.gc66d89d\r
  41 In-Reply-To: <cover.1396718720.git.wking@tremily.us>\r
  42 References: <cover.1396718720.git.wking@tremily.us>\r
  43 In-Reply-To: <cover.1396718720.git.wking@tremily.us>\r
  44 References: <cover.1396718720.git.wking@tremily.us>\r
  45 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=comcast.net;\r
  46         s=q20140121; t=1396719088;\r
  47         bh=Md1lXhCOAAM7U0DXVtjgsDLZgIqNFseI7EmJUDR5LR8=;\r
  48         h=Received:Received:Received:Received:From:To:Subject:Date:\r
  49         Message-Id;\r
  50         b=uudER3SFvCG/HBEAOC1f+Jlu2qAyN4rO2Af0sfxAAJNtJTGBZI0YzMwVP1Sx889yS\r
  51         1aX4JMfNpGfUSXbCR0tQV7TWsUIqGiTi583MIEo9rv/A/p0scG1BbORku3QzBb9zfj\r
  52         zTOtFYlsdEQ9+dhIJvi//shOXDU92r8AVKYbxx8CHTDidptExAua16cmUbJo5rCTu+\r
  53         MsRPRCkRKzOjOD/F+FSKNxDn/Rzz+MXZ4BfL7kUVvspL8vH+v7Rs773dVYJ+zQ6unQ\r
  54         2tTaCJJ9JVtmF9kKEb61y9MGG4L0ufkRHcFrYK75QAaDVH0XJfZ/t4POPqWiIgta3u\r
  55         yzZ1zPpYXSVtA==\r
  56 X-BeenThere: notmuch@notmuchmail.org\r
  57 X-Mailman-Version: 2.1.13\r
  58 Precedence: list\r
  59 List-Id: "Use and development of the notmuch mail system."\r
  60         <notmuch.notmuchmail.org>\r
  61 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  62         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  63 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  64 List-Post: <mailto:notmuch@notmuchmail.org>\r
  65 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  66 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  67         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  68 X-List-Received-Date: Sat, 05 Apr 2014 17:31:49 -0000\r
  69 \r
  70 The rst2man target was removed in 9d9a700 (doc: build man pages at\r
  71 build time; introduce HAVE_SPHINX, HAVE_RST2MAN, 2014-03-13), but a\r
  72 reference in the install docs slipped through.  While I was removing\r
  73 that reference, I also:\r
  74 \r
  75 * Converted doc/INSTALL to reStructuredText, so I can link to Sphinx\r
  76   and Docutils directly.  Not everyone has access to Debian's\r
  77   python-docutils, so it's better to be genric here.\r
  78 * Converted from an unordered list to paragraphs, because I think it\r
  79   flows better.\r
  80 * Dropped the rst2man no-automatic-install caveat.  I don't think this\r
  81   applies to the current code, although I haven't tried to track down\r
  82   a commit that adds the automatic-install support.  Anyhow,\r
  83 \r
  84     $ make HAVE_SPHINX=0 RST2MAN=/usr/bin/rst2man.py DESTDIR=/tmp/ install-man\r
  85 \r
  86   works for me.\r
  87 ---\r
  88  doc/INSTALL | 34 ++++++++++++++++++++--------------\r
  89  1 file changed, 20 insertions(+), 14 deletions(-)\r
  90 \r
  91 diff --git a/doc/INSTALL b/doc/INSTALL\r
  92 index e37c2b9..91222f9 100644\r
  93 --- a/doc/INSTALL\r
  94 +++ b/doc/INSTALL\r
  95 @@ -1,24 +1,30 @@\r
  96  This file contains some more detailed information about building and\r
  97  installing the documentation.\r
  98  \r
  99 -Building with sphinx.\r
 100 ----------------------\r
 101 +Building with Sphinx\r
 102 +--------------------\r
 103  \r
 104 -- You need sphinx at least version 1.0.\r
 105 +With Sphinx_ version 1.0 or greater, you can build man, info, html,\r
 106 +and pdf versions of the docs (currently only the man pages) with::\r
 107  \r
 108 -- You can build build and install man pages with 'make install-man'\r
 109 +  make build-{man|info|html|pdf}\r
 110  \r
 111 -- You can build man, info, html, and pdf versions of the docs\r
 112 -  (currently only the man pages) with\r
 113 +You can build build and install the docs (currently only the man\r
 114 +pages) with::\r
 115  \r
 116 -     'make install-{man|info|html|pdf}'\r
 117 +  make install-{man|info|html|pdf}\r
 118  \r
 119 -Building the man pages\r
 120 -----------------------\r
 121 +Building the man Docutils\r
 122 +-------------------------\r
 123  \r
 124 -- You can build the man pages with rst2man (from python-docutils) with\r
 125 -  'make rst2man'.\r
 126 +If you don't have Sphinx installed, you can still build the man-page\r
 127 +version of the docs using rst2man (from Docutils_)::\r
 128  \r
 129 -- Currently there is no support to automagically install the resulting\r
 130 -  nroff files, but it should work to modify the target install-man\r
 131 -  in doc/Makefile.local.\r
 132 +  make build-man\r
 133 +\r
 134 +and install with::\r
 135 +\r
 136 +  make install-man\r
 137 +\r
 138 +.. _Sphinx: http://sphinx-doc.org/\r
 139 +.. _Docutils: http://docutils.sourceforge.net/\r
 140 -- \r
 141 1.9.1.353.gc66d89d\r
 142 \r