From: W. Trevor King Date: Sat, 5 Apr 2014 17:31:11 +0000 (+1700) Subject: [PATCH 7/7] doc/INSTALL: Remove rst2man reference and other updates X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=e4f5508d15a8f58ec59e0d85976c71ff58302337;p=notmuch-archives.git [PATCH 7/7] doc/INSTALL: Remove rst2man reference and other updates --- diff --git a/b2/59c8bd36a49cddaa77517d484f157c1a320966 b/b2/59c8bd36a49cddaa77517d484f157c1a320966 new file mode 100644 index 000000000..a7fc7029c --- /dev/null +++ b/b2/59c8bd36a49cddaa77517d484f157c1a320966 @@ -0,0 +1,142 @@ +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 84F20431FAE + for ; Sat, 5 Apr 2014 10:31:49 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References" +X-Spam-Flag: NO +X-Spam-Score: 0 +X-Spam-Level: +X-Spam-Status: No, score=0 tagged_above=-999 required=5 + tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001] + 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 xqXxD9ajZEbf for ; + Sat, 5 Apr 2014 10:31:43 -0700 (PDT) +Received: from qmta06.westchester.pa.mail.comcast.net + (qmta06.westchester.pa.mail.comcast.net [76.96.62.56]) + by olra.theworths.org (Postfix) with ESMTP id 33B4D431FC3 + for ; Sat, 5 Apr 2014 10:31:29 -0700 (PDT) +Received: from omta15.westchester.pa.mail.comcast.net ([76.96.62.87]) + by qmta06.westchester.pa.mail.comcast.net with comcast + id mHGf1n0061swQuc56HXUeP; Sat, 05 Apr 2014 17:31:28 +0000 +Received: from odin.tremily.us ([24.18.63.50]) + by omta15.westchester.pa.mail.comcast.net with comcast + id mHXT1n010152l3L3bHXUeu; Sat, 05 Apr 2014 17:31:28 +0000 +Received: from mjolnir.tremily.us (unknown [192.168.0.140]) + by odin.tremily.us (Postfix) with ESMTPS id 87F921103C1F; + Sat, 5 Apr 2014 10:31:27 -0700 (PDT) +Received: (nullmailer pid 16926 invoked by uid 1000); + Sat, 05 Apr 2014 17:31:16 -0000 +From: "W. Trevor King" +To: notmuch@notmuchmail.org +Subject: [PATCH 7/7] doc/INSTALL: Remove rst2man reference and other updates +Date: Sat, 5 Apr 2014 10:31:11 -0700 +Message-Id: + +X-Mailer: git-send-email 1.9.1.353.gc66d89d +In-Reply-To: +References: +In-Reply-To: +References: +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=comcast.net; + s=q20140121; t=1396719088; + bh=Md1lXhCOAAM7U0DXVtjgsDLZgIqNFseI7EmJUDR5LR8=; + h=Received:Received:Received:Received:From:To:Subject:Date: + Message-Id; + b=uudER3SFvCG/HBEAOC1f+Jlu2qAyN4rO2Af0sfxAAJNtJTGBZI0YzMwVP1Sx889yS + 1aX4JMfNpGfUSXbCR0tQV7TWsUIqGiTi583MIEo9rv/A/p0scG1BbORku3QzBb9zfj + zTOtFYlsdEQ9+dhIJvi//shOXDU92r8AVKYbxx8CHTDidptExAua16cmUbJo5rCTu+ + MsRPRCkRKzOjOD/F+FSKNxDn/Rzz+MXZ4BfL7kUVvspL8vH+v7Rs773dVYJ+zQ6unQ + 2tTaCJJ9JVtmF9kKEb61y9MGG4L0ufkRHcFrYK75QAaDVH0XJfZ/t4POPqWiIgta3u + yzZ1zPpYXSVtA== +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: Sat, 05 Apr 2014 17:31:49 -0000 + +The rst2man target was removed in 9d9a700 (doc: build man pages at +build time; introduce HAVE_SPHINX, HAVE_RST2MAN, 2014-03-13), but a +reference in the install docs slipped through. While I was removing +that reference, I also: + +* Converted doc/INSTALL to reStructuredText, so I can link to Sphinx + and Docutils directly. Not everyone has access to Debian's + python-docutils, so it's better to be genric here. +* Converted from an unordered list to paragraphs, because I think it + flows better. +* Dropped the rst2man no-automatic-install caveat. I don't think this + applies to the current code, although I haven't tried to track down + a commit that adds the automatic-install support. Anyhow, + + $ make HAVE_SPHINX=0 RST2MAN=/usr/bin/rst2man.py DESTDIR=/tmp/ install-man + + works for me. +--- + doc/INSTALL | 34 ++++++++++++++++++++-------------- + 1 file changed, 20 insertions(+), 14 deletions(-) + +diff --git a/doc/INSTALL b/doc/INSTALL +index e37c2b9..91222f9 100644 +--- a/doc/INSTALL ++++ b/doc/INSTALL +@@ -1,24 +1,30 @@ + This file contains some more detailed information about building and + installing the documentation. + +-Building with sphinx. +---------------------- ++Building with Sphinx ++-------------------- + +-- You need sphinx at least version 1.0. ++With Sphinx_ version 1.0 or greater, you can build man, info, html, ++and pdf versions of the docs (currently only the man pages) with:: + +-- You can build build and install man pages with 'make install-man' ++ make build-{man|info|html|pdf} + +-- You can build man, info, html, and pdf versions of the docs +- (currently only the man pages) with ++You can build build and install the docs (currently only the man ++pages) with:: + +- 'make install-{man|info|html|pdf}' ++ make install-{man|info|html|pdf} + +-Building the man pages +----------------------- ++Building the man Docutils ++------------------------- + +-- You can build the man pages with rst2man (from python-docutils) with +- 'make rst2man'. ++If you don't have Sphinx installed, you can still build the man-page ++version of the docs using rst2man (from Docutils_):: + +-- Currently there is no support to automagically install the resulting +- nroff files, but it should work to modify the target install-man +- in doc/Makefile.local. ++ make build-man ++ ++and install with:: ++ ++ make install-man ++ ++.. _Sphinx: http://sphinx-doc.org/ ++.. _Docutils: http://docutils.sourceforge.net/ +-- +1.9.1.353.gc66d89d +