Re: [PATCH] notmuch.pod: pod version of documentation, converted by rman, massaged...
[notmuch-archives.git] / 3c / 9a79cb2aeb462114a1fd1b22de235d4657ca6a
1 Return-Path: <bremner@pivot.cs.unb.ca>\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 63AF94196F2\r
6         for <notmuch@notmuchmail.org>; Sat, 24 Apr 2010 07:05:25 -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.001\r
10 X-Spam-Level: \r
11 X-Spam-Status: No, score=-0.001 tagged_above=-999 required=5\r
12         tests=[BAYES_20=-0.001] autolearn=ham\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 nvtiDmB0iBIl for <notmuch@notmuchmail.org>;\r
16         Sat, 24 Apr 2010 07:05:23 -0700 (PDT)\r
17 Received: from pivot.cs.unb.ca (pivot.cs.unb.ca [131.202.240.57])\r
18         by olra.theworths.org (Postfix) with ESMTP id 7E6F6431FC1\r
19         for <notmuch@notmuchmail.org>; Sat, 24 Apr 2010 07:05:23 -0700 (PDT)\r
20 Received: from\r
21         fctnnbsc30w-142167190087.pppoe-dynamic.high-speed.nb.bellaliant.net\r
22         ([142.167.190.87] helo=rocinante.cs.unb.ca)\r
23         by pivot.cs.unb.ca with esmtpsa (TLS1.0:RSA_AES_256_CBC_SHA1:32)\r
24         (Exim 4.69) (envelope-from <bremner@pivot.cs.unb.ca>)\r
25         id 1O5fz0-00039l-3C; Sat, 24 Apr 2010 11:05:22 -0300\r
26 Received: from bremner by rocinante.cs.unb.ca with local (Exim 4.71)\r
27         (envelope-from <bremner@rocinante.cs.unb.ca>)\r
28         id 1O5fyT-0006v2-Hw; Sat, 24 Apr 2010 11:04:49 -0300\r
29 From: David Bremner <david@tethera.net>\r
30 To: notmuch@notmuchmail.org\r
31 Subject: Re: [PATCH] notmuch.pod: pod version of documentation,\r
32         converted by rman, massaged by hand.\r
33 In-Reply-To: <1262281169-24909-1-git-send-email-david@tethera.net>\r
34 References: <1262281169-24909-1-git-send-email-david@tethera.net>\r
35 Date: Sat, 24 Apr 2010 11:04:49 -0300\r
36 Message-ID: <87wrvxc5fi.fsf@rocinante.cs.unb.ca>\r
37 MIME-Version: 1.0\r
38 Content-Type: text/plain; charset=us-ascii\r
39 X-Sender-Verified: bremner@pivot.cs.unb.ca\r
40 X-BeenThere: notmuch@notmuchmail.org\r
41 X-Mailman-Version: 2.1.13\r
42 Precedence: list\r
43 List-Id: "Use and development of the notmuch mail system."\r
44         <notmuch.notmuchmail.org>\r
45 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
46         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
47 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
48 List-Post: <mailto:notmuch@notmuchmail.org>\r
49 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
50 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
51         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
52 X-List-Received-Date: Sat, 24 Apr 2010 14:05:25 -0000\r
53 \r
54 On Thu, 31 Dec 2009 13:39:29 -0400, david@tethera.net wrote:\r
55\r
56 > The idea here is to be able to generate the online help and the man page from one source.\r
57\r
58 > To generate a man page:\r
59 >    \r
60 >    pod2man notmuch.pod > notmuch.1\r
61\r
62 > To generate help for a specific notmuch subcommand\r
63\r
64 >    podselect -section 'Commands/subcommand.*' notmuch.pod | pod2text -c\r
65\r
66 \r
67 As I'm faced with writing docs for output selection, I'd like to revisit\r
68 this idea. I didn't get any feedback, positive or negative about the\r
69 idea of keeping the docs in pod.  I don't care much about the format,\r
70 but I think it would be nice to avoid maintaining two copies of the\r
71 documentation.\r
72 \r
73 Should I rebase/rebuild this against the current docs, or not bother?\r
74 \r
75 d\r