[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: man pages out of date [was internal/external diff docs and usage]

From: B. W. Fitzpatrick <fitz_at_red-bean.com>
Date: 2003-03-14 16:37:22 CET

Ben Collins-Sussman <sussman@collab.net> writes:
> Paul Lussier <pll@lanminds.com> writes:
>
> > So, should I look at updating the static man pages now, or would it
> > be better to wait until Rafael has time to add the necessary code to
> > the C sources to automagically generate man pages at build time?
>
> To be honest, I hate seeing all this duplication of documentation:
>
> * all our binaries are already self-documenting ('svn help foo')
>
> * the man pages potentially contain the same information
>
> * chapter 8 of the book has the same information, plus some
> discussion.
>
> If it were up to me, I'd make our man pages *really* short: they
> would simply tell people to run 'svn help', and contain links to the
> website and/or book.
>
> Voila, no more needing to keep the man pages in sync with the
> binaries. :-)

Ladies and Gentleman, I give you Ben Collins-Sussman, "SuperGenius"!

+1 on the short and pointy man page.

-Fitz

--
Brian W. Fitzpatrick    <fitz_at_red-bean.com>   http://www.red-bean.com/fitz/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Fri Mar 14 16:38:53 2003

This is an archived mail posted to the Subversion Dev mailing list.

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.