Re: convert man pages to sphinx
authorTomi Ollila <tomi.ollila@iki.fi>
Wed, 5 Mar 2014 18:11:02 +0000 (20:11 +0200)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:00:22 +0000 (10:00 -0800)
a0/c41918e506740108c0364e48072e64497dce87 [new file with mode: 0644]

diff --git a/a0/c41918e506740108c0364e48072e64497dce87 b/a0/c41918e506740108c0364e48072e64497dce87
new file mode 100644 (file)
index 0000000..af483e8
--- /dev/null
@@ -0,0 +1,90 @@
+Return-Path: <tomi.ollila@iki.fi>\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 0E89C431FBD\r
+       for <notmuch@notmuchmail.org>; Wed,  5 Mar 2014 10:11:18 -0800 (PST)\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 tbx0gb+JqZio for <notmuch@notmuchmail.org>;\r
+       Wed,  5 Mar 2014 10:11:10 -0800 (PST)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id 9451C431FAE\r
+       for <notmuch@notmuchmail.org>; Wed,  5 Mar 2014 10:11:10 -0800 (PST)\r
+Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
+       by guru.guru-group.fi (Postfix) with ESMTP id 6F37010008F;\r
+       Wed,  5 Mar 2014 20:11:02 +0200 (EET)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org\r
+Subject: Re: convert man pages to sphinx\r
+In-Reply-To: <1394031395-8014-1-git-send-email-david@tethera.net>\r
+References: <1394031395-8014-1-git-send-email-david@tethera.net>\r
+User-Agent: Notmuch/0.17+112~g4e0c1d5 (http://notmuchmail.org) Emacs/24.3.1\r
+       (x86_64-unknown-linux-gnu)\r
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
+       $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
+       !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
+Date: Wed, 05 Mar 2014 20:11:02 +0200\r
+Message-ID: <m2d2i0jz2h.fsf@guru.guru-group.fi>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\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: Wed, 05 Mar 2014 18:11:18 -0000\r
+\r
+On Wed, Mar 05 2014, David Bremner <david@tethera.net> wrote:\r
+\r
+> This is the first version actually integrated into the build system.\r
+>\r
+> If people think the results are OK, I think we should move merge\r
+> because it has become more difficult than I thought to update the rst\r
+> files from man page changes.\r
+>\r
+> Of course we can/should still fix any glaring problems.\r
+\r
+Looks good -- some things that caught my attention..\r
+\r
+in doc/Makefile.local\r
+\r
+ -include $(dir)/docdeps.mk  -- so that we don't get complaint about missing\r
+  file \r
+\r
+  rm -f $@; gzip --stdout > $@ < $^  -- as -k option is pretty new in gzip\r
+  world (bzip2 & xz  seems to have had it longer (always?))\r
+  The 'rm -f $@' part is modeled after bzip2 manual page where it says\r
+  hard links are broken...\r
+\r
+doc/.gitignore  -- is missing, docdeps.mk & _build there\r
+\r
+both "make rst2man" and "make sphinx-man SPHINXBUILD=sphinx-1.0-build" seems\r
+to do good job. I happened to notice that one reference to other manual\r
+page was still underlined instead of bolded, manually checking \r
+the output of grep -n '([0-9])' **/*.rst indicates that the one in\r
+man1/notmuch.rst:88: is (probably) the only one.\r
+\r
+\r
+Tomi\r
+\r
+\r
+>\r
+> One thing that is not here at all is any kind of automation of the\r
+> fallback for people without (recent) sphinx.\r
+>\r
+> I also left the nroff man sources in the tree, but if I merge this series \r
+> (or something similar) I plan to delete them.\r