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

Re: svn commit: rev 2679 - trunk/doc trunk/doc/handbook

From: Ben Collins-Sussman <sussman_at_collab.net>
Date: 2002-07-24 20:44:15 CEST

blair@tigris.org writes:

> 1) Use `` and '' for quoting any text. Do not use a single ' or a
> single ".
> 2) When quoting single characters, such as discussing the output from
> an svn merge or svn update, use @samp{}.
> 3) Use @samp{} for any commands to run on the command line. Do not use
> @command{}, this is for the program itself. So use @samp{ls -l},
> but refer to ls as @command{ls}. For svn, svnadmin, svnlook
> subcommands, use @samp{}, so to refer to svnlook's youngest
> subcommand, use @samp{youngest}.
> 4) Use @option{} for command line options to programs that are not
> listed with the program. So @samp{ls -l}, but refer to -l as
> @option{-l}.
> 5) Use @uref{} for URLs that anybody on the Internet can access.
> These are converted to real links in HTML pages, while @url{}'s are
> not. Use @url{} for sample http:// or file:// URLs. For any
> @uref{} URLs that refer to a site's home page or a directory, place
> a / at the end of the URL. This saves a redirect and loads the
> page faster.
> 6) Svn keywords, i.e. svn:ignore, should be in @samp{}.

Blair, you rock. Thanks for documenting these rules and putting them
in doc/README.

To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Wed Jul 24 20:45:55 2002

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.