Re: [PATCH] notmuch.pod: pod version of documentation, converted by rman, massaged by hand.

Subject: Re: [PATCH] notmuch.pod: pod version of documentation, converted by rman, massaged by hand.

Date: Mon, 26 Apr 2010 16:33:27 -0700

To: David Bremner, notmuch@notmuchmail.org

Cc:

From: Carl Worth


-- 
carl.d.worth@intel.com
On Sat, 24 Apr 2010 11:04:49 -0300, David Bremner <david@tethera.net> wrote:
> 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.

Sorry about the lack of feedback from me on this.

I tried to look at it a couple of times, but it was already stale then
so I didn't look hard enough.

The couple of questions I have are:

  * How close does the generated output match what we have today?

  * What additional tools does this require for someone to build the
    tree from the git repository?

> Should I rebase/rebuild this against the current docs, or not bother?

I'd be interested in taking another look, if you're willing to take
another whack at it. I think that our command-line interface is changing
a lot more slowly such that this won't go immediately stale this time.

Though you could perhaps start by answering the above questions which
might be less work. :-)

-Carl
part-000.sig (application/pgp-signature)

Thread: