[svnbook commit] r3206 - trunk/src/en/book
cmpilato
noreply at red-bean.com
Thu Jul 24 23:45:39 CDT 2008
Author: cmpilato
Date: Thu Jul 24 23:45:39 2008
New Revision: 3206
Log:
Port O'Reilly production SVN changeset r101464 to our tree, whose log
message read thusly:
In VCWS 2e, begin the work of distinguishing between programs,
commands, and subcommands refered to informationally (using <command>)
and same invocations of those at a command-line (using <userinput>).
To establish a clear policy, this meant rewording some sections to
avoid referring ambiguously to a subcommand plus a particular
command-line option. Sometimes the resolution was to create a
command-line invocable string; sometimes it was to refer to the option
in the prose around the named subcommand.
While here, fixup some other obvious problems such as missing or
misplaced <replaceable> tags.
I didn't hit chapters 1, 4, and 8 yet, because those failed to match
my grep regexp (due to missing moreinfo="none" attributes).
* book/appa-quickstart.xml,
* book/appb-svn-for-cvs-users.xml,
* book/appc-webdav.xml,
* book/ch00-preface.xml,
* book/ch02-basic-usage.xml,
* book/ch03-advanced-topics.xml,
* book/ch05-repository-admin.xml,
* book/ch06-server-configuration.xml,
* book/ch07-customizing-svn.xml,
* book/ch09-reference.xml
Modified:
trunk/src/en/book/appa-quickstart.xml
trunk/src/en/book/appb-svn-for-cvs-users.xml
trunk/src/en/book/appc-webdav.xml
trunk/src/en/book/ch00-preface.xml
trunk/src/en/book/ch02-basic-usage.xml
trunk/src/en/book/ch03-advanced-topics.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
trunk/src/en/book/ch09-reference.xml
Modified: trunk/src/en/book/appa-quickstart.xml
==============================================================================
--- trunk/src/en/book/appa-quickstart.xml (original)
+++ trunk/src/en/book/appa-quickstart.xml Thu Jul 24 23:45:39 2008
@@ -132,7 +132,7 @@
ready to go on a Unix-like operating system. (This tutorial
also works at the Windows commandline prompt, assuming you
make some obvious tweaks.) We also assume you are using
- Subversion 1.2 or later (run <command>svn --version</command>
+ Subversion 1.2 or later (run <userinput>svn --version</userinput>
to check.)</para>
</note>
@@ -248,15 +248,15 @@
contents.</para>
</listitem>
<listitem>
- <para>Run <command>svn diff</command> to see unified diff
+ <para>Run <userinput>svn diff</userinput> to see unified diff
output of your changes.</para>
</listitem>
<listitem>
- <para>Run <command>svn commit</command> to commit the new
+ <para>Run <userinput>svn commit</userinput> to commit the new
version of your file to the repository.</para>
</listitem>
<listitem>
- <para>Run <command>svn update</command> to bring your working
+ <para>Run <userinput>svn update</userinput> to bring your working
copy <quote>up to date</quote> with the repository.</para>
</listitem>
</itemizedlist>
Modified: trunk/src/en/book/appb-svn-for-cvs-users.xml
==============================================================================
--- trunk/src/en/book/appb-svn-for-cvs-users.xml (original)
+++ trunk/src/en/book/appb-svn-for-cvs-users.xml Thu Jul 24 23:45:39 2008
@@ -84,8 +84,8 @@
<emphasis>not</emphasis> cause any kind of immediate change
in the repository. Instead, the working items are simply
<quote>scheduled</quote> for addition or deletion. No
- repository changes happen until you run <command>svn
- commit</command>.</para>
+ repository changes happen until you run <userinput>svn
+ commit</userinput>.</para>
</listitem>
<listitem>
<para>Directories aren't dumb containers anymore; they have
@@ -114,7 +114,7 @@
<para>Subversion deals with this problem by quietly tracking
committed adds and deletes in the <filename>.svn</filename>
- area. When you eventually run <command>svn update</command>,
+ area. When you eventually run <userinput>svn update</userinput>,
all accounts are settled with the repository, and the
directory's new revision number is set correctly.
<emphasis>Therefore, only after an update is it truly safe to
@@ -188,8 +188,8 @@
<para>The last subcommand in the list—<command>svn
revert</command>—is new. It will not only remove local
changes, but it will also unschedule operations such as adds and
- deletes. While deleting the file and then running <command>svn
- update</command> will still work, doing so distorts the true
+ deletes. While deleting the file and then running <userinput>svn
+ update</userinput> will still work, doing so distorts the true
purpose of updating. And, while we're on this subject…
</para>
@@ -211,8 +211,8 @@
copy, and second, to show the user which files are out of date.
Unfortunately, because of CVS's hard-to-read status output, many
CVS users don't take advantage of this command at all. Instead,
- they've developed a habit of running <command>cvs
- update</command> or <command>cvs -n update</command> to quickly
+ they've developed a habit of running <userinput>cvs
+ update</userinput> or <userinput>cvs -n update</userinput> to quickly
see their changes. If users forget to use
the <option>-n</option> option, this has the side effect of
merging repository changes they may not be ready to deal
@@ -258,7 +258,7 @@
</varlistentry>
</variablelist>
- <para>The <command>status</command> command has two output
+ <para>The <command>svn status</command> command has two output
formats. In the default <quote>short</quote> format, local
modifications look like this:</para>
Modified: trunk/src/en/book/appc-webdav.xml
==============================================================================
--- trunk/src/en/book/appc-webdav.xml (original)
+++ trunk/src/en/book/appc-webdav.xml Thu Jul 24 23:45:39 2008
@@ -180,7 +180,7 @@
think the influx of emails will still prove to be valuable
notifications or not. Also, a smart post-commit hook program
can distinguish between a transaction created via autoversioning
- and one created through a normal <command>svn commit</command>.
+ and one created through a normal Subversion commit operation.
The trick is to look for a revision property
named <literal>svn:autoversioned</literal>. If present, the
commit was made by a generic WebDAV client.</para>
@@ -574,8 +574,8 @@
like an ordinary web browser. You'll likely see the generic
HTML directory listing produced
by <command>mod_dav_svn</command>. By entering
- <literal>webdav://host/repos</literal> instead of
- <literal>http://host/repos</literal>, Konqueror becomes a
+ <userinput>webdav://host/repos</userinput> instead of
+ <userinput>http://host/repos</userinput>, Konqueror becomes a
WebDAV client and displays the repository as a
filesystem.</para>
Modified: trunk/src/en/book/ch00-preface.xml
==============================================================================
--- trunk/src/en/book/ch00-preface.xml (original)
+++ trunk/src/en/book/ch00-preface.xml Thu Jul 24 23:45:39 2008
@@ -209,29 +209,36 @@
book:</para>
<variablelist>
-
+
<varlistentry>
- <term><command>Constant width</command></term>
+ <term>
+ <userinput>Constant width</userinput>
+ </term>
<listitem>
- <para>Used for commands, command output, and options</para>
+ <para>Used for literal user input, command output, and
+ command-line options</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><replaceable>Constant width italic</replaceable></term>
+ <term>
+ <filename>Italic</filename>
+ </term>
<listitem>
- <para>Used for replaceable items in code and text</para>
+ <para>Used for program and Subversion tool subcommand
+ names, file and directory names, and new terms</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>Italic</filename></term>
+ <term>
+ <replaceable>Constant width italic</replaceable>
+ </term>
<listitem>
- <para>Used for file and directory names as well as for new
- terms</para>
+ <para>Used for replaceable items in code and text</para>
</listitem>
</varlistentry>
-
+
</variablelist>
</sect2>
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 Jul 24 23:45:39 2008
@@ -29,8 +29,8 @@
<para>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 <command>svn help
- <replaceable>SUBCOMMAND</replaceable></command> will describe
+ any time, a quick <userinput>svn help
+ <replaceable>SUBCOMMAND</replaceable></userinput> will describe
the syntax, options, and behavior of the subcommand.</para>
<screen>
@@ -289,8 +289,8 @@
<para>If you accidentally remove the <filename>.svn</filename>
subdirectory, the easiest way to fix the problem is to remove
the entire containing directory (a normal system deletion,
- not <command>svn delete</command>), then run <command>svn
- update</command> from a parent directory. The Subversion
+ not <command>svn delete</command>), then run <userinput>svn
+ update</userinput> from a parent directory. The Subversion
client will re-download the directory you've deleted, with a
new <filename>.svn</filename> area as well.</para>
</sidebar>
@@ -479,7 +479,7 @@
<command>svn update</command>, a letter code is displayed next
to each item to let you know what actions Subversion performed
to bring your working copy up-to-date. To find out what these
- letters mean, run <command>svn help update</command>.</para>
+ letters mean, run <userinput>svn help update</userinput>.</para>
</sect2>
@@ -545,7 +545,7 @@
<variablelist>
<varlistentry>
- <term><command>svn add foo</command></term>
+ <term><userinput>svn add foo</userinput></term>
<listitem>
<para>Schedule file, directory, or symbolic link
<filename>foo</filename> to be added to the repository.
@@ -560,7 +560,7 @@
</varlistentry>
<varlistentry>
- <term><command>svn delete foo</command></term>
+ <term><userinput>svn delete foo</userinput></term>
<listitem>
<para>Schedule file, directory, or symbolic link
<filename>foo</filename> to be deleted from the
@@ -586,7 +586,7 @@
</varlistentry>
<varlistentry>
- <term><command>svn copy foo bar</command></term>
+ <term><userinput>svn copy foo bar</userinput></term>
<listitem>
<para>Create a new item <filename>bar</filename> as a
duplicate of <filename>foo</filename> and automatically
@@ -601,10 +601,10 @@
</varlistentry>
<varlistentry>
- <term><command>svn move foo bar</command></term>
+ <term><userinput>svn move foo bar</userinput></term>
<listitem>
<para>This command is exactly the same as running
- <command>svn copy foo bar; svn delete foo</command>.
+ <userinput>svn copy foo bar; svn delete foo</userinput>.
That is, <filename>bar</filename> is scheduled for
addition as a copy of <filename>foo</filename>, and
<filename>foo</filename> is scheduled for removal.
@@ -615,10 +615,10 @@
</varlistentry>
<varlistentry>
- <term><command>svn mkdir blort</command></term>
+ <term><userinput>svn mkdir blort</userinput></term>
<listitem>
<para>This command is exactly the same as running
- <command>mkdir blort; svn add blort</command>. That is,
+ <userinput>mkdir blort; svn add blort</userinput>. That is,
a new directory named <filename>blort</filename> is
created and scheduled for addition.</para>
</listitem>
@@ -731,7 +731,7 @@
or potentially incorporating new changes published by
other users.</para>
- <para>In Subversion, <command>update</command> does just
+ <para>In Subversion, <command>svn update</command> does just
that—it updates your working copy with any changes
committed to the repository since the last time you've
updated your working copy. You may have to break the
@@ -861,7 +861,7 @@
</screen>
<para>Notice the two asterisks: if you were to run
- <command>svn update</command> at this point, you would
+ <userinput>svn update</userinput> at this point, you would
receive changes to <filename>README</filename>
and <filename>trout.c</filename>. This tells you some very
useful information—you'll need to update and get the
@@ -884,7 +884,7 @@
<para>Another way to examine your changes is with the
<command>svn diff</command> command. You can find out
<emphasis>exactly</emphasis> how you've modified things by
- running <command>svn diff</command> with no arguments, which
+ running <userinput>svn diff</userinput> with no arguments, which
prints out file changes in <firstterm>unified diff
format</firstterm>:</para>
@@ -961,8 +961,8 @@
(<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>
+ <userinput>svn diff --diff-cmd /usr/bin/diff --extensions '-i'
+ foo.c</userinput>.</para>
</sect3>
@@ -1011,11 +1011,10 @@
</screen>
<note>
- <para><command>svn revert</command>
- <replaceable>ITEM</replaceable> has exactly the same
+ <para><userinput>svn revert <replaceable>ITEM</replaceable></userinput> has exactly the same
effect as deleting <replaceable>ITEM</replaceable> from
- your working copy and then running <command>svn update -r
- BASE</command> <replaceable>ITEM</replaceable>. However,
+ your working copy and then running <userinput>svn update -r
+ BASE <replaceable>ITEM</replaceable></userinput>. However,
if you're reverting a file, <command>svn revert</command>
has one very noticeable difference—it doesn't have
to communicate with the repository to restore your
@@ -1043,9 +1042,9 @@
<sect2 id="svn.tour.cycle.resolve">
<title>Resolve Conflicts (Merging Others' Changes)</title>
- <para>We've already seen how <command>svn status -u</command>
- can predict conflicts. Suppose you run <command>svn
- update</command> and some interesting things occur:</para>
+ <para>We've already seen how <userinput>svn status -u</userinput>
+ can predict conflicts. Suppose you run <userinput>svn
+ update</userinput> and some interesting things occur:</para>
<screen>
$ svn update
@@ -1196,7 +1195,7 @@
<para>Before deciding how to attack a conflict interactively,
odds are that you'd like to see what exactly is in conflict,
and the <firstterm>diff</firstterm> command
- (<command>d</command>) is what you'll use for this:</para>
+ (<userinput>d</userinput>) is what you'll use for this:</para>
<screen>
…
@@ -1236,7 +1235,7 @@
<para>If you wish to choose some combination of your local
changes, you can use the <quote>edit</quote> command
- (<command>e</command>) to manually edit the file with
+ (<userinput>e</userinput>) to manually edit the file with
conflict markers in a text editor (determined by the
<literal>EDITOR</literal> environment variable). Editing
the file by hand in your favorite text editor is a somewhat
@@ -1270,9 +1269,9 @@
but just want to accept one version of the file or the
other, you can either choose your changes (aka
<quote>mine</quote>) by using the <quote>mine-full</quote>
- command (<command>mf</command>) or choose theirs by using the
+ command (<userinput>mf</userinput>) or choose theirs by using the
<quote>theirs-full</quote> command
- (<command>tf</command>).</para>
+ (<userinput>tf</userinput>).</para>
</sect3>
@@ -1285,9 +1284,9 @@
marital disagreements, but it's actually still about
Subversion, so read on. If you're doing an update and
encounter a conflict that you're not prepared to review or
- resolve, you can type <command>p</command> to postpone
+ resolve, you can type <userinput>p</userinput> to postpone
resolving a conflict on a file-by-file basis when you run
- <command>svn update</command>. If you're running an update
+ <userinput>svn update</userinput>. If you're running an update
and don't want to resolve any conflicts, you can pass the
<option>--non-interactive</option> option to <command>svn
update</command>, and any file in conflict will be marked
@@ -1534,7 +1533,7 @@
Bottom piece of bread
</screen>
- <para>Now run <command>svn resolve</command>, and you're
+ <para>Now use <command>svn resolve</command>, and you're
ready to commit your changes:</para>
<screen>
@@ -1546,7 +1545,7 @@
<para>Note that <command>svn resolve</command>, unlike most of
the other commands we deal with in this chapter, requires
that you explicitly list any filenames that you wish to
- resolve. In any case, you want to be careful and run
+ resolve. In any case, you want to be careful and use
<command>svn resolve</command> only when you're certain that
you've fixed the conflict in your file—once the
temporary files are removed, Subversion will let you commit
@@ -1566,8 +1565,8 @@
<title>Discarding your changes in favor of a newly fetched revision</title>
<para>If you get a conflict and decide that you want to throw
- out your changes, you can run <command>svn resolve --accept
- theirs-full</command> and Subversion will discard your edits
+ out your changes, you can run <userinput>svn resolve --accept
+ theirs-full <replaceable>CONFLICTED-PATH</replaceable></userinput> and Subversion will discard your edits
and remove the temporary files:</para>
<screen>
@@ -1601,7 +1600,7 @@
</screen>
<para>Note that when you revert a conflicted file, you don't
- have to run <command>svn resolve</command>.</para>
+ have to use <command>svn resolve</command>.</para>
</sect3>
@@ -1687,8 +1686,8 @@
network protocol and server you're using, but the idea is the
same in all cases.)</para>
- <para>At this point, you need to run <command>svn
- update</command>, deal with any merges or conflicts that
+ <para>At this point, you need to run <userinput>svn
+ update</userinput>, deal with any merges or conflicts that
result, and attempt your commit again.</para>
<para>That covers the basic work cycle for using Subversion.
@@ -1822,8 +1821,8 @@
<title>Why Does <command>svn log</command> Not Show Me What I
Just Committed?</title>
- <para>If you make a commit and immediately type <command>svn
- log</command> with no arguments, you may notice that your
+ <para>If you make a commit and immediately type <userinput>svn
+ log</userinput> with no arguments, you may notice that your
most recent commit doesn't show up in the list of log
messages. This is due to a combination of the behavior of
<command>svn commit</command> and the default behavior of
@@ -1895,8 +1894,8 @@
nor any of its children was changed, Subversion will show you
an empty log. If you want to see what changed in that
revision, try pointing <command>svn log</command> directly at
- the top-most URL of your repository, as in <command>svn log -r 2
- http://svn.collab.net/repos/svn</command>.</para>
+ the top-most URL of your repository, as in <userinput>svn log -r 2
+ http://svn.collab.net/repos/svn</userinput>.</para>
</sidebar>
@@ -1935,7 +1934,7 @@
<sect3 id="svn.tour.history.diff.local">
<title>Examining local changes</title>
- <para>As we've seen, invoking <command>svn diff</command> with
+ <para>As we've seen, invoking <userinput>svn diff</userinput> with
no options will compare your working files to the cached
<quote>pristine</quote> copies in
the <filename>.svn</filename> area:</para>
@@ -2116,7 +2115,7 @@
name.</para>
<warning>
- <para>The <command>svn list</command> with no arguments
+ <para>The <userinput>svn list</userinput> command with no arguments
defaults to the <emphasis>repository URL</emphasis> of the
current working directory, <emphasis>not</emphasis> the
local working copy directory. After all, if you want a
@@ -2213,8 +2212,8 @@
<para>However, if you're definitely not going to use a working
copy again, you can safely delete the entire thing, but you'd
be well served to take a look through the working copy for
- unversioned files. To find these files, run <command>svn
- status</command> and review any files that are prefixed by a
+ unversioned files. To find these files, run <userinput>svn
+ status</userinput> and review any files that are prefixed by a
<literal>?</literal> to make certain that they're not of
importance. After you're done reviewing, you can safely
delete your working copy.</para>
Modified: trunk/src/en/book/ch03-advanced-topics.xml
==============================================================================
--- trunk/src/en/book/ch03-advanced-topics.xml (original)
+++ trunk/src/en/book/ch03-advanced-topics.xml Thu Jul 24 23:45:39 2008
@@ -8,7 +8,7 @@
check out a working copy from a Subversion repository. You are
comfortable with submitting and receiving changes using the
<command>svn commit</command> and <command>svn update</command>
- functions. You've probably even developed a reflex that causes
+ operations. You've probably even developed a reflex that causes
you to run the <command>svn status</command> command almost
unconsciously. For all intents and purposes, you are ready to
use Subversion in a typical environment.</para>
@@ -471,11 +471,11 @@
<sect2 id="svn.advanced.props.manip">
<title>Manipulating Properties</title>
- <para>The <command>svn</command> command affords a few ways to
+ <para>The <command>svn</command> program affords a few ways to
add or modify file and directory properties. For properties
with short, human-readable values, perhaps the simplest way to
add a new property is to specify the property name and value
- on the command line of the <command>propset</command>
+ on the command line of the <command>svn propset</command>
subcommand:</para>
<screen>
@@ -488,7 +488,7 @@
offers for your property values. And if you are planning to
have a multiline textual, or even binary, property value, you
probably do not want to supply that value on the command line.
- So the <command>propset</command> subcommand takes a
+ So the <command>svn propset</command> subcommand takes a
<option>--file</option> (<option>-F</option>) option for
specifying the name of a file that contains the new property
value.</para>
@@ -595,8 +595,8 @@
<para>The last property-related subcommand is
<command>propdel</command>. Since Subversion allows you to
store properties with empty values, you can't remove a
- property altogether using <command>propedit</command> or
- <command>propset</command>. For example, this command will
+ property altogether using <command>svn propedit</command> or
+ <command>svn propset</command>. For example, this command will
<emphasis>not</emphasis> yield the desired effect:</para>
<screen>
@@ -782,7 +782,7 @@
<para>You might also have noticed the nonstandard way that
Subversion currently displays property differences. You can
- still run <command>svn diff</command> and redirect the output
+ still use <command>svn diff</command> and redirect its output
to create a usable patch file. The <command>patch</command>
program will ignore property patches—as a rule, it
ignores any noise it can't understand. This does,
@@ -1421,7 +1421,7 @@
you aren't interested in seeing those things every time you run
<command>svn status</command>, and you are pretty sure that
nobody else is interested in them either. So you use
- <command>svn propedit svn:ignore calc</command> to add some
+ <userinput>svn propedit svn:ignore calc</userinput> to add some
ignore patterns to the <filename>calc</filename> directory. For
example, you might add this as the new value of the
<literal>svn:ignore</literal> property:</para>
@@ -1487,14 +1487,14 @@
<para>Even if <literal>svn:ignore</literal> is set, you may run
into problems if you use shell wildcards in a command. Shell
wildcards are expanded into an explicit list of targets before
- Subversion operates on them, so running <command>svn
- <replaceable>SUBCOMMAND</replaceable> *</command> is just like
- running <command>svn <replaceable>SUBCOMMAND</replaceable>
- file1 file2 file3 …</command>. In the case of the
+ Subversion operates on them, so running <userinput>svn
+ <replaceable>SUBCOMMAND</replaceable> *</userinput> is just like
+ running <userinput>svn <replaceable>SUBCOMMAND</replaceable>
+ file1 file2 file3 …</userinput>. In the case of the
<command>svn add</command> command, this has an effect similar
to passing the <option>--no-ignore</option> option. So
- instead of using a wildcard, use <command>svn add --force
- .</command> to do a bulk scheduling of unversioned things for
+ instead of using a wildcard, use <userinput>svn add --force
+ .</userinput> to do a bulk scheduling of unversioned things for
addition. The explicit target will ensure that the current
directory isn't overlooked because of being already under
version control, and the <option>--force</option> option will
@@ -2012,8 +2012,8 @@
<option>--set-depth</option>. It is with this option that you
can change the sticky depth of a working copy item. Watch what
happens as we take our empty-depth checkout and gradually
- telescope it deeper using <command>svn update
- --set-depth</command>:</para>
+ telescope it deeper using <userinput>svn update
+ --set-depth <replaceable>NEW-DEPTH</replaceable> <replaceable>TARGET</replaceable></userinput>:</para>
<screen>
$ svn update --set-depth files mom-empty
@@ -2105,7 +2105,7 @@
<para>Subversion 1.5's implementation of shallow checkouts is
good but does not support a couple of interesting behaviors.
First, you cannot de-telescope a working copy item. Running
- <command>svn update --set-depth empty</command> on an
+ <userinput>svn update --set-depth empty</userinput> in an
infinite-depth working copy will not have the effect of
discarding everything but the top-most directory—it will
simply error out. Secondly, there is no depth value to indicate
@@ -2382,8 +2382,8 @@
<para>A lock token isn't an authentication token, so much as
an <emphasis>authorization</emphasis> token. The token
isn't a protected secret. In fact, a lock's unique token is
- discoverable by anyone who runs <command>svn info
- URL</command>. A lock token is special only when it lives
+ discoverable by anyone who runs <userinput>svn info
+ <replaceable>URL</replaceable></userinput>. A lock token is special only when it lives
inside a working copy. It's proof that the lock was created
in that particular working copy, and not somewhere else by
some other client. Merely authenticating as the lock owner
@@ -2449,7 +2449,7 @@
If Harry haphazardly locks 30 files in a directory named
<filename>images</filename> because he's unsure of which files
he needs to change, yet changes only 4 of those files, when he
- runs <command>svn commit images</command>, the process will
+ runs <userinput>svn commit images</userinput>, the process will
still release all 30 locks.</para>
<para>This behavior of automatically releasing locks can be
@@ -2477,8 +2477,8 @@
<title>Discovering Locks</title>
<para>When a commit fails due to someone else's locks, it's
- fairly easy to learn about them. The easiest of
- these is <command>svn status --show-updates</command>:</para>
+ fairly easy to learn about them. The easiest way is to run
+ <userinput>svn status --show-updates</userinput>:</para>
<screen>
$ svn status -u
@@ -2619,8 +2619,8 @@
<para>Simply breaking a lock may not be enough. In
the running example, Sally may not only want to break Harry's
long-forgotten lock, but re-lock the file for her own use.
- She can accomplish this by running <command>svn unlock
- --force</command> and then <command>svn lock</command>
+ She can accomplish this by using <command>svn unlock</command>
+ with <option>--force</option> and then <command>svn lock</command>
back-to-back, but there's a small chance that somebody else
might lock the file between the two commands. The simpler thing
to is <firstterm>steal</firstterm> the lock, which involves
@@ -2657,8 +2657,8 @@
$
</screen>
- <para>If the repository lock was broken, then <command>svn
- status --show-updates</command> displays a
+ <para>If the repository lock was broken, then <userinput>svn
+ status --show-updates</userinput> displays a
<literal>B</literal> (Broken) symbol next to the file. If a
new lock exists in place of the old one, then a
<literal>T</literal> (sTolen) symbol is shown. Finally,
@@ -2710,8 +2710,8 @@
<para>For example, suppose Harry locks an image file and then
begins editing it. Meanwhile, miles away, Sally wants to do
- the same thing. She doesn't think to run <command>svn status
- --show-updates</command>, so she has no idea that Harry has
+ the same thing. She doesn't think to run <userinput>svn status
+ --show-updates</userinput>, so she has no idea that Harry has
already locked the file. She spends hours editing the file,
and when she tries to commit her change, she discovers that
either the file is locked or that she's out of date.
@@ -2727,7 +2727,7 @@
which is irrelevant), then Subversion will try to use
filesystem-level permissions to make the file read-only—unless,
of course, the user has explicitly locked the file.
- When a lock token is present (as a result of running
+ When a lock token is present (as a result of using
<command>svn lock</command>), the file becomes read-write.
When the lock is released, the file becomes read-only
again.</para>
@@ -2842,7 +2842,7 @@
When you commit a change to the <literal>svn:externals</literal>
property, Subversion will synchronize the checked-out items
against the changed externals definition when you next run
- <command>svn update</command>. The same thing will happen when
+ <userinput>svn update</userinput>. The same thing will happen when
others update their working copies and receive your changes to
the externals definition.</para>
@@ -3009,8 +3009,8 @@
be checking out via <literal>http://</literal> because their
client doesn't support <literal>https://</literal> will be
unable to fetch the external items. Be aware, too, that if you
- need to re-parent your working copy (using <command>svn switch
- --relocate</command>), externals definitions will
+ need to re-parent your working copy (using <command>svn switch</command>
+ with the <option>--relocate</option> option), externals definitions will
<emphasis>not</emphasis> also be re-parented.</para>
<para>Subversion 1.5 takes a huge step in relieving these
@@ -3727,7 +3727,7 @@
<para>The <option>--changelist</option> option acts only as a
filter for Subversion command targets, and will not add
targets to an operation. For example, on a commit operation
- specified as <command>svn commit /path/to/dir</command>, the
+ specified as <userinput>svn commit /path/to/dir</userinput>, the
target is the directory <filename>/path/to/dir</filename>
and its children (to infinite depth). If you then add a
changelist specifier to that command, only those files in
@@ -3815,7 +3815,7 @@
particular protocol is used to contact the server (see <xref
linkend="svn.basic.in-action.wc.sb-1"/>).</para>
- <tip><para>Run <command>svn --version</command> to see
+ <tip><para>Run <userinput>svn --version</userinput> to see
which URL schemes and protocols the client knows how to
use.</para>
</tip>
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 Jul 24 23:45:39 2008
@@ -1745,8 +1745,8 @@
<quote>unwedged.</quote></para>
</listitem>
<listitem>
- <para>Run the command <command>svnadmin recover
- /var/svn/repos</command>. You should see output like
+ <para>Run the command <userinput>svnadmin recover
+ /var/svn/repos</userinput>. You should see output like
this:</para>
<screen>
@@ -2863,7 +2863,7 @@
chapter for more about this.</para>
<para>Once the two repositories have the same UUID, you can use
- <command>svn switch --relocate</command> to point your working
+ <command>svn switch</command> with the <option>--relocate</option> option to point your working
copy to whichever of the repositories you wish to operate
against, a process that is described in <xref
linkend="svn.ref.svn.c.switch" />. There is a possible danger
@@ -2974,7 +2974,7 @@
<para>Some administrators use a different backup mechanism built
around generating and storing repository dump data. We
described in <xref linkend="svn.reposadmin.maint.migrate" />
- how to use <command>svnadmin dump --incremental</command> to
+ how to use <command>svnadmin dump</command> with the <option>--incremental</option> option to
perform an incremental backup of a given revision or range of
revisions. And of course, there is a full backup variation of
this achieved by omitting the <option>--incremental</option>
@@ -3127,7 +3127,7 @@
these tasks are a little more complicated. You can explicitly
set a repository's UUID by piping a repository dump file stub
that carries the new UUID specification through
- <command>svnadmin load --force-uuid</command>.</para>
+ <userinput>svnadmin load --force-uuid <replaceable>REPOS-PATH</replaceable></userinput>.</para>
<screen>
$ svnadmin load --force-uuid /var/svn/repos <<EOF
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 Jul 24 23:45:39 2008
@@ -582,13 +582,13 @@
<para>A third way to invoke <command>svnserve</command> is in
tunnel mode, using the <option>-t</option> option. This
mode assumes that a remote-service program such as
- <command>RSH</command> or <command>SSH</command> has
+ <command>rsh</command> or <command>ssh</command> has
successfully authenticated a user and is now invoking a
private <command>svnserve</command> process <emphasis>as
that user</emphasis>. (Note that you, the user, will
rarely, if ever, have reason to invoke
<command>svnserve</command> with the <option>-t</option> at
- the command line; instead, the <command>SSH</command> daemon
+ the command line; instead, the SSH daemon
does so for you.) The <command>svnserve</command> program
behaves normally (communicating via
<emphasis>stdin</emphasis> and <emphasis>stdout</emphasis>)
@@ -688,10 +688,10 @@
</screen>
<para>The service can also be uninstalled (i.e. undefined) by
- deleting its definition: <literal>sc delete svn</literal>.
+ deleting its definition: <userinput>sc delete svn</userinput>.
Just be sure to stop the service first!
The <command>SC.EXE</command> program has many other
- subcommands and options; run <literal>sc /?</literal> to
+ subcommands and options; run <userinput>sc /?</userinput> to
learn more about it.</para>
</sect3>
@@ -757,7 +757,7 @@
<para>It's also possible, of course, for the client to be
externally authenticated via a tunnel agent, such as
- <command>SSH</command>. In that case, the server simply
+ <command>ssh</command>. In that case, the server simply
examines the user it's running as, and uses this name as the
authenticated username. For more on this, see the later
section <xref
@@ -1201,11 +1201,11 @@
URL scheme that matches the name of your new variable:
<literal>svn+rsh://host/path</literal>. When using the new
URL scheme, the Subversion client will actually be running the
- command <command>rsh host svnserve -t</command> behind the
+ command <userinput>rsh host svnserve -t</userinput> behind the
scenes. If you include a username in the URL (for example,
<literal>svn+rsh://username@host/path</literal>), the client
- will also include that in its command (<command>rsh
- username at host svnserve -t</command>). But you can define new
+ will also include that in its command (<userinput>rsh
+ username at host svnserve -t</userinput>). But you can define new
tunneling schemes to be much more clever than that:</para>
<screen>
@@ -1234,8 +1234,8 @@
the <literal>JOESSH</literal> environment variable, its value
would override the entire value of the tunnel
variable—<command>$JOESSH</command> would be executed
- instead of <command>/opt/alternate/ssh -p
- 29934</command>.</para>
+ instead of <userinput>/opt/alternate/ssh -p
+ 29934</userinput>.</para>
</sect2>
@@ -1286,7 +1286,7 @@
<para>When the <literal>command</literal> field is set, the
SSH daemon will run the named program instead of the
- typical <command>svnserve -t</command> invocation that the
+ typical tunnel-mode <command>svnserve</command> invocation that the
Subversion client asks for. This opens the door to a number
of server-side tricks. In the following examples, we
abbreviate the lines of the file as:</para>
@@ -1338,7 +1338,7 @@
the same account via public-key authentication. Each of
them has a custom command that will be executed;
the <option>--tunnel-user</option> option
- tells <command>svnserve -t</command> to assume that the named
+ tells <command>svnserve</command> to assume that the named
argument is the authenticated user. Without
<option>--tunnel-user</option>, it would appear as though
all commits were coming from the one shared system
@@ -2234,12 +2234,12 @@
<quote>unreadable</quote> doesn't get accidentally leaked.
This means that it needs to closely monitor all of the paths
and file-contents returned by commands such as <command>svn
- checkout</command> or <command>svn update</command>
- commands. If these commands encounter a path that isn't
+ checkout</command> or <command>svn update</command>.
+ If these commands encounter a path that isn't
readable according to some authorization policy, then the
path is typically omitted altogether. In the case of
history or rename tracing—e.g., running a command such
- as <command>svn cat -r OLD foo.c</command> on a file that
+ as <userinput>svn cat -r OLD foo.c</userinput> on a file that
was renamed long ago—the rename tracking will simply
halt if one of the object's former names is determined to be
read-restricted.</para>
@@ -2781,7 +2781,7 @@
nonissue for you. However, if lock changes aren't
replicated from master to slaves, it means that clients
won't be able to query the status of locks
- (e.g., <command>svn status -u</command> will show no
+ (e.g., <userinput>svn status -u</userinput> will show no
information about repository locks). If this bothers you,
you can write <filename>post-lock</filename> and
<filename>post-unlock</filename> hook scripts that run
@@ -2975,7 +2975,7 @@
time to define the rules.</para>
<para>The syntax of the file is the same familiar one used
- by <command>svnserve.conf</command> and the runtime
+ by <filename>svnserve.conf</filename> and the runtime
configuration files. Lines that start with a hash
(<literal>#</literal>) are ignored. In its simplest form, each
section names a repository and path within it, as well as the
@@ -3255,11 +3255,11 @@
repository users is to force every repository-accessing process
to use a sane umask. For users accessing the repository
directly, you can make the <command>svn</command> program into a
- wrapper script that first sets <command>umask 002</command> and
+ wrapper script that first runs <userinput>umask 002</userinput> and
then runs the real <command>svn</command> client program. You
can write a similar wrapper script for the
- <command>svnserve</command> program, and add a <command>umask
- 002</command> command to Apache's own startup script,
+ <command>svnserve</command> program, and add a <userinput>umask
+ 002</userinput> command to Apache's own startup script,
<filename>apachectl</filename>. For example:</para>
<screen>
@@ -3333,7 +3333,7 @@
repository, so make sure that <command>svnserve</command>
(<filename>/usr/bin/svnserve</filename>, or wherever it
lives in <literal>$PATH</literal>) is actually a wrapper
- script that sets <command>umask 002</command> and
+ script that runs <userinput>umask 002</userinput> and
executes the real <command>svnserve</command>
binary.</para>
</listitem>
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 Jul 24 23:45:39 2008
@@ -97,7 +97,7 @@
any time you wish to have the default configuration settings
restored, you can simply remove (or rename) your configuration
directory and then run some innocuous <command>svn</command>
- command, such as <command>svn --version</command>. A new
+ command, such as <userinput>svn --version</userinput>. A new
configuration directory with the default contents will be
created.</para>
@@ -848,8 +848,8 @@
every locale variable to the same value. The value of
<literal>LANG</literal> is used as a default value for any
locale variable that is unset. To see the list of available
- locales on a Unix system, run the command <command>locale
- -a</command>.</para>
+ locales on a Unix system, run the command <userinput>locale
+ -a</userinput>.</para>
<para>On Windows, locale configuration is done via the
<quote>Regional and Language Options</quote> control panel
Modified: trunk/src/en/book/ch09-reference.xml
==============================================================================
--- trunk/src/en/book/ch09-reference.xml (original)
+++ trunk/src/en/book/ch09-reference.xml Thu Jul 24 23:45:39 2008
@@ -254,8 +254,8 @@
<option>--diff-cmd</option> option.
If you wish to pass multiple
arguments, you must enclose all of them in quotes (for
- example, <command>svn diff --diff-cmd /usr/bin/diff -x
- "-b -E"</command>).</para>
+ example, <userinput>svn diff --diff-cmd /usr/bin/diff -x
+ "-b -E"</userinput>).</para>
</listitem>
<!-- TODO(fitz): Document -u -b -w and - -ignore-eol-style -->
@@ -598,7 +598,7 @@
which files in your working copy are out of date.
This doesn't actually update any of your
files—it just shows you which files will be
- updated if you run <command>svn update</command>.
+ updated if you then use <command>svn update</command>.
</para>
</listitem>
</varlistentry>
@@ -670,8 +670,8 @@
<varlistentry>
<term><option>--with-all-revprops</option></term>
<listitem>
- <para>Used with <command>svn log --xml</command>, this
- option will retrieve and display all revision
+ <para>Used with the <option>--xml</option> option to <command>svn log</command>, this
+ causes <command>svn</command> to retrieve and display all revision
properties in the log output.</para>
</listitem>
</varlistentry>
@@ -685,7 +685,7 @@
<replaceable>NAME=VALUE</replaceable> format,
<replaceable>NAME</replaceable> to
<replaceable>VALUE</replaceable>. When used with
- <command>svn log --xml</command>, this displays the value of
+ <command>svn log</command> in <option>--xml</option> mode, this displays the value of
<replaceable>ARG</replaceable> in the log output.</para>
</listitem>
</varlistentry>
@@ -799,7 +799,7 @@
A otherdir
</screen>
- <para>Normally, the command <command>svn add *</command>
+ <para>Normally, the command <userinput>svn add *</userinput>
will skip over any directories that are already under
version control. Sometimes, however, you may want to add
every unversioned object in your working copy, including
@@ -847,7 +847,7 @@
<refsect1>
<title>Alternate Names</title>
- <para><command>praise, annotate, ann</command></para>
+ <para><command>praise</command>, <command>annotate</command>, <command>ann</command></para>
</refsect1>
<refsect1>
@@ -1018,9 +1018,9 @@
<para>If your working copy is out of date (or you have
local modifications) and you want to see the
<literal>HEAD</literal> revision of a file in your
- working copy, <command>svn cat -r HEAD</command> will
+ working copy, <command>svn cat -r HEAD <replaceable>FILENAME</replaceable></command> will
automatically fetch the <literal>HEAD</literal> revision
- when you give it a path:</para>
+ of the specified path:</para>
</tip>
<screen>
@@ -1404,9 +1404,9 @@
<refsect1>
<title>Alternate Name</title>
- <para><command>ci</command> (short for <command>check in</command>; not
- <command>co</command>, which is short for
- <command>checkout</command>)</para>
+ <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>
@@ -1893,7 +1893,7 @@
</itemizedlist>
- <para><command>diff OLD-URL[@OLDREV]
+ <para><command>svn diff OLD-URL[@OLDREV]
NEW-URL[@NEWREV]</command> is shorthand for <command>svn
diff --old=OLD-URL[@OLDREV]
--new=NEW-URL[@NEWREV].</command></para>
@@ -2919,8 +2919,8 @@
<title>Examples</title>
<para>You can see the log messages for all the paths that
- changed in your working copy by running <command>svn
- log</command> from the top:</para>
+ changed in your working copy by running <userinput>svn
+ log</userinput> from the top:</para>
<screen>
$ svn log
@@ -3033,8 +3033,8 @@
</variablelist>
<para>In addition to the action codes which precede the
- changed paths, <command>svn log --verbose</command> will
- note a path was added or replaced as the result of a copy
+ changed paths, <command>svn log</command> with the <option>--verbose</option> option will
+ note that a path was added or replaced as the result of a copy
operation. It does so by printing <literal>(from
<replaceable>COPY-FROM-PATH</replaceable>:<replaceable>COPY-FROM-REV</replaceable>)</literal>
after such paths.</para>
@@ -4222,7 +4222,7 @@
<title>Description</title>
<para>This command has been deprecated in favor of
- running <command>svn resolve --accept working</command>.
+ running <userinput>svn resolve --accept working <replaceable>PATH</replaceable></userinput>.
See <xref linkend="svn.ref.svn.c.resolve"/> for
details.</para>
@@ -4790,7 +4790,7 @@
<para><option>--show-updates</option>
<emphasis>only</emphasis> places an asterisk next to
items that are out of date (that is, items that will be
- updated from the repository if you run <command>svn
+ updated from the repository if you later use <command>svn
update</command>). <option>--show-updates</option> does
<emphasis>not</emphasis> cause the status listing to
reflect the repository's version of the item (although
@@ -5040,7 +5040,7 @@
<listitem><para>If the working copy still reflects the
same repository directory, but the location of the
repository itself has changed, then use <command>svn
- switch --relocate</command>.</para></listitem>
+ switch</command> with the <option>--relocate</option> option.</para></listitem>
</itemizedlist>
</warning>
@@ -6298,8 +6298,8 @@
revision <replaceable>REVISION</replaceable> to the
contents of <replaceable>FILE</replaceable>.</para>
- <para>This is similar to using <command>svn propset
- --revprop</command> to set the <literal>svn:log</literal> property
+ <para>This is similar to using <command>svn propset</command>
+ with the <option>--revprop</option> option to set the <literal>svn:log</literal> property
on a revision, except that you can also use the option
<option>--bypass-hooks</option> to avoid running any pre-
or post-commit hooks, which is useful if the modification
@@ -6430,10 +6430,10 @@
<refsect1>
<title>Examples</title>
- <para>If you've <command>svnsync</command>ed /var/svn/repos
- to /var/svn/repos-new and intend to use repos-new as your
+ <para>If you've <command>svnsync</command>ed <filename>/var/svn/repos</filename>
+ to <filename>/var/svn/repos-new</filename> and intend to use <filename>repos-new</filename> as your
canonical repository, you may want to change the UUID for
- repos-new to the UUID of repos so that your users don't
+ <filename>repos-new</filename> to the UUID of <filename>repos</filename> so that your users don't
have to check out a new working copy to accomodate the
change:</para>
More information about the svnbook-dev
mailing list