[svnbook] r3792 committed - * src/en/book/ch02-basic-usage.xml...
svnbook at googlecode.com
svnbook at googlecode.com
Tue Oct 12 10:55:39 CDT 2010
Revision: 3792
Author: cmpilato at gmail.com
Date: Tue Oct 12 08:54:28 2010
Log: * src/en/book/ch02-basic-usage.xml
Mention long-form option aliases, and add a couple more index entries.
http://code.google.com/p/svnbook/source/detail?r=3792
Modified:
/trunk/src/en/book/ch02-basic-usage.xml
=======================================
--- /trunk/src/en/book/ch02-basic-usage.xml Wed Feb 17 02:30:38 2010
+++ /trunk/src/en/book/ch02-basic-usage.xml Tue Oct 12 08:54:28 2010
@@ -26,7 +26,14 @@
<sect1 id="svn.tour.help">
<title>Help!</title>
- <para>Before reading on, here is the most important command you'll
+ <para>
+ <indexterm>
+ <primary>svn</primary>
+ <secondary>subcommands</secondary>
+ <tertiary>help</tertiary>
+ </indexterm>
+
+ Before reading on, here is the most important command you'll
ever need when using Subversion: <command>svn help</command>.
The Subversion command-line client is self-documenting—at
any time, a quick <userinput>svn help
@@ -57,22 +64,31 @@
<sidebar>
<title>Options and Switches and Flags, Oh My!</title>
- <para>The Subversion command-line client has numerous command
+ <para>
+ <indexterm>
+ <primary>svn</primary>
+ <secondary>options</secondary>
+ </indexterm>
+
+ The Subversion command-line client has numerous command
modifiers (which we call options), but there are two
- distinct kinds of options: short options
- are a single hyphen followed by a single letter, and
- long options consist of two hyphens
- followed by a number of letters (e.g., <literal>-s</literal>
+ distinct kinds of options: short options are a single hyphen
+ followed by a single letter, and long options consist of two
+ hyphens followed by several letters and hyphens
+ (e.g., <literal>-s</literal>
and <literal>--this-is-a-long-option</literal>,
- respectively). Every option has a long format, but only
- certain options have an additional short format (these are
- typically options that are frequently used). To
- maintain clarity, we <emphasis>usually</emphasis> use the
- long form in code examples, but when describing options, if
- there's a short form, we'll provide the long form (to
- improve clarity) and the short form (to make it easier to
- remember). You should use whichever one you're more
- comfortable with, but don't try to use both.</para>
+ respectively). Every option has at least one long format.
+ Some, such as the <option>--changelist</option> option,
+ feature an abbreviated long-format alias
+ (<option>--cl</option>, in this case). Only certain
+ options—generally the most-used ones—have an
+ additional short format. To maintain clarity in this book,
+ we usually use the long form in code examples, but when
+ describing options, if there's a short form, we'll provide
+ the long form (to improve clarity) and the short form (to
+ make it easier to remember). Use the form you're more
+ comfortable with when executing your own Subversion
+ commands.</para>
</sidebar>
@@ -94,7 +110,14 @@
<sect2 id="svn.tour.importing.import">
<title>svn import</title>
- <para>The <command>svn import</command> command is a quick way to
+ <para>
+ <indexterm>
+ <primary>svn</primary>
+ <secondary>subcommands</secondary>
+ <tertiary>import</tertiary>
+ </indexterm>
+
+ The <command>svn import</command> command is a quick way to
copy an unversioned tree of files into a repository, creating
intermediate directories as necessary. <command>svn
import</command> doesn't require a working copy, and your files
More information about the svnbook-dev
mailing list