Re: Auto-generated man pages?

From: Mike Markley <mike_at_markley.org>
Date: Wed, 7 Oct 2009 13:32:44 -0700

On Tue, Oct 06, 2009 at 10:50:55AM -0700, Murray S. Kucherawy <msk_at_cloudmark.com> wrote:
> Daniel Black suggested that OpenDKIM might want to auto-generate man pages based on which FFRs are enabled. I've so far stuck to the idea that what's in man pages should be "permanent" (i.e. non-FFR features) just because they're easier to maintain that way, but I hadn't considered this possibility.

I think it makes sense in some cases. Not all features are "FFRs" in the
Sendmail sense--experimental code for future release that doesn't yet
belong in the main build (e.g. arlib vs. unbound vs. stock resolver).

It makes a lot of sense to have manpage entries for the features that
aren't necessarily experimental but just aren't required for all systems
or use cases.

As for the experimental features... I don't know that making the
distinction is always cut-and-dry, and having the documentation in place
while a feature is still experimental helps ensure it will be properly
documented once it becomes mainline.

So: yes, I think it's a good idea.

-- 
Mike Markley <mike_at_markley.org>
I object to intellect without discipline;  I object to power without
constructive purpose.
- Spock, "The Squire of Gothos", stardate 2124.5
Received on Wed Oct 07 2009 - 20:32:53 PST

This archive was generated by hypermail 2.3.0 : Mon Oct 29 2012 - 23:32:29 PST