[svnbook commit] r2129 - trunk/src/en/book
julianfoad
svnbook-dev at red-bean.com
Wed Apr 26 10:00:50 CDT 2006
Author: julianfoad
Date: Wed Apr 26 10:00:50 2006
New Revision: 2129
Modified:
trunk/src/en/book/appa.xml
Log:
Clarify part of the "Subversion for CVS Users" appendix.
* book/appa.xml
(svn.forcvs.status-vs-update): Untangle the description of "svn update"
from the description of "svn status", giving them separate sub-sections.
Make the list of status codes more self-consistent.
Modified: trunk/src/en/book/appa.xml
==============================================================================
--- trunk/src/en/book/appa.xml (original)
+++ trunk/src/en/book/appa.xml Wed Apr 26 10:00:50 2006
@@ -213,52 +213,55 @@
only prints information about files that are updated,
<emphasis>not</emphasis> local modifications.</para>
- <para><command>svn status</command> prints all files that have
- local modifications. By default, the repository is not
- contacted. While this subcommand accepts a fair number of
- options, the following are the most commonly used ones:</para>
-
- <variablelist>
- <varlistentry>
- <term><option>-u</option></term>
- <listitem>
- <para>Contact the repository to determine, and then display,
- out-of-dateness information.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-v</option></term>
- <listitem>
- <para>Show <emphasis>all</emphasis> entries under
- version control.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-N</option></term>
- <listitem>
- <para>Run non-recursively (do not descend into
- subdirectories).</para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>The <command>status</command> command has two output
- formats. In the default <quote>short</quote> format, local
- modifications look like this:</para>
+ <sect2 id="svn.forcvs.status-vs-update.status">
+ <title>Status</title>
- <screen>
+ <para><command>svn status</command> prints all files that have
+ local modifications. By default, the repository is not
+ contacted. While this subcommand accepts a fair number of
+ options, the following are the most commonly used ones:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-u</option></term>
+ <listitem>
+ <para>Contact the repository to determine, and then display,
+ out-of-dateness information.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-v</option></term>
+ <listitem>
+ <para>Show <emphasis>all</emphasis> entries under
+ version control.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-N</option></term>
+ <listitem>
+ <para>Run non-recursively (do not descend into
+ subdirectories).</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>The <command>status</command> command has two output
+ formats. In the default <quote>short</quote> format, local
+ modifications look like this:</para>
+
+ <screen>
$ svn status
M foo.c
M bar/baz.c
</screen>
- <para>If you specify the <option>--show-updates</option>
- (<option>-u</option>) switch, a longer output format is
- used:</para>
+ <para>If you specify the <option>--show-updates</option>
+ (<option>-u</option>) switch, a longer output format is
+ used:</para>
- <screen>
+ <screen>
$ svn status -u
M 1047 foo.c
* 1045 faces.html
@@ -267,52 +270,61 @@
Status against revision: 1066
</screen>
- <para>In this case, two new columns appear. The second column
- contains an asterisk if the file or directory is out-of-date.
- The third column shows the working-copy's revision number of the
- item. In the example above, the asterisk indicates that
- <filename>faces.html</filename> would be patched if we updated,
- and that <filename>bloo.png</filename> is a newly added file in
- the repository. (The absence of any revision number next to
- <filename>bloo.png</filename> means that it doesn't yet exist in
- the working copy.)</para>
-
- <!-- ###TODO describe -v here as well as -uv. -u and -v use
- different <quote>long</quote> formats and need to be
- documented separately. Moreover, as you can combine -u and
- -v, it needs to be explained what each of them does. As -u is
- much more important than -v, and the example following that
- paragraph *is* about -u, not -v, my patch concentrated on
- that. -->
+ <para>In this case, two new columns appear. The second column
+ contains an asterisk if the file or directory is out-of-date.
+ The third column shows the working-copy's revision number of the
+ item. In the example above, the asterisk indicates that
+ <filename>faces.html</filename> would be patched if we updated,
+ and that <filename>bloo.png</filename> is a newly added file in
+ the repository. (The absence of any revision number next to
+ <filename>bloo.png</filename> means that it doesn't yet exist in
+ the working copy.)</para>
+
+ <!-- ###TODO describe -v here as well as -uv. -u and -v use
+ different <quote>long</quote> formats and need to be
+ documented separately. Moreover, as you can combine -u and
+ -v, it needs to be explained what each of them does. As -u is
+ much more important than -v, and the example following that
+ paragraph *is* about -u, not -v, my patch concentrated on
+ that. -->
- <para>Lastly, here's a quick summary of the most common status codes that
- you may see:</para>
+ <para>Lastly, here's a quick summary of the most common status codes that
+ you may see:</para>
- <screen>
+ <screen>
A Resource is scheduled for Addition
D Resource is scheduled for Deletion
-M Resource has local modifications
-C Resource has conflicts (changes have not been completely merged
+M Resource has local Modifications
+C Resource has Conflicts (changes have not been completely merged
between the repository and working copy version)
-X Resource is external to this working copy (comes from another
- repository. See <xref linkend="svn.advanced.props.special.externals" />)
+X Resource is eXternal to this working copy (may come from another
+ repository). See <xref linkend="svn.advanced.props.special.externals" />
? Resource is not under version control
! Resource is missing or incomplete (removed by another tool than
Subversion)
</screen>
- <!-- ###TODO: This paragraph should be moved elsewhere. We are
- talking about status codes here, and not update.
- Although CVS uses update as a form of status... -->
- <para>Subversion has combined the CVS <literal>P</literal> and
- <literal>U</literal> codes into just <literal>U</literal>. When
- a merge or conflict occurs, Subversion simply prints
- <literal>G</literal> or <literal>C</literal>, rather than a
- whole sentence about it.</para>
+ <para>For a more detailed discussion of <command>svn
+ status</command>, see <xref linkend="svn.tour.cycle.examine.status" />.</para>
+
+ </sect2>
+
+ <sect2 id="svn.forcvs.status-vs-update.update">
+ <title>Update</title>
+
+ <para><command>svn update</command> updates your working copy,
+ and only prints information about files that it updates.</para>
+
+ <para>Subversion has combined the CVS <literal>P</literal> and
+ <literal>U</literal> codes into just <literal>U</literal>. When
+ a merge or conflict occurs, Subversion simply prints
+ <literal>G</literal> or <literal>C</literal>, rather than a
+ whole sentence about it.</para>
- <para>For a more detailed discussion of <command>svn
- status</command>, see <xref linkend="svn.tour.cycle.examine.status" />.</para>
+ <para>For a more detailed discussion of <command>svn
+ update</command>, see <xref linkend="svn.tour.cycle.update" />.</para>
+ </sect2>
</sect1>
More information about the svnbook-dev
mailing list