[svnbook commit] r2990 - trunk/src/en/book
cmpilato
noreply at red-bean.com
Thu Mar 6 20:03:06 CST 2008
Author: cmpilato
Date: Thu Mar 6 20:03:04 2008
New Revision: 2990
Log:
Consistently use the form <option>--foo</option> (<option>-f</option>)
instead of the not-quite correct <option>--foo (-f)</option>. Thank
you, O'Reilly copyeditors, for finding this through a basic awareness
of roman font space width normalities.
* src/en/book/ch05-repository-admin.xml
* src/en/book/ch06-server-configuration.xml
* src/en/book/ch04-branching-and-merging.xml
* src/en/book/ch02-basic-usage.xml
* src/en/book/ch07-customizing-svn.xml
Modified:
trunk/src/en/book/ch02-basic-usage.xml
trunk/src/en/book/ch04-branching-and-merging.xml
trunk/src/en/book/ch05-repository-admin.xml
trunk/src/en/book/ch06-server-configuration.xml
trunk/src/en/book/ch07-customizing-svn.xml
Modified: trunk/src/en/book/ch02-basic-usage.xml
==============================================================================
--- trunk/src/en/book/ch02-basic-usage.xml (original)
+++ trunk/src/en/book/ch02-basic-usage.xml Thu Mar 6 20:03:04 2008
@@ -550,8 +550,8 @@
underneath <filename>foo</filename> will be scheduled
for addition. If you only want to add
<filename>foo</filename> itself, pass the
- <option>--non-recursive (-N)</option> option.</para>
-
+ <option>--non-recursive</option> (<option>-N</option>)
+ option.</para>
</listitem>
</varlistentry>
@@ -806,9 +806,10 @@
</screen>
<para><command>svn status</command> also has a
- <option>--verbose (-v)</option> option, which will show you
- the status of <emphasis>every</emphasis> item in your
- working copy, even if it has not been changed:</para>
+ <option>--verbose</option> (<option>-v</option>) option,
+ which will show you the status of <emphasis>every</emphasis>
+ item in your working copy, even if it has not been
+ changed:</para>
<screen>
$ svn status -v
@@ -832,9 +833,9 @@
<para>None of the prior invocations to <command>svn
status</command> contact the repository—instead, they
- compare the metadata in the
- <filename>.svn</filename> directory with the working copy.
- Finally, there is the <option>--show-updates (-u)</option>
+ compare the metadata in the <filename>.svn</filename>
+ directory with the working copy. Finally, there is the
+ <option>--show-updates</option> (<option>-u</option>)
option, which contacts the repository and adds information
about things that are out-of-date:</para>
@@ -945,11 +946,11 @@
unified diff format, by default. If you want diff output in
a different format, specify an external diff program using
<option>--diff-cmd</option> and pass any flags you'd like to
- it using the <option>--extensions (-x)</option> option. For
- example, to see local differences in file
- <filename>foo.c</filename> in context output format while
- ignoring case differences, you might run <command>svn diff
- --diff-cmd /usr/bin/diff --extensions '-i'
+ it using the <option>--extensions</option>
+ (<option>-x</option>) option. For example, to see local
+ differences in file <filename>foo.c</filename> in context
+ output format while ignoring case differences, you might run
+ <command>svn diff --diff-cmd /usr/bin/diff --extensions '-i'
foo.c</command>.</para>
</sect3>
@@ -1610,7 +1611,7 @@
<para>However, if you've been composing your log message as you
work, you may want to tell Subversion to get the message from
a file by passing the filename with the
- <option>--file (-F)</option> option:</para>
+ <option>--file</option> (<option>-F</option>) option:</para>
<screen>
$ svn commit -F logmsg
@@ -1769,7 +1770,8 @@
<emphasis>reverse chronological order</emphasis> by default.
If you wish to see a different range of revisions in a
particular order, or just a single revision, pass the
- <option>--revision (-r)</option> option:</para>
+ <option>--revision</option> (<option>-r</option>)
+ option:</para>
<screen>
$ svn log -r 5:19 # shows logs 5 through 19 in chronological order
@@ -1821,11 +1823,12 @@
<para>If you want even more information about a file or
directory, <command>svn log</command> also takes a
- <option>--verbose (-v)</option> option. Because Subversion
- allows you to move and copy files and directories, it is
- important to be able to track path changes in the filesystem,
- so in verbose mode, <command>svn log</command> will include a
- list of changed paths in a revision in its output:</para>
+ <option>--verbose</option> (<option>-v</option>) option.
+ Because Subversion allows you to move and copy files and
+ directories, it is important to be able to track path changes
+ in the filesystem, so in verbose mode, <command>svn
+ log</command> will include a list of changed paths in a
+ revision in its output:</para>
<screen>
$ svn log -r 8 -v
@@ -1965,8 +1968,9 @@
<title>Comparing Repository to Repository</title>
<para>If two revision numbers, separated by a colon, are
- passed via <option>--revision (-r)</option>, then the two
- revisions are directly compared.</para>
+ passed via <option>--revision</option>
+ (<option>-r</option>), then the two revisions are directly
+ compared.</para>
<screen>
$ svn diff -r 2:3 rules.txt
@@ -1984,8 +1988,8 @@
</screen>
<para>A more convenient way of comparing a revision to the
- previous revision is to use the <option>--change (-c)</option>:
- </para>
+ previous revision is to use the <option>--change</option>
+ (<option>-c</option>) option:</para>
<screen>
$ svn diff -c 3 rules.txt
@@ -2072,8 +2076,8 @@
</screen>
<para>If you want a more detailed listing, pass the
- <option>--verbose (-v)</option> flag to get output like
- this:</para>
+ <option>--verbose</option> (<option>-v</option>) flag to get
+ output like this:</para>
<screen>
$ svn list -v http://svn.collab.net/repos/svn
Modified: trunk/src/en/book/ch04-branching-and-merging.xml
==============================================================================
--- trunk/src/en/book/ch04-branching-and-merging.xml (original)
+++ trunk/src/en/book/ch04-branching-and-merging.xml Thu Mar 6 20:03:04 2008
@@ -1274,14 +1274,14 @@
<para>First, you might need to use <command>svn log</command> to
discover the exact coordinate pair you wish to resurrect. A
- good strategy is to run <command>svn log
- --verbose</command> in a directory that used to contain your
- deleted item. The <option>--verbose (-v)</option> option
- shows a list of all changed items in each revision; all you
- need to do is find the revision in which you deleted the file
- or directory. You can do this visually, or by using another
- tool to examine the log output (via <command>grep</command>,
- or perhaps via an incremental search in an editor).</para>
+ good strategy is to run <command>svn log --verbose</command>
+ in a directory that used to contain your deleted item. The
+ <option>--verbose</option> (<option>-v</option>) option shows
+ a list of all changed items in each revision; all you need to
+ do is find the revision in which you deleted the file or
+ directory. You can do this visually, or by using another tool
+ to examine the log output (via <command>grep</command>, or
+ perhaps via an incremental search in an editor).</para>
<screen>
$ cd parent-dir
@@ -1600,10 +1600,10 @@
<para>We happen to know that this merge to the branch was
nothing but a merge of trunk changes. How can we see those
- trunk changes as well? The answer is to use
- the <option>--use-merge-history (-g)</option> option. This
- option expands those <quote>child</quote> changes that were
- part of the merge.</para>
+ trunk changes as well? The answer is to use the
+ <option>--use-merge-history</option> (<option>-g</option>)
+ option. This option expands those <quote>child</quote>
+ changes that were part of the merge.</para>
<screen>
$ svn log -v -r 390 -g
@@ -1636,12 +1636,12 @@
made by Sally to the trunk. This is a much more complete
picture of history!</para>
- <para>The <command>svn blame</command> command also takes
- the <option>--use-merge-history (-g)</option> option. If this
- option is neglected, then somebody looking at a line-by-line
- annotation of <filename>button.c</filename> may get the
- mistaken impression that you were responsible for the lines
- that fixed a certain error:</para>
+ <para>The <command>svn blame</command> command also takes the
+ <option>--use-merge-history</option> (<option>-g</option>)
+ option. If this option is neglected, then somebody looking at
+ a line-by-line annotation of <filename>button.c</filename> may
+ get the mistaken impression that you were responsible for the
+ lines that fixed a certain error:</para>
<screen>
$ svn blame button.c
Modified: trunk/src/en/book/ch05-repository-admin.xml
==============================================================================
--- trunk/src/en/book/ch05-repository-admin.xml (original)
+++ trunk/src/en/book/ch05-repository-admin.xml Thu Mar 6 20:03:04 2008
@@ -1099,15 +1099,17 @@
subcommands can operate on either a revision or a
transaction tree, printing information about the tree
itself, or how it differs from the previous revision of the
- repository. You use the <option>--revision (-r)</option> and
- <option>--transaction (-t)</option> options to specify which
- revision or transaction, respectively, to examine. In the
- absence of both the <option>--revision (-r)</option> and
- <option>--transaction (-t)</option> options,
- <command>svnlook</command> will examine the youngest (or
- <quote>HEAD</quote>) revision in the repository. So the
- following two commands do exactly the same thing when 19 is
- the youngest revision in the repository located at
+ repository. You use the <option>--revision</option>
+ (<option>-r</option>) and <option>--transaction</option>
+ (<option>-t</option>) options to specify which revision or
+ transaction, respectively, to examine. In the absence of
+ both the <option>--revision</option> (<option>-r</option>)
+ and <option>--transaction</option> (<option>-t</option>)
+ options, <command>svnlook</command> will examine the
+ youngest (or <quote>HEAD</quote>) revision in the
+ repository. So the following two commands do exactly the
+ same thing when 19 is the youngest revision in the
+ repository located at
<filename>/var/svn/repos</filename>:</para>
<screen>
@@ -1130,8 +1132,9 @@
are uncommitted ones. Most repositories will have no such
transactions, because transactions are usually either
committed (in which case, you should access them as
- revision with the <option>--revision (-r)</option> option) or
- aborted and removed.</para>
+ revision with the <option>--revision</option>
+ (<option>-r</option>) option) or aborted and
+ removed.</para>
</note>
<para>Output from <command>svnlook</command> is designed to be
@@ -1501,15 +1504,15 @@
<para>Each item in the resultant output can then be used with
<command>svnlook</command> (and its
- <option>--transaction (-t)</option> option) to determine who
- created the transaction, when it was created, what types of
- changes were made in the transaction—information that
- is helpful in determining whether or not the transaction is
- a safe candidate for removal! If you do indeed want to
- remove a transaction, its name
- can be passed to <command>svnadmin rmtxns</command>, which
- will perform the cleanup of the transaction. In fact, the
- <literal>rmtxns</literal> subcommand can take its input
+ <option>--transaction</option> (<option>-t</option>) option)
+ to determine who created the transaction, when it was
+ created, what types of changes were made in the
+ transaction—information that is helpful in determining
+ whether or not the transaction is a safe candidate for
+ removal! If you do indeed want to remove a transaction, its
+ name can be passed to <command>svnadmin rmtxns</command>,
+ which will perform the cleanup of the transaction. In fact,
+ the <literal>rmtxns</literal> subcommand can take its input
directly from the output of
<literal>lstxns</literal>!</para>
@@ -1955,10 +1958,10 @@
<para>We mentioned previously that <command>svnadmin
dump</command> outputs a range of revisions. Use the
- <option>--revision (-r)</option> option to specify a single
- revision to dump, or a range of revisions. If you omit this
- option, all the existing repository revisions will be
- dumped.</para>
+ <option>--revision</option> (<option>-r</option>) option to
+ specify a single revision to dump, or a range of revisions.
+ If you omit this option, all the existing repository revisions
+ will be dumped.</para>
<screen>
$ svnadmin dump myrepos -r 23 > rev-23.dumpfile
Modified: trunk/src/en/book/ch06-server-configuration.xml
==============================================================================
--- trunk/src/en/book/ch06-server-configuration.xml (original)
+++ trunk/src/en/book/ch06-server-configuration.xml Thu Mar 6 20:03:04 2008
@@ -2333,14 +2333,13 @@
<para>So to answer the question, one obvious way to see
older revisions of files and directories is by passing the
- <option>--revision (-r)</option> argument to
- the <command>svn list</command> and <command>svn
+ <option>--revision</option> (<option>-r</option>) argument
+ to the <command>svn list</command> and <command>svn
cat</command> commands. To browse old revisions with your
web browser, however, you can use third-party software. A
- good example of this is ViewVC
- (<ulink url="http://viewvc.tigris.org/"/>). ViewVC was
- originally written to display CVS repositories through the
- web,
+ good example of this is ViewVC (<ulink
+ url="http://viewvc.tigris.org/"/>). ViewVC was originally
+ written to display CVS repositories through the web,
<footnote>
<para>Back then, it was called <quote>ViewCVS</quote>.</para>
</footnote>
Modified: trunk/src/en/book/ch07-customizing-svn.xml
==============================================================================
--- trunk/src/en/book/ch07-customizing-svn.xml (original)
+++ trunk/src/en/book/ch07-customizing-svn.xml Thu Mar 6 20:03:04 2008
@@ -975,18 +975,20 @@
property values—tend to be textual in nature and are
provided explicitly by users. Most of this information can be
provided to the Subversion command-line client using the
- <option>--message (-m)</option> and <option>--file (-F)</option>
- options with the appropriate subcommands.</para>
+ <option>--message</option> (<option>-m</option>) and
+ <option>--file</option> (<option>-F</option>) options with the
+ appropriate subcommands.</para>
<para>Each of these options has its pros and cons. For example,
- when performing a commit, <option>--file (-F)</option> works
- well if you've already prepared a text file that holds your
- commit log message. If you didn't, though, you can use
- <option>--message (-m)</option> to provide a log message on the
- command line. Unfortunately, it can be tricky to compose
- anything more than a simple one-line message on the command line.
- Users want more flexibility—multi-line, free-form log
- message editing on demand.</para>
+ when performing a commit, <option>--file</option>
+ (<option>-F</option>) works well if you've already prepared a
+ text file that holds your commit log message. If you didn't,
+ though, you can use <option>--message</option>
+ (<option>-m</option>) to provide a log message on the command
+ line. Unfortunately, it can be tricky to compose anything more
+ than a simple one-line message on the command line. Users want
+ more flexibility—multi-line, free-form log message editing
+ on demand.</para>
<para>Subversion supports this by allowing you to specify an
external text editor which it will launch as necessary in order
@@ -1033,14 +1035,15 @@
<command>svn mkdir</command> or <command>delete</command> when
provided a URL target, and so on), and Subversion will try to
launch the editor automatically if you don't specify either of
- the <option>--message (-m)</option> or <option>--file
- (-F)</option> options. The <command>svn propedit</command>
- command is built almost entirely around the use of an external
- editor. And beginning in version 1.5, Subversion will also use
- the configured external text editor when the user asks it to
- launch an editor during interactive conflict resolution. Oddly,
- there doesn't appear to be a way to use external editors to
- interactively provide lock comments.</para>
+ the <option>--message</option> (<option>-m</option>) or
+ <option>--file</option> (<option>-F</option>) options. The
+ <command>svn propedit</command> command is built almost entirely
+ around the use of an external editor. And beginning in version
+ 1.5, Subversion will also use the configured external text
+ editor when the user asks it to launch an editor during
+ interactive conflict resolution. Oddly, there doesn't appear to
+ be a way to use external editors to interactively provide lock
+ comments.</para>
</sect1>
More information about the svnbook-dev
mailing list