unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: Carl Worth <cworth@cworth.org>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: Re: [PATCH] notmuch.pod: pod version of documentation, converted by rman, massaged by hand.
Date: Mon, 26 Apr 2010 16:33:27 -0700	[thread overview]
Message-ID: <871ve1wzzs.fsf@yoom.home.cworth.org> (raw)
In-Reply-To: <87wrvxc5fi.fsf@rocinante.cs.unb.ca>

[-- Attachment #1: Type: text/plain, Size: 1191 bytes --]


-- 
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

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

  parent reply	other threads:[~2010-04-26 23:33 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
2010-04-26 10:56   ` David Edmondson
2010-04-26 23:33   ` Carl Worth [this message]
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=871ve1wzzs.fsf@yoom.home.cworth.org \
    --to=cworth@cworth.org \
    --cc=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).