[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: Joe Orton <joe_at_manyfish.co.uk>
Date: 2003-03-14 19:45:49 CET

On Fri, Mar 14, 2003 at 07:31:57AM -0800, Ben Collins-Sussman wrote:
> 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.

Since Fitz did the <refentry> stuff in chapter 8 of the book, it can be
transformed directly into man pages if you have the right tools. (It
almost works with published docbook-xsl releases but you need a few
tweaks). Sample svn_add.1 attached...

$ xmlto man book.xml
Writing svn_add.1 for refentry
Writing svn_cat.1 for refentry
Writing svn_checkout.1 for refentry
Writing svn_cleanup.1 for refentry
Writing svn_commit.1 for refentry
Writing svn_copy.1 for refentry
...

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Received on Fri Mar 14 19:46:49 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.