[svnbook] r4043 committed - Finish issue #78 ("A fuller explanation of '--depth ARG' in section...
svnbook at googlecode.com
svnbook at googlecode.com
Mon Aug 29 13:13:26 CDT 2011
Revision: 4043
Author: cmpilato at gmail.com
Date: Mon Aug 29 11:13:05 2011
Log: Finish issue #78 ("A fuller explanation of '--depth ARG' in
section
'svn Options' would be useful").
* en/book/ch09-reference.xml
Provide quick descriptions of the depth values when describing the
--depth option. Add a pointer to the Sparse Directories section in
the description of --set-depth. Note the inconsistent depths at
which --non-recursive is applied to various subcommands.
http://code.google.com/p/svnbook/source/detail?r=4043
Modified:
/trunk/en/book/ch09-reference.xml
=======================================
--- /trunk/en/book/ch09-reference.xml Mon Aug 29 09:11:02 2011
+++ /trunk/en/book/ch09-reference.xml Mon Aug 29 11:13:05 2011
@@ -227,11 +227,16 @@
<term><option>--depth</option>
<replaceable>ARG</replaceable></term>
<listitem>
- <para>Instructs Subversion to limit the scope of an operation
to a particular tree
+ <para>Instructs Subversion to limit the scope of an
+ operation to a particular tree
depth. <replaceable>ARG</replaceable> is one of
- <literal>empty</literal>, <literal>files</literal>,
- <literal>immediates</literal>, or
- <literal>infinity</literal>.</para>
+ <literal>empty</literal> (only the target
+ itself), <literal>files</literal> (the target and any
+ immediate file children thereof),
+ <literal>immediates</literal> (the target and any
+ immediate children thereof), or
+ <literal>infinity</literal> (the target and all of its
+ descendants—full recursion).</para>
</listitem>
</varlistentry>
@@ -498,9 +503,17 @@
<listitem>
<para><emphasis>Deprecated</emphasis>. Stops a subcommand
from recursing into subdirectories. Most subcommands
- recurse by default, but some subcommands—usually
- those that have the potential to remove or undo your
- local modifications—do not.</para>
+ recurse by default, but some do not. Users should avoid
+ this option and use the more precise <option>--depth</option>
+ option instead. For most subcommands, specifying
+ <option>--non-recursive</option> produces behavior which
+ is the same as if you'd specified
+ <option>--depth=files</option>, but there are exceptions:
+ non-recursive <command>svn status</command> operates at the
+ <literal>immediates</literal> depth, and the non-recursive
+ forms of <command>svn revert</command>,
+ <command>svn add</command>, and <command>svn commit</command>
+ operate at an <literal>empty</literal> depth.</para>
</listitem>
</varlistentry>
@@ -637,7 +650,9 @@
<para>Sets the sticky depth on a directory in a working
copy to one of <literal>exclude</literal>,
<literal>empty</literal>,
<literal>files</literal>, <literal>immediates</literal>,
- or <literal>infinity</literal>.</para>
+ or <literal>infinity</literal>. For detailed coverage
+ of what these mean and how to use this option, see
+ <xref linkend="svn.advanced.sparsedirs" />.</para>
</listitem>
</varlistentry>
More information about the svnbook-dev
mailing list