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

Re: man pages

From: William Yardley <svn_at_veggiechinese.net>
Date: 2006-11-15 01:24:43 CET

On Tue, Nov 14, 2006 at 05:49:53PM -0600, Ryan Schmidt wrote:
> On Nov 14, 2006, at 16:39, William Yardley wrote:
 
> > It would be useful if the skeleton man page at least included a
> > synopsis of relevant environment variables and files, and perhaps a
> > quick summary of each of the available subcommands.
 
> A summary of the commands is available with "svn help",

Yes, but the command line switches, files / environment variables, etc.
aren't easily accessible (AFAICT) via the online help mechanism.

> and much more extensive information is available at svnbook.org. I'm
> not sure duplicating any of this information in a manpage is a good
> idea. It's just one more thing that will get out of date.

IMO, going to a website is annoying (at best) in many circumstances, and
extremely impractical in others. And there are a number of mechanisms
for keeping documentation up to date across different formats so that
the same information doesn't have to be updated multiple places.

One other thing is that the documentation online will (presumably)
reflect one particular version of SVN, rather than the current /
installed one. It is also possible to have a man page reference the
appropriate path / value as built (for instance, if a non standard
directory is used instead of .subversion for a particular build).

To my mind, a man page serves very different needs from a book
(web-based or not)...

w

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@subversion.tigris.org
For additional commands, e-mail: users-help@subversion.tigris.org
Received on Wed Nov 15 01:25:19 2006

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