From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: Re: [PATCH] notmuch.pod: pod version of documentation, converted by rman, massaged by hand.
Date: Sat, 24 Apr 2010 11:04:49 -0300 [thread overview]
Message-ID: <87wrvxc5fi.fsf@rocinante.cs.unb.ca> (raw)
In-Reply-To: <1262281169-24909-1-git-send-email-david@tethera.net>
On Thu, 31 Dec 2009 13:39:29 -0400, david@tethera.net wrote:
>
> The idea here is to be able to generate the online help and the man page from one source.
>
> To generate a man page:
>
> pod2man notmuch.pod > notmuch.1
>
> To generate help for a specific notmuch subcommand
>
> podselect -section 'Commands/subcommand.*' notmuch.pod | pod2text -c
>
As I'm faced with writing docs for output selection, I'd like to revisit
this idea. I didn't get any feedback, positive or negative about the
idea of keeping the docs in pod. I don't care much about the format,
but I think it would be nice to avoid maintaining two copies of the
documentation.
Should I rebase/rebuild this against the current docs, or not bother?
d
next prev parent reply other threads:[~2010-04-24 14:05 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-12-31 17:39 [PATCH] notmuch.pod: pod version of documentation, converted by rman, massaged by hand david
2010-04-24 14:04 ` David Bremner [this message]
2010-04-26 10:56 ` David Edmondson
2010-04-26 23:33 ` Carl Worth
2010-04-26 23:49 ` David Bremner
2010-06-13 15:01 ` david
2010-10-29 23:01 ` Carl Worth
2010-11-03 17:18 ` generate help from pod david
2010-11-03 17:18 ` [PATCH 1/4] notmuch.pod: pod version of documentation, converted by rman, massaged by hand david
2010-11-03 17:18 ` [PATCH 2/4] Perl script to generate online help david
2010-11-03 17:18 ` [PATCH 3/4] Add rules to build notmuch.1 and notmuch-help.h from the pod file david
2010-11-03 17:29 ` David Bremner
2010-11-03 17:18 ` [PATCH 4/4] notmuch.c: use help strings generated from notmuch.pod david
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87wrvxc5fi.fsf@rocinante.cs.unb.ca \
--to=david@tethera.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).