[svnbook] r3969 committed - Try to reduce the verbosity of the reference chapter, eliminating...
svnbook at googlecode.com
svnbook at googlecode.com
Tue Aug 9 11:12:24 CDT 2011
Revision: 3969
Author: cmpilato at gmail.com
Date: Tue Aug 9 09:11:18 2011
Log: Try to reduce the verbosity of the reference chapter, eliminating
information of questionable continued value and presenting other
information in a more concise fashion.
* src/en/book/ch09-reference.xml
Lose 'Changes' and 'Accesses repository' bits from reference
entries, and trade 'Alternate names' for additional <refname>s.
http://code.google.com/p/svnbook/source/detail?r=3969
Modified:
/trunk/src/en/book/ch09-reference.xml
=======================================
--- /trunk/src/en/book/ch09-reference.xml Mon Aug 8 10:41:03 2011
+++ /trunk/src/en/book/ch09-reference.xml Tue Aug 9 09:11:18 2011
@@ -792,21 +792,6 @@
</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>No</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -892,6 +877,9 @@
<refnamediv>
<refname>svn blame</refname>
+ <refname>praise</refname>
+ <refname>annotate</refname>
+ <refname>ann</refname>
<refpurpose>Show author and revision information inline
for the specified files or URLs.</refpurpose>
</refnamediv>
@@ -908,21 +896,6 @@
revision number for the last change to that line.</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>praise</command>, <command>annotate</command>,
<command>ann</command></para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Nothing</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Yes</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -1050,21 +1023,6 @@
list</command> later in this chapter.</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Nothing</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Yes</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -1122,6 +1080,7 @@
<refnamediv>
<refname>svn changelist</refname>
+ <refname>cl</refname>
<refpurpose>Associate (or deassociate) local paths with a
changelist.</refpurpose>
</refnamediv>
@@ -1140,21 +1099,6 @@
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>cl</command></para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>No</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -1222,6 +1166,7 @@
<refnamediv>
<refname>svn checkout</refname>
+ <refname>co</refname>
<refpurpose>Check out a working copy from a
repository.</refpurpose>
</refnamediv>
<refsect1>
@@ -1241,21 +1186,6 @@
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>co</command></para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Creates a working copy</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Yes</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -1495,21 +1425,6 @@
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>No</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -1550,6 +1465,7 @@
<refnamediv>
<refname>svn commit</refname>
+ <refname>ci</refname>
<refpurpose>Send changes from your working copy to the
repository.</refpurpose>
</refnamediv>
<refsect1>
@@ -1586,25 +1502,6 @@
</refsect1>
-
-
- <refsect1>
- <title>Alternate names</title>
- <para><command>ci</command> (short for <quote>check in</quote>;
not
- <command>co</command>, which is an alias for the
- <command>checkout</command> subcommand)</para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy; repository</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Yes</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -1699,6 +1596,7 @@
<refnamediv>
<refname>svn copy</refname>
+ <refname>cp</refname>
<refpurpose>Copy a file or directory in a working copy or
in the repository.</refpurpose>
</refnamediv>
@@ -1768,22 +1666,6 @@
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>cp</command></para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Repository if destination is a URL; working copy if
destination is a WC path</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Yes, if source or destination is in the repository, or if
needed
- to look up the source revision number.</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -1921,6 +1803,9 @@
<refnamediv>
<refname>svn delete</refname>
+ <refname>del</refname>
+ <refname>remove</refname>
+ <refname>rm</refname>
<refpurpose>Delete an item from a working copy
or the repository.</refpurpose>
</refnamediv>
@@ -1946,22 +1831,6 @@
committed atomically.</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>del</command>, <command>remove</command>,
<command>rm</command></para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy if operating on files; repository if
- operating on URLs</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Only if operating on URLs</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -2042,6 +1911,7 @@
<refnamediv>
<refname>svn diff</refname>
+ <refname>di</refname>
<refpurpose>This displays the differences between two revisions
or paths.</refpurpose>
</refnamediv>
<refsect1>
@@ -2183,23 +2053,8 @@
different ancestry, you will see the entire contents of
the file as having been removed and added again).</para>
- </refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>di</command></para>
</refsect1>
- <refsect1>
- <title>Changes</title>
- <para>Nothing</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>For obtaining differences against anything but
- <literal>BASE</literal> revision in your working copy</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -2415,21 +2270,6 @@
be copied.</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Local disk</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Only if exporting from a URL</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -2511,6 +2351,8 @@
<refnamediv>
<refname>svn help</refname>
+ <refname>h</refname>
+ <refname>?</refname>
<refpurpose>Help!</refpurpose>
</refnamediv>
<refsect1>
@@ -2522,26 +2364,9 @@
<para>This is your best friend when you're using
Subversion and this book isn't within reach!</para>
+
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>?</command>, <command>h</command></para>
- <para>The options <option>-?</option>, <option>-h</option>,
- and <option>--help</option> have the same effect as using the
- <command>help</command> subcommand.</para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Nothing</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>No</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
<para>None</para>
@@ -2579,21 +2404,6 @@
specified.</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Repository</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Yes</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -2719,21 +2529,6 @@
</itemizedlist>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Nothing</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Only if operating on URLs</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -2868,6 +2663,7 @@
<refnamediv>
<refname>svn list</refname>
+ <refname>ls</refname>
<refpurpose>List directory entries in the
repository.</refpurpose>
</refnamediv>
<refsect1>
@@ -2914,21 +2710,6 @@
(<option>-v</option>) option is not accepted.</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>ls</command></para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Nothing</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Yes</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -3038,21 +2819,6 @@
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy, repository</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Yes</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -3162,22 +2928,8 @@
this behavior, which can be useful for determining branch
points.</para>
- </refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
</refsect1>
- <refsect1>
- <title>Changes</title>
- <para>Nothing</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Yes</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -3527,22 +3279,8 @@
one branch into another and you've renamed a file on one
branch but not the other.</para>
- </refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
</refsect1>
- <refsect1>
- <title>Changes</title>
- <para>Working copy</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Only if working with URLs</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -3637,22 +3375,8 @@
or <literal>eligible</literal> revisions as specified by
the <option>--show-revs</option> option.</para>
- </refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
</refsect1>
- <refsect1>
- <title>Changes</title>
- <para>Nothing</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Yes</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -3742,21 +3466,6 @@
used.</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy; repository if operating on a URL</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Only if operating on a URL</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -3810,6 +3519,9 @@
<refnamediv>
<refname>svn move</refname>
+ <refname>mv</refname>
+ <refname>rename</refname>
+ <refname>ren</refname>
<refpurpose>Move a file or directory.</refpurpose>
</refnamediv>
<refsect1>
@@ -3860,21 +3572,6 @@
</variablelist>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>mv</command>, <command>rename</command>,
<command>ren</command></para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy; repository if operating on a URL</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Only if operating on a URL</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -3947,6 +3644,8 @@
<refnamediv>
<refname>svn propdel</refname>
+ <refname>pdel</refname>
+ <refname>pd</refname>
<refpurpose>Remove a property from an item.</refpurpose>
</refnamediv>
<refsect1>
@@ -3965,21 +3664,6 @@
repository to access).</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>pdel</command>, <command>pd</command></para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy; repository only if operating on a URL</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Only if operating on a URL</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -4030,6 +3714,8 @@
<refnamediv>
<refname>svn propedit</refname>
+ <refname>pedit</refname>
+ <refname>pe</refname>
<refpurpose>Edit the property of one or more items under
version control. See <xref
linkend="svn.ref.svn.c.propset"/> later in this
chapter.</refpurpose>
@@ -4050,21 +3736,6 @@
repository to access).</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>pedit</command>, <command>pe</command></para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy; repository only if operating on a URL</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Only if operating on a URL</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -4113,6 +3784,8 @@
<refnamediv>
<refname>svn propget</refname>
+ <refname>pget</refname>
+ <refname>pg</refname>
<refpurpose>Print the value of a property.</refpurpose>
</refnamediv>
<refsect1>
@@ -4132,21 +3805,6 @@
properties.</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>pget</command>, <command>pg</command></para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy; repository only if operating on a URL</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Only if operating on a URL</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -4235,6 +3893,8 @@
<refnamediv>
<refname>svn proplist</refname>
+ <refname>plist</refname>
+ <refname>pl</refname>
<refpurpose>List all properties.</refpurpose>
</refnamediv>
<refsect1>
@@ -4253,21 +3913,6 @@
repository to access).</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>plist</command>, <command>pl</command></para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy; repository only if operating on a URL</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Only if operating on a URL</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -4350,6 +3995,8 @@
<refnamediv>
<refname>svn propset</refname>
+ <refname>pset</refname>
+ <refname>ps</refname>
<refpurpose>Set <replaceable>PROPNAME</replaceable> to
<replaceable>PROPVAL</replaceable> on files, directories, or
revisions.</refpurpose>
</refnamediv>
<refsect1>
@@ -4377,22 +4024,8 @@
properties.</para>
</tip>
- </refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>pset</command>, <command>ps</command></para>
</refsect1>
- <refsect1>
- <title>Changes</title>
- <para>Working copy; repository only if operating on a URL</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Only if operating on a URL</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -4572,21 +4205,6 @@
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>No</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -4663,21 +4281,6 @@
linkend="svn.tour.cycle.resolve"/> for an in-depth look at
resolving conflicts.</para> </refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>No</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -4756,21 +4359,6 @@
<quote>unscheduled</quote>).</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>No</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -4857,6 +4445,8 @@
<refnamediv>
<refname>svn status</refname>
+ <refname>stat</refname>
+ <refname>st</refname>
<refpurpose>Print the status of working copy files and
directories.</refpurpose>
</refnamediv>
<refsect1>
@@ -5192,22 +4782,6 @@
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>stat</command>, <command>st</command></para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Nothing</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Only if using <option>--show-updates</option>
- (<option>-u</option>)</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -5340,6 +4914,7 @@
<refnamediv>
<refname>svn switch</refname>
+ <refname>sw</refname>
<refpurpose>Update working copy to a different URL.</refpurpose>
</refnamediv>
<refsect1>
@@ -5395,21 +4970,6 @@
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>sw</command></para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Yes</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -5563,21 +5123,6 @@
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para>None</para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy, repository</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Yes</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -5640,6 +5185,7 @@
<refnamediv>
<refname>svn update</refname>
+ <refname>up</refname>
<refpurpose>Update your working copy.</refpurpose>
</refnamediv>
<refsect1>
@@ -5730,21 +5276,6 @@
target.</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>up</command></para>
- </refsect1>
-
- <refsect1>
- <title>Changes</title>
- <para>Working copy</para>
- </refsect1>
-
- <refsect1>
- <title>Accesses repository</title>
- <para>Yes</para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -6300,7 +5831,10 @@
</indexterm>
<refnamediv>
- <refname>svnadmin help</refname> <refpurpose>Help!</refpurpose>
+ <refname>svnadmin help</refname>
+ <refname>h</refname>
+ <refname>?</refname>
+ <refpurpose>Help!</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -6315,11 +5849,6 @@
this book.</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>?</command>, <command>h</command></para>
- </refsect1>
-
</refentry>
<refentry id="svn.ref.svnadmin.c.hotcopy">
@@ -7718,7 +7247,10 @@
</indexterm>
<refnamediv>
- <refname>svnlook help</refname> <refpurpose>Help!</refpurpose>
+ <refname>svnlook help</refname>
+ <refname>h</refname>
+ <refname>?</refname>
+ <refpurpose>Help!</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -7739,11 +7271,6 @@
<para>None</para>
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>?</command>, <command>h</command></para>
- </refsect1>
-
</refentry>
<refentry id="svn.ref.svnlook.c.history">
@@ -7983,6 +7510,8 @@
<refnamediv>
<refname>svnlook propget</refname>
+ <refname>pget</refname>
+ <refname>pg</refname>
<refpurpose>Print the raw value of a property on a path in
the repository.</refpurpose>
</refnamediv>
@@ -7998,11 +7527,6 @@
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>pg</command>, <command>pget</command></para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -8042,6 +7566,8 @@
<refnamediv>
<refname>svnlook proplist</refname>
+ <refname>plist</refname>
+ <refname>pl</refname>
<refpurpose>Print the names and values of versioned file and
directory properties.</refpurpose>
</refnamediv>
@@ -8058,11 +7584,6 @@
</refsect1>
- <refsect1>
- <title>Alternate names</title>
- <para><command>pl</command>, <command>plist</command></para>
- </refsect1>
-
<refsect1>
<title>Options</title>
@@ -8441,11 +7962,6 @@
particular revision or range of revisions.</para>
</refsect1>
- <refsect1>
- <title>Alternate name</title>
- <para>None</para>
***The diff for this file has been truncated for email.***
More information about the svnbook-dev
mailing list