You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@subversion.apache.org by Andrew Bell <an...@gmail.com> on 2005/03/01 14:03:30 UTC

Documentation Request

Hi,

The subversion documentation is generally very good.  I do have a
complaint.  The options to the various commands are not documented. 
There may be an example which hints at the operation of an option, but
there is no reference documentation as far as I can see.  This is
somewhat frustrating to me.  Any chance of some elaboration on options
in the documentation?

-- Andrew Bell

P.S. - I'd be happy to help rectify the situation.

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

Re: Documentation Request

Posted by Ben Collins-Sussman <su...@collab.net>.
On Mar 1, 2005, at 8:17 AM, Andrew Bell wrote:

> On Tue, 01 Mar 2005 07:08:51 -0700, Gary Thomas <ga...@mlbassoc.com> 
> wrote:
>> On Tue, 2005-03-01 at 08:03 -0600, Andrew Bell wrote:
>>> Hi,
>>>
>>> The subversion documentation is generally very good.  I do have a
>>> complaint.  The options to the various commands are not documented.
>>> There may be an example which hints at the operation of an option, 
>>> but
>>> there is no reference documentation as far as I can see.  This is
>>> somewhat frustrating to me.  Any chance of some elaboration on 
>>> options
>>> in the documentation?
>>
>> What's wrong with http://svnbook.red-bean.com/en/1.1/ch09.html ?
>>
>> That chapter seems to give nitty-gritty on every command, what 
>> switches
>> and arguments are used, etc.
>
> Sorry.  I missed  the options being all in one place at the beginning
> of the commands.  It's not so obvious in the printed documentation as
> it is in the HTML.  Though it may be redundant, it wouldn't hurt to
> have the options described where they are listed in each command.
>

There's also 'svn help <command>', which shows every possible option 
the command takes, with short explanations.


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

Re: Documentation Request

Posted by Andrew Bell <an...@gmail.com>.
On Tue, 01 Mar 2005 07:08:51 -0700, Gary Thomas <ga...@mlbassoc.com> wrote:
> On Tue, 2005-03-01 at 08:03 -0600, Andrew Bell wrote:
> > Hi,
> >
> > The subversion documentation is generally very good.  I do have a
> > complaint.  The options to the various commands are not documented.
> > There may be an example which hints at the operation of an option, but
> > there is no reference documentation as far as I can see.  This is
> > somewhat frustrating to me.  Any chance of some elaboration on options
> > in the documentation?
> 
> What's wrong with http://svnbook.red-bean.com/en/1.1/ch09.html ?
> 
> That chapter seems to give nitty-gritty on every command, what switches
> and arguments are used, etc.

Sorry.  I missed  the options being all in one place at the beginning
of the commands.  It's not so obvious in the printed documentation as
it is in the HTML.  Though it may be redundant, it wouldn't hurt to
have the options described where they are listed in each command.

Thanks,

-- Andrew Bell
andrew.bell.ia@gmail.com

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

Re: Documentation Request

Posted by Gary Thomas <ga...@mlbassoc.com>.
On Tue, 2005-03-01 at 08:03 -0600, Andrew Bell wrote:
> Hi,
> 
> The subversion documentation is generally very good.  I do have a
> complaint.  The options to the various commands are not documented. 
> There may be an example which hints at the operation of an option, but
> there is no reference documentation as far as I can see.  This is
> somewhat frustrating to me.  Any chance of some elaboration on options
> in the documentation?

What's wrong with http://svnbook.red-bean.com/en/1.1/ch09.html ?

That chapter seems to give nitty-gritty on every command, what switches
and arguments are used, etc.

-- 
------------------------------------------------------------
Gary Thomas                 |  Consulting for the
MLB Associates              |    Embedded world
------------------------------------------------------------


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