[svnbook commit] r3041 - trunk/src/en/book
fitz
noreply at red-bean.com
Thu May 1 16:57:11 CDT 2008
Author: fitz
Date: Thu May 1 16:57:10 2008
New Revision: 3041
Log:
Copyedits for Chapter 2.
* src/en/book/ch02-basic-usage.xml: Death by a thousand cuts.
Modified:
trunk/src/en/book/ch02-basic-usage.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 May 1 16:57:10 2008
@@ -13,7 +13,7 @@
<para>Note that this chapter is not meant to be an exhaustive list
of all Subversion's commands—rather, it's a conversational
- introduction to the most common Subversion tasks you'll
+ introduction to the most common Subversion tasks that you'll
encounter. This chapter assumes that you've read and understood
<xref linkend="svn.basic"/> and are familiar with the general
model of Subversion. For a complete reference of all commands,
@@ -57,12 +57,12 @@
<sidebar>
<title>Options and Switches and Flags, Oh My!</title>
- <para>The Subversion command line client has numerous command
+ <para>The Subversion command-line client has numerous command
modifiers (which we call options), but there are two
- distinct kinds of options—<quote>short options</quote>
- that are a single hyphen followed by a single letter, and
- <quote>long options</quote> that consist of two hyphens
- followed by a number of letters (eg <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 a number of letters (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
@@ -82,13 +82,13 @@
<!-- ================================================================= -->
<!-- ================================================================= -->
<sect1 id="svn.tour.importing">
- <title>Getting Data into your Repository</title>
+ <title>Getting Data into Your Repository</title>
<para>There are two ways to get new files into your Subversion
repository: <command>svn import</command> and <command>svn
- add</command>. We'll discuss <command>svn import</command> here
- and <command>svn add</command> later in this chapter when we
- review a typical day with Subversion.</para>
+ add</command>. We'll discuss <command>svn import</command> now
+ and will discuss <command>svn add</command> later in this
+ chapter when we review a typical day with Subversion.</para>
<!-- =============================================================== -->
<sect2 id="svn.tour.importing.import">
@@ -134,15 +134,15 @@
<!-- =============================================================== -->
<sect2 id="svn.tour.importing.layout">
- <title>Recommended repository layout</title>
+ <title>Recommended Repository Layout</title>
- <para>While Subversion's flexibility allows you to layout your
+ <para>While Subversion's flexibility allows you to lay out your
repository in any way that you choose, we recommend that you
create a <filename>trunk</filename> directory to hold the
<quote>main line</quote> of development, a
<filename>branches</filename> directory to contain branch
copies, and a <filename>tags</filename> directory to contain tag
- copies, for example:</para>
+ copies—for example:</para>
<screen>
$ svn list file:///var/svn/repos
@@ -156,7 +156,7 @@
multiple projects, see <xref
linkend="svn.branchmerge.maint.layout"/> and <xref
linkend="svn.reposadmin.projects.chooselayout"/> to read more
- about <quote>project roots</quote>.</para>
+ about project roots.</para>
</sect2>
@@ -202,7 +202,7 @@
<para>Subversion internally handles certain bits of
data—for example, property names, path names, and log
- messages—as UTF-8 encoded Unicode. This is not to say
+ messages—as UTF-8-encoded Unicode. This is not to say
that all your interactions with Subversion must involve UTF-8,
though. As a general rule, Subversion clients will gracefully
and transparently handle conversions between UTF-8 and the
@@ -212,22 +212,22 @@
<para>In addition, path names are used as XML attribute values
in WebDAV exchanges, as well in as some of Subversion's
- housekeeping files. This means that path names can only
- contain legal XML (1.0) characters. Subversion also prohibits
+ housekeeping files. This means that path names can contain
+ only legal XML (1.0) characters. Subversion also prohibits
TAB, CR, and LF characters in path names to prevent paths from
- being broken up in diffs, or in the output of commands like
- <xref linkend="svn.ref.svn.c.log"/> or <xref
- linkend="svn.ref.svn.c.status"/>.</para>
+ being broken up in diffs or in the output of commands such as
+ <command>svn log</command> or <command>svn
+ status</command>.</para>
<para>While it may seem like a lot to remember, in practice
these limitations are rarely a problem. As long as your
- locale settings are compatible with UTF-8, and you don't use
+ locale settings are compatible with UTF-8 and you don't use
control characters in path names, you should have no trouble
communicating with Subversion. The command-line client adds
- an extra bit of help—it will automatically escape illegal
- path characters as needed in URLs you type to create
+ an extra bit of help—in order to create
<quote>legally correct</quote> versions for internal
- use.</para>
+ use it will automatically escape illegal
+ path characters as needed in URLs that you type.</para>
</sidebar>
@@ -249,17 +249,17 @@
</screen>
<para>Since Subversion uses a <quote>copy-modify-merge</quote>
- model instead of <quote>lock-modify-unlock</quote> (see <xref
- linkend="svn.basic.vsn-models"/>), you can start right in
+ model instead of <quote>lock-modify-unlock</quote> (see
+ <xref linkend="svn.basic.vsn-models"/>), you can start right in
making changes to the files and directories in your working
copy. Your working copy is just like any other collection of
files and directories on your system. You can edit and change
- them, move them around, you can even delete the entire working
- copy and forget about it.</para>
+ them, move them around, even delete the entire working copy and
+ forget about it.</para>
<warning>
<para>While your working copy is <quote>just like any other
- collection of files and directories on your system</quote>,
+ collection of files and directories on your system,</quote>
you can edit files at will, but you must tell Subversion
about <emphasis>everything else</emphasis> that you do. For
example, if you want to copy or move an item in a working
@@ -270,15 +270,15 @@
</warning>
<para>Unless you're ready to commit the addition of a new file or
- directory, or changes to existing ones, there's no need to
+ directory or changes to existing ones, there's no need to
further notify the Subversion server that you've done
anything.</para>
<sidebar>
- <title>What's with the <filename>.svn</filename> directory?</title>
+ <title>What's with the <filename>.svn</filename> Directory?</title>
<para>Every directory in a working copy contains an
- administrative area, a subdirectory named
+ administrative area—a subdirectory named
<filename>.svn</filename>. Usually, directory listing
commands won't show this subdirectory, but it is nevertheless
an important directory. Whatever you do, don't delete or
@@ -331,7 +331,7 @@
because you know that you can't
<emphasis>really</emphasis> delete anything from
Subversion and, secondly, because your Subversion password
- isn't the same as any of the other three million passwords
+ isn't the same as any of the other 3 million passwords
you have, right? Right?</para>
</footnote>
you can disable caching either permanently or on a
@@ -339,7 +339,7 @@
<para>To disable password caching for a particular one-time
command, pass the <option >--no-auth-cache</option > option on
- the commandline. To permanently disable caching, you can add
+ the command line. To permanently disable caching, you can add
the line <literal>store-passwords = no</literal> to your local
machine's Subversion configuration file. See <xref
linkend="svn.serverconfig.netmodel.credcache"/> for
@@ -354,10 +354,10 @@
username and password), it conveniently remembers who you were
acting as the last time you modified you working copy. But
sometimes that's not helpful—particularly if you're
- working in a shared working copy, like a system configuration
- directory or a webserver document root. In this case, just
- pass the <option>--username</option> option on the
- commandline and Subversion will attempt to authenticate as
+ working in a shared working copy such as a system
+ configuration directory or a webserver document root. In this
+ case, just pass the <option>--username</option> option on the
+ command line, and Subversion will attempt to authenticate as
that user, prompting you for a password if necessary.</para>
</sect2>
@@ -370,17 +370,17 @@
<sect1 id="svn.tour.cycle">
<title>Basic Work Cycle</title>
- <para>Subversion has numerous features, options, bells and
+ <para>Subversion has numerous features, options, bells, and
whistles, but on a day-to-day basis, odds are that you will only
- use a few of them. In this section we'll run through the most
+ use a few of them. In this section, we'll run through the most
common things that you might find yourself doing with Subversion
in the course of a day's work.</para>
<para>The typical work cycle looks like this:</para>
- <itemizedlist>
+ <orderedlist>
<listitem>
- <para>Update your working copy</para>
+ <para>Update your working copy.</para>
<itemizedlist>
<listitem>
<para><command>svn update</command></para>
@@ -390,7 +390,7 @@
</listitem>
<listitem>
- <para>Make changes</para>
+ <para>Make changes.</para>
<itemizedlist>
<listitem>
<para><command>svn add</command></para>
@@ -408,7 +408,7 @@
</listitem>
<listitem>
- <para>Examine your changes</para>
+ <para>Examine your changes.</para>
<itemizedlist>
<listitem>
<para><command>svn status</command></para>
@@ -420,7 +420,7 @@
</listitem>
<listitem>
- <para>Possibly undo some changes</para>
+ <para>Possibly undo some changes.</para>
<itemizedlist>
<listitem>
<para><command>svn revert</command></para>
@@ -430,7 +430,7 @@
<listitem>
- <para>Resolve Conflicts (Merge Others' Changes)</para>
+ <para>Resolve conflicts (merge others' changes).</para>
<itemizedlist>
<listitem>
<para><command>svn update</command></para>
@@ -442,14 +442,14 @@
</listitem>
<listitem>
- <para>Commit your changes</para>
+ <para>Commit your changes.</para>
<itemizedlist>
<listitem>
<para><command>svn commit</command></para>
</listitem>
</itemizedlist>
</listitem>
- </itemizedlist>
+ </orderedlist>
<!-- =============================================================== -->
<sect2 id="svn.tour.cycle.update">
@@ -459,7 +459,7 @@
update your working copy to receive any changes made since
your last update by other developers on the project. Use
<command>svn update</command> to bring your working copy into
- sync with the latest revision in the repository.</para>
+ sync with the latest revision in the repository:</para>
<screen>
$ svn update
@@ -477,8 +477,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, see <xref linkend
- ="svn.ref.svn.c.update"/>.</para>
+ letters mean, see <command>svn update</command>.</para>
</sect2>
@@ -498,12 +497,13 @@
commit.</para>
<para>There are two kinds of changes you can make to your
- working copy: file changes and tree changes. You don't need
- to tell Subversion that you intend to change a file; just make
+ working copy: <firstterm>file changes</firstterm>
+ and <firstterm>tree changes</firstterm>. You don't need to
+ tell Subversion that you intend to change a file; just make
your changes using your text editor, word processor, graphics
program, or whatever tool you would normally use. Subversion
automatically detects which files have been changed, and in
- addition handles binary files just as easily as it handles
+ addition, handles binary files just as easily as it handles
text files—and just as efficiently too. For tree
changes, you can ask Subversion to <quote>mark</quote> files
and directories for scheduled removal, addition, copying, or
@@ -511,16 +511,13 @@
working copy, but no additions or removals will happen in the
repository until you commit them.</para>
- <para>Here is an overview of the five Subversion subcommands
- that you'll use most often to make tree changes.</para>
-
<sidebar>
- <title>Versioning symbolic links</title>
+ <title>Versioning Symbolic Links</title>
<para>On non-Windows platforms, Subversion is able to version
files of the special type <firstterm>symbolic
- link</firstterm> (or, <quote>symlink</quote>). A symlink is
- a file which acts as a sort of transparent reference to some
+ link</firstterm> (or <quote>symlink</quote>). A symlink is
+ a file that acts as a sort of transparent reference to some
other object in the filesystem, allowing programs to read
and write to those objects indirectly by way of performing
operations on the symlink itself.</para>
@@ -528,11 +525,11 @@
<para>When a symlink is committed into a Subversion
repository, Subversion remembers that the file was in fact a
symlink, as well as the object to which the symlink
- <quote>points</quote>. When that symlink is checked out to
+ <quote>points.</quote> When that symlink is checked out to
another working copy on a non-Windows system, Subversion
reconstructs a real filesystem-level symbolic link from the
versioned symlink. But that doesn't in any way limit the
- usability of working copies on systems such as Windows which
+ usability of working copies on systems such as Windows that
do not support symlinks. On such systems, Subversion simply
creates a regular text file whose contents are the path to
which to the original symlink pointed. While that file
@@ -540,6 +537,9 @@
won't prevent Windows users from performing their other
Subversion-related activities.</para> </sidebar>
+ <para>Here is an overview of the five Subversion subcommands
+ that you'll use most often to make tree changes.</para>
+
<variablelist>
<varlistentry>
@@ -551,7 +551,7 @@
become a child of its parent directory. Note that if
<filename>foo</filename> is a directory, everything
underneath <filename>foo</filename> will be scheduled
- for addition. If you only want to add
+ for addition. If you want only to add
<filename>foo</filename> itself, pass the
<option>--non-recursive</option> (<option>-N</option>)
option.</para>
@@ -630,11 +630,11 @@
<para>There <emphasis>are</emphasis> some use cases that
immediately commit tree changes to the repository. This
- only happens when a subcommand is operating directly on a
+ happens only when a subcommand is operating directly on a
URL, rather than on a working-copy path. In particular,
specific uses of <command>svn mkdir</command>, <command>svn
copy</command>, <command>svn move</command>, and
- <command>svn delete</command> can work with URLs (And don't
+ <command>svn delete</command> can work with URLs (and don't
forget that <command>svn import</command> always makes
changes to a URL).</para>
@@ -677,7 +677,7 @@
network. This makes it easy to manage your
changes-in-progress when you are somewhere without a network
connection, such as travelling on an airplane, riding a
- commuter train or hacking on the beach.
+ commuter train, or hacking on the beach.
<footnote>
<para>And also that you don't have a WAN card. Thought
you got us, huh?</para>
@@ -702,12 +702,12 @@
</sidebar>
<para>Subversion has been optimized to help you with this task,
- and is able to do many things without communicating with the
- repository. In particular, your working copy contains a
+ and it is able to do many things without communicating with
+ the repository. In particular, your working copy contains a
hidden cached <quote>pristine</quote> copy of each version
controlled file within the <filename>.svn</filename> area.
Because of this, Subversion can quickly show you how your
- working files have changed, or even allow you to undo your
+ working files have changed or even allow you to undo your
changes without contacting the repository.</para>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
@@ -755,7 +755,7 @@
M bar.c # the content in bar.c has local modifications
</screen>
- <para>In this output format <command>svn status</command>
+ <para>In this output format, <command>svn status</command>
prints six columns of characters, followed by several
whitespace characters, followed by a file or directory name.
The first column tells the status of a file or directory
@@ -837,7 +837,7 @@
<para>This is the <quote>long form</quote> output of
<command>svn status</command>. The letters in the first
column mean the same as before, but the second column shows
- the working-revision of the item. The third and fourth
+ the working revision of the item. The third and fourth
columns show the revision in which the item last changed,
and who changed it.</para>
@@ -847,7 +847,7 @@
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>
+ about things that are out of date:</para>
<screen>
$ svn status -u -v
@@ -866,13 +866,13 @@
useful information—you'll need to update and get the
server changes on <filename>README</filename> before you
commit, or the repository will reject your commit for being
- out-of-date. (More on this subject later.)</para>
+ out of date. (more on this subject later).</para>
<para><command>svn status</command> can display much more
information about the files and directories in your
working copy than we've shown here—for an exhaustive
- description of svn status and its output, see <xref
- linkend="svn.ref.svn.c.status"/>.</para>
+ description of <command>svn status</command> and its
+ output, see <xref linkend="svn.ref.svn.c.status"/>.</para>
</sect3>
@@ -932,12 +932,12 @@
output by comparing your working files against the cached
<quote>pristine</quote> copies within the
<filename>.svn</filename> area. Files scheduled for
- addition are displayed as all added-text, and files
+ addition are displayed as all added text, and files
scheduled for deletion are displayed as all deleted
text.</para>
<para>Output is displayed in unified diff format. That is,
- removed lines are prefaced with <literal>-</literal> and
+ removed lines are prefaced with <literal>-</literal>, and
added lines are prefaced with
<literal>+</literal>. <command>svn diff</command> also
prints filename and offset information useful to the
@@ -987,7 +987,7 @@
Reverted 'README'
</screen>
- <para>Subversion reverts the file to its pre-modified state by
+ <para>Subversion reverts the file to its premodified state by
overwriting it with the cached <quote>pristine</quote> copy
from the <filename>.svn</filename> area. But also note that
<command>svn revert</command> can undo
@@ -1069,11 +1069,12 @@
changes.</para>
<para>But the next line is part of a feature new in Subversion
- 1.5 called interactive conflict resolution. This means that
- the changes from the server overlapped with your own, and you
- have the opportunity to resolve this conflict. The most
- commonly used options are displayed, but you can see all of
- the options by typing <replaceable>h</replaceable>: </para>
+ 1.5 called <firstterm>interactive conflict
+ resolution</firstterm>. This means that the changes from the
+ server overlapped with your own, and you have the opportunity
+ to resolve this conflict. The most commonly used options are
+ displayed, but you can see all of the options by
+ typing <replaceable>h</replaceable>:</para>
<screen>
...
@@ -1095,8 +1096,8 @@
<term><computeroutput>(p)ostpone</computeroutput></term>
<listitem>
- <para>Leaves the file in a conflicted state for you to
- resolve after your update is complete.</para>
+ <para>Leave the file in a conflicted state for you to
+ resolve after your update is complete.</para>
</listitem>
</varlistentry>
@@ -1108,7 +1109,7 @@
<listitem>
<para>Display the differences between the base revision
- and the conflicted file itself in unified diff format.</para>
+ and the conflicted file itself in unified diff format.</para>
</listitem>
</varlistentry>
@@ -1130,7 +1131,7 @@
<term><computeroutput>(r)esolved</computeroutput></term>
<listitem>
- <para>After editing a file, choosing this command tells
+ <para>After editing a file, tell
<command>svn</command> that you've resolved the
conflicts in the file and that it should accept the
current contents—basically that you've
@@ -1175,7 +1176,7 @@
<term><computeroutput>(h)elp</computeroutput></term>
<listitem>
- <para>Shows the list of all possible commands you can use
+ <para>Show the list of all possible commands you can use
in interactive conflict resolution.</para>
</listitem>
@@ -1190,12 +1191,12 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.tour.cycle.resolve.diff">
- <title>Viewing Conflict Differences Interactively</title>
+ <title>Viewing conflict differences interactively</title>
<para>Before deciding how to attack a conflict interactively,
odds are that you'd like to see what exactly is in conflict,
- and the diff command (<command>d</command>) is what you'll
- use for this:</para>
+ and the <firstterm>diff</firstterm> command
+ (<command>d</command>) is what you'll use for this:</para>
<screen>
...
@@ -1205,7 +1206,7 @@
@@ -1 +1,5 @@
-Just buy a sandwich.
+<<<<<<< .mine
-+Go pickup a cheesesteak.
++Go pick up a cheesesteak.
+=======
+Bring me a taco!
+>>>>>>> .r32
@@ -1225,7 +1226,7 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.tour.cycle.resolve.resolve">
- <title>Resolving Conflict Differences Interactively</title>
+ <title>Resolving conflict differences interactively</title>
<para>There are four different ways to resolve conflicts
interactively—two of which allow you to selectively
@@ -1244,7 +1245,7 @@
merge tools instead.</para>
<para>In order to use a merge tool, you need to either set the
- <literal>SVN_MERGE</literal> environment variable, or define
+ <literal>SVN_MERGE</literal> environment variable or define
the <literal>merge-tool-cmd</literal> option in your
Subversion configuration file (see <xref
linkend="svn.advanced.confarea.opts"/> for more details).
@@ -1276,7 +1277,7 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.tour.cycle.resolve.pending">
- <title>Postponing Conflict Resolution</title>
+ <title>Postponing conflict resolution</title>
<para>This may sound like an appropriate section for avoiding
marital disagreements, but it's actually still about
@@ -1287,7 +1288,7 @@
<command>svn update</command>. 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
+ update</command>, and any file in conflict will be marked
with a <computeroutput>C</computeroutput>
automatically.</para>
@@ -1304,14 +1305,14 @@
<listitem>
<para>Subversion prints a <computeroutput>C</computeroutput>
- during the update, and remembers that the file is in a
+ during the update and remembers that the file is in a
state of conflict.</para>
</listitem>
<listitem>
<para>If Subversion considers the file to be mergeable, it
places <firstterm>conflict
- markers</firstterm>—special strings of text which
+ markers</firstterm>—special strings of text that
delimit the <quote>sides</quote> of the
conflict—into the file to visibly demonstrate the
overlapping areas. (Subversion uses the
@@ -1365,7 +1366,7 @@
</variablelist>
<para>Here <literal>OLDREV</literal> is the revision number
- of the file in your <filename>.svn</filename> directory
+ of the file in your <filename>.svn</filename> directory,
and <literal>NEWREV</literal> is the revision number of
the repository <literal>HEAD</literal>.</para>
</listitem>
@@ -1419,7 +1420,7 @@
</listitem>
<listitem>
- <para>Run <command>svn revert <filename></command>
+ <para>Run <command>svn revert <FILENAME></command>
to throw away all of your local changes.</para>
</listitem>
@@ -1427,7 +1428,7 @@
<para>Once you've resolved the conflict, you need to let
Subversion know by running <command>svn resolved</command>.
- This removes the three temporary files and Subversion no
+ This removes the three temporary files, and Subversion no
longer considers the file to be in a state of conflict.
<footnote>
<para>You can always remove the temporary files yourself,
@@ -1445,7 +1446,7 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.tour.cycle.resolve.byhand">
- <title>Merging Conflicts by Hand</title>
+ <title>Merging conflicts by hand</title>
<para>Merging conflicts by hand can be quite intimidating the
first time you attempt it, but with a little practice, it
@@ -1479,7 +1480,7 @@
</screen>
<para>The strings of less-than signs, equal signs, and
- greater-than signs are conflict markers, and are not part of
+ greater-than signs are conflict markers and are not part of
the actual data in conflict. You generally want to ensure
that those are removed from the file before your next
commit. The text between the first two sets of markers is
@@ -1540,8 +1541,8 @@
<para>Note that <command>svn resolved</command>, unlike most
of the other commands we deal with in this chapter, requires
- an argument. In any case, you want to be careful and only
- run <command>svn resolved</command> when you're certain that
+ an argument. In any case, you want to be careful and run
+ <command>svn resolved</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
the file even if it still contains conflict markers.</para>
@@ -1557,7 +1558,7 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.tour.cycle.resolve.copyover">
- <title>Copying a File Onto Your Working File</title>
+ <title>Copying a file onto your working file</title>
<para>If you get a conflict and decide that you want to throw
out your changes, you can merely copy one of the temporary
@@ -1578,9 +1579,9 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.tour.cycle.resolve.revert">
- <title>Punting: Using <command>svn revert</command></title>
+ <title>Punting: using <command>svn revert</command></title>
- <para>If you get a conflict, and upon examination decide that
+ <para>If you get a conflict and upon examination decide that
you want to throw out your changes and start your edits
again, just revert your changes:</para>
@@ -1641,7 +1642,6 @@
<xref linkend="svn.advanced.confarea.opts.config"/>) for composing a log
message.</para>
-
<tip>
<para>If you're in your editor writing a commit message and
decide that you want to cancel your commit, you can just
@@ -1661,17 +1661,17 @@
</tip>
<para>The repository doesn't know or care if your changes make
- any sense as a whole; it only checks to make sure that nobody
+ any sense as a whole; it checks only to make sure that nobody
else has changed any of the same files that you did when you
weren't looking. If somebody <emphasis>has</emphasis> done
that, the entire commit will fail with a message informing you
- that one or more of your files is out-of-date:</para>
+ that one or more of your files is out of date:</para>
<screen>
$ svn commit -m "Add another rule"
Sending rules.txt
svn: Commit failed (details follow):
-svn: Your file or directory 'sandwich.txt' is probably out-of-date
+svn: Your file or directory 'sandwich.txt' is probably out of date
…
</screen>
@@ -1702,14 +1702,14 @@
<title>Examining History</title>
<para>Your Subversion repository is like a time machine. It keeps
- a record of every change ever committed, and allows you to
+ a record of every change ever committed and allows you to
explore this history by examining previous versions of files and
directories as well as the metadata that accompanies them. With
a single Subversion command, you can check out the repository
(or restore an existing working copy) exactly as it was at any
date or revision number in the past. However, sometimes you
just want to <emphasis>peer into</emphasis> the past instead of
- <emphasis>going into</emphasis> the past.</para>
+ <emphasis>going into</emphasis> it.</para>
<para>There are several commands that can provide you with
historical data from the repository:</para>
@@ -1720,7 +1720,7 @@
<term><command>svn log</command></term>
<listitem>
<para>Shows you broad information: log messages with date
- and author information attached to revisions, and which
+ and author information attached to revisions and which
paths changed in each revision.</para>
</listitem>
</varlistentry>
@@ -1736,7 +1736,7 @@
<term><command>svn cat</command></term>
<listitem>
<para>Retrieves a file as it existed in a particular
- revision number and display it on your screen.</para>
+ revision number and displays it on your screen.</para>
</listitem>
</varlistentry>
@@ -1753,15 +1753,15 @@
<!-- =============================================================== -->
<sect2 id="svn.tour.history.log">
- <title>Generating a list of historical changes</title>
+ <title>Generating a List of Historical Changes</title>
<para>To find information about the history of a file or
directory, use the <command>svn log</command>
command. <command>svn log</command> will provide you with a
record of who made changes to a file or directory, at what
- revision it changed, the time and date of that revision, and,
- if it was provided, the log message that accompanied the
- commit.</para>
+ revision it changed, the time and date of that revision,
+ and—if it was provided—the log message that accompanied
+ the commit.</para>
<screen>
$ svn log
@@ -1783,7 +1783,7 @@
<para>Note that the log messages are printed in
<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
+ particular order or just a single revision, pass the
<option>--revision</option> (<option>-r</option>)
option:</para>
@@ -1820,16 +1820,16 @@
messages. This is due to a combination of the behavior of
<command>svn commit</command> and the default behavior of
<command>svn log</command>. First, when you commit changes
- to the repository, <command>svn</command> only bumps the
+ to the repository, <command>svn</command> bumps only the
revision of files (and directories) that it commits, so
usually the parent directory remains at the older revision
- (See <xref
- linkend="svn.basic.in-action.mixedrevs.update-commit"/> for
- why). <command>svn log</command> then defaults to fetching
- the history of the directory at its current revision, and
- thus you don't see the newly-committed changes. The
- solution here is to either update your working copy or
- explicitly provide a revision number to <command>svn
+ (See
+ <xref linkend="svn.basic.in-action.mixedrevs.update-commit"/>
+ for an explanation of why). <command>svn log</command> then
+ defaults to fetching the history of the directory at its
+ current revision, and thus you don't see the newly committed
+ changes. The solution here is to either update your working
+ copy or explicitly provide a revision number to <command>svn
log</command> by using the <option>--revision</option>
(<option>-r</option>) option.</para>
@@ -1840,7 +1840,7 @@
<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
+ 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>
@@ -1896,7 +1896,7 @@
<!-- =============================================================== -->
<sect2 id="svn.tour.history.diff">
- <title>Examining the details of historical changes</title>
+ <title>Examining the Details of Historical Changes</title>
<para>We've already seen <command>svn diff</command>
before—it displays file differences in unified diff
@@ -1910,7 +1910,7 @@
<itemizedlist>
<listitem>
- <para>Examining local changes</para>
+ <para>Examining Local Changes</para>
</listitem>
<listitem>
@@ -1925,7 +1925,7 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.tour.history.diff.local">
- <title>Examining Local Changes</title>
+ <title>Examining local changes</title>
<para>As we've seen, invoking <command>svn diff</command> with
no options will compare your working files to the cached
@@ -1952,7 +1952,7 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.tour.history.diff.wcrepos">
- <title>Comparing Working Copy to Repository</title>
+ <title>Comparing working copy to repository</title>
<para>If a single <option>--revision</option>
(<option>-r</option>) number is passed, then your
@@ -1979,12 +1979,12 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.tour.history.diff.reposrepos">
- <title>Comparing Repository to Repository</title>
+ <title>Comparing repository to repository</title>
<para>If two revision numbers, separated by a colon, are
passed via <option>--revision</option>
(<option>-r</option>), then the two revisions are directly
- compared.</para>
+ compared:</para>
<screen>
$ svn diff -r 2:3 rules.txt
@@ -2036,7 +2036,7 @@
<!-- =============================================================== -->
<sect2 id="svn.tour.history.browsing">
- <title>Browsing the repository</title>
+ <title>Browsing the Repository</title>
<para>Using <command>svn cat</command> and <command>svn
list</command>, you can view various revisions of files and
@@ -2111,7 +2111,7 @@
<para>The <command>svn list</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 wanted a
+ local working copy directory. After all, if you want a
listing of your local directory, you could use just plain
<command>ls</command> (or any reasonable non-Unixy
equivalent).</para>
@@ -2123,16 +2123,16 @@
<!-- =============================================================== -->
<sect2 id="svn.tour.history.snapshots">
- <title>Fetching older repository snapshots</title>
+ <title>Fetching Older Repository Snapshots</title>
- <para>In addition to all of the above commands, you can use
+ <para>In addition to all of the previous commands, you can use
<command>svn update</command> and <command>svn
checkout</command> with the <option>--revision</option> option
- to take an entire working copy <quote>back in time</quote>
+ to take an entire working copy <quote>back in time</quote>:
<footnote>
<para>See? We told you that Subversion was a time machine.</para>
</footnote>
- :</para>
+ </para>
<screen>
$ svn checkout -r 1729 # Checks out a new working copy at r1729
@@ -2142,7 +2142,7 @@
</screen>
<tip>
- <para>Many Subversion newcomers attempt to use the above
+ <para>Many Subversion newcomers attempt to use the preceding
<command>svn update</command> example to <quote>undo</quote>
committed changes, but this won't work as you can't commit
changes that you obtain from backdating a working copy if
@@ -2181,6 +2181,11 @@
<sect1 id="svn.tour.cleanup">
<title>Sometimes You Just Need to Clean Up</title>
+ <para>Now that we've covered the day-to-day tasks that you'll
+ frequently use Subversion for, we'll review a few administrative
+ tasks relating to your working copy.</para>
+
+
<sect2 id="svn.tour.cleanup.disposal">
<title>Disposing of a Working Copy</title>
@@ -2210,19 +2215,19 @@
<sect2 id="svn.tour.cleanup.interruption">
- <title>Recovering From an Interruption</title>
+ <title>Recovering from an Interruption</title>
<para>When Subversion modifies your working copy (or any
information within <filename>.svn</filename>), it tries to do
so as safely as possible. Before changing the working copy,
- Subversion writes its intentions to a log file. Next it
+ Subversion writes its intentions to a log file. Next, it
executes the commands in the log file to apply the requested
change, holding a lock on the relevant part of the working
copy while it works—to prevent other Subversion clients
- from accessing the working copy in mid-change. Finally,
+ from accessing the working copy mid-change. Finally,
Subversion removes the log file. Architecturally, this is
similar to a journaled filesystem. If a Subversion operation
- is interrupted (if the process is killed, or if the machine
+ is interrupted (if the process is killed or if the machine
crashes, for example), the log files remain on disk. By
re-executing the log files, Subversion can complete the
previously started operation, and your working copy can get
@@ -2232,7 +2237,7 @@
does: it searches your working copy and runs any leftover
logs, removing working copy locks in the process.
If Subversion ever tells you that some part of your working copy
- is <quote>locked</quote>, then this is the command that you
+ is <quote>locked,</quote> then this is the command that you
should run. Also, <command>svn status</command> will display
an <literal>L</literal> next to locked items:</para>
More information about the svnbook-dev
mailing list