[svnbook commit] r3058 - trunk/src/de/book
khmarbaise
noreply at red-bean.com
Sun May 4 06:57:33 CDT 2008
Author: khmarbaise
Date: Sun May 4 06:57:32 2008
New Revision: 3058
Log:
src/de/book/ch00-preface.xml
src/de/book/ch02-basic-usage.xml
src/de/book/ch03-advanced-topics.xml
src/de/book/ch04-branching-and-merging.xml
src/de/book/ch06-server-configuration.xml
src/de/book/ch07-customizing-svn.xm
src/de/book/ch09-reference.xml
src/de/book/appa-quickstart.xml
src/de/book/appb-svn-for-cvs-users.xml
- merged the changes from the english book into
current translation area.
/trunk/src/en/book (r3029-3055).
Modified:
trunk/src/de/book/appa-quickstart.xml
trunk/src/de/book/appb-svn-for-cvs-users.xml
trunk/src/de/book/ch00-preface.xml
trunk/src/de/book/ch02-basic-usage.xml
trunk/src/de/book/ch03-advanced-topics.xml
trunk/src/de/book/ch04-branching-and-merging.xml
trunk/src/de/book/ch06-server-configuration.xml
trunk/src/de/book/ch07-customizing-svn.xml
trunk/src/de/book/ch09-reference.xml
Modified: trunk/src/de/book/appa-quickstart.xml
==============================================================================
--- trunk/src/de/book/appa-quickstart.xml (original)
+++ trunk/src/de/book/appa-quickstart.xml Sun May 4 06:57:32 2008
@@ -81,7 +81,8 @@
subdirectory thereof called <literal>trunk</literal>. See
our discussion of Subversion's branching and tagging model
for the reasoning behind this.</para>
- </footnote></para>
+ </footnote>
+ </para>
<screen>
$ svn checkout http://svn.collab.net/repos/svn/trunk subversion
Modified: trunk/src/de/book/appb-svn-for-cvs-users.xml
==============================================================================
--- trunk/src/de/book/appb-svn-for-cvs-users.xml (original)
+++ trunk/src/de/book/appb-svn-for-cvs-users.xml Sun May 4 06:57:32 2008
@@ -363,10 +363,12 @@
(<literal>http://svn.example.com/repos/calc/</literal>). If
you make the mistake of checking out the project itself,
you'll wind up with a working copy that contains a copy of
- your project for every branch and tag you
- have.<footnote><para>That is, providing you don't run out of
- disk space before your checkout
- finishes.</para></footnote></para>
+ your project for every branch and tag you have.
+ <footnote>
+ <para>That is, providing you don't run out of disk space
+ before your checkout finishes.</para>
+ </footnote>
+ </para>
</warning>
</sect1>
Modified: trunk/src/de/book/ch00-preface.xml
==============================================================================
--- trunk/src/de/book/ch00-preface.xml (original)
+++ trunk/src/de/book/ch00-preface.xml Sun May 4 06:57:32 2008
@@ -838,9 +838,12 @@
a risky and ambitious new Open Source project; Jim Blandy for
the original Subversion name and design—we love you, Jim;
Karl Fogel for being such a good friend and a great community
- leader, in that order.<footnote><para>Oh, and thanks, Karl, for
- being too overworked to write this book yourself.</para>
- </footnote></para>
+ leader, in that order.
+ <footnote>
+ <para>Oh, and thanks, Karl, for being too overworked to write
+ this book yourself.</para>
+ </footnote>
+ </para>
-->
<para>Dieses Buch wäre nicht möglich (und auch nicht sehr
@@ -1265,10 +1268,12 @@
packages. The problem is, this sort of data usually isn't
changing at all. The collection itself grows over time, but
the individual files within the collection aren't being
- changed. In this case, using Subversion is
- "overkill".<footnote><para>Or as a friend puts
- it, <quote>swatting a fly with a
- Buick.</quote></para></footnote> There are simpler tools that
+ changed. In this case, using Subversion is "overkill".
+ <footnote>
+ <para>Or as a friend puts it, <quote>swatting a fly with a
+ Buick.</quote></para>
+ </footnote>
+ There are simpler tools that
efficiently replicate data <emphasis>without</emphasis> the
overhead of tracking changes, such as <command>rsync</command>
or <command>unison</command>.</para>
Modified: trunk/src/de/book/ch02-basic-usage.xml
==============================================================================
--- trunk/src/de/book/ch02-basic-usage.xml (original)
+++ trunk/src/de/book/ch02-basic-usage.xml Sun May 4 06:57:32 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
@@ -325,18 +325,21 @@
authentication credentials on disk. This is done for
convenience, so that you don't have to continually re-enter
your password for future operations. If you're concerned
- about caching your Subversion passwords,<footnote><para>Of
- course, you're not terribly worried—first 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 you have, right? Right?</para></footnote>
+ about caching your Subversion passwords,
+ <footnote>
+ <para>Of course, you're not terribly worried—first
+ 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 3 million passwords
+ you have, right? Right?</para>
+ </footnote>
you can disable caching either permanently or on a
case-by-case basis.</para>
<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
@@ -351,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>
@@ -367,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>
@@ -387,7 +390,7 @@
</listitem>
<listitem>
- <para>Make changes</para>
+ <para>Make changes.</para>
<itemizedlist>
<listitem>
<para><command>svn add</command></para>
@@ -405,7 +408,7 @@
</listitem>
<listitem>
- <para>Examine your changes</para>
+ <para>Examine your changes.</para>
<itemizedlist>
<listitem>
<para><command>svn status</command></para>
@@ -417,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>
@@ -427,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>
@@ -439,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">
@@ -456,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
@@ -474,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>
@@ -495,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
@@ -508,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>
@@ -525,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
@@ -537,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>
@@ -548,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>
@@ -567,14 +570,17 @@
you commit your changes, <filename>foo</filename> will
be entirely removed from your working copy and the
repository.
- <footnote><para>Of course, nothing is ever totally
- deleted from the repository—just from the
- <literal>HEAD</literal> of the repository. You can get
- back anything you delete by checking out (or updating
- your working copy to) a revision earlier than the one in
- which you deleted it. Also see
- <xref linkend="svn.branchmerge.advanced.resurrect"/>.
- </para></footnote></para>
+ <footnote>
+ <para>Of course, nothing is ever totally deleted from
+ the repository—just from the
+ <literal>HEAD</literal> of the repository. You can
+ get back anything you delete by checking out (or
+ updating your working copy to) a revision earlier
+ than the one in which you deleted it. Also see <xref
+ linkend="svn.branchmerge.advanced.resurrect"
+ />.</para>
+ </footnote>
+ </para>
</listitem>
</varlistentry>
@@ -624,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>
@@ -671,9 +677,12 @@
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.<footnote><para>And
- also that you don't have a WAN card. Thought you got us,
- huh?</para></footnote></para>
+ 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>
+ </footnote>
+ </para>
<para>Subversion does this by keeping private caches of
pristine versions of each versioned file inside of the
@@ -693,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>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
@@ -745,7 +754,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
@@ -827,7 +836,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>
@@ -837,7 +846,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
@@ -856,13 +865,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>
@@ -922,12 +931,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
@@ -977,7 +986,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
@@ -1059,11 +1068,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>
...
@@ -1085,8 +1095,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>
@@ -1098,7 +1108,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>
@@ -1120,7 +1130,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
@@ -1165,7 +1175,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>
@@ -1180,12 +1190,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>
...
@@ -1195,7 +1205,7 @@
@@ -1 +1,5 @@
-Just buy a sandwich.
+<<<<<<< .mine
-+Go pickup a cheesesteak.
++Go pick up a cheesesteak.
+=======
+Bring me a taco!
+>>>>>>> .r32
@@ -1215,7 +1225,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
@@ -1234,7 +1244,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).
@@ -1266,7 +1276,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
@@ -1277,7 +1287,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>
@@ -1294,14 +1304,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
@@ -1355,7 +1365,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>
@@ -1409,7 +1419,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>
@@ -1417,12 +1427,14 @@
<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
- longer considers the file to be in a state of
- conflict.<footnote><para>You can always remove the temporary
- files yourself, but would you really want to do that when
- Subversion can do it for you? We didn't think so.</para>
- </footnote></para>
+ 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,
+ but would you really want to do that when Subversion can
+ do it for you? We didn't think so.</para>
+ </footnote>
+ </para>
<screen>
$ svn resolved sandwich.txt
@@ -1433,7 +1445,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
@@ -1467,7 +1479,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
@@ -1497,11 +1509,13 @@
surprised when the sandwich arrives and it's not what she
wanted. So this is where you pick up the phone or walk
across the office and explain to Sally that you can't get
- sauerkraut from an Italian deli.<footnote><para>And if you
- ask them for it, they may very well ride you out of town on
- a rail.</para></footnote> Once you've agreed on the changes
- you will check in, edit your file and remove the conflict
- markers.</para>
+ sauerkraut from an Italian deli.
+ <footnote>
+ <para>And if you ask them for it, they may very well ride
+ you out of town on a rail.</para>
+ </footnote>
+ Once you've agreed on the changes you will check in, edit
+ your file and remove the conflict markers.</para>
<screen>
Top piece of bread
@@ -1526,8 +1540,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>
@@ -1543,7 +1557,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
@@ -1564,9 +1578,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>
@@ -1627,7 +1641,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
@@ -1647,17 +1660,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>
@@ -1688,14 +1701,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>
@@ -1706,7 +1719,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>
@@ -1722,7 +1735,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>
@@ -1739,15 +1752,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
@@ -1769,7 +1782,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>
@@ -1806,16 +1819,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>
@@ -1826,7 +1839,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>
@@ -1882,7 +1895,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
@@ -1896,7 +1909,7 @@
<itemizedlist>
<listitem>
- <para>Examining local changes</para>
+ <para>Examining Local Changes</para>
</listitem>
<listitem>
@@ -1911,7 +1924,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
@@ -1938,7 +1951,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
@@ -1965,12 +1978,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
@@ -2022,7 +2035,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
@@ -2097,7 +2110,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>
@@ -2109,14 +2122,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>
- <footnote><para>See? We told you that Subversion was a time
- machine.</para></footnote>:</para>
+ 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>
<screen>
$ svn checkout -r 1729 # Checks out a new working copy at r1729
@@ -2126,7 +2141,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
@@ -2165,6 +2180,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>
@@ -2194,19 +2214,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
@@ -2216,7 +2236,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>
Modified: trunk/src/de/book/ch03-advanced-topics.xml
==============================================================================
--- trunk/src/de/book/ch03-advanced-topics.xml (original)
+++ trunk/src/de/book/ch03-advanced-topics.xml Sun May 4 06:57:32 2008
@@ -92,7 +92,7 @@
<para>The Subversion client understands a number of revision
keywords. These keywords can be used instead of integer
arguments to the <option>--revision</option>
- (<option>-r</option>) switch, and are resolved into specific
+ (<option>-r</option>) option, and are resolved into specific
revision numbers by Subversion:</para>
<variablelist>
@@ -475,7 +475,7 @@
<para>But we've been touting the flexibility that Subversion
offers for your property values. And if you are planning to
- have a multi-line textual, or even binary, property value, you
+ 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
<option>--file</option> (<option>-F</option>) option for
@@ -1834,7 +1834,7 @@
</screen>
<para>Now, let's check out the same tree again, but this time,
- we'll ask Subversion to give us only the top-most direcectory
+ we'll ask Subversion to give us only the top-most directory
with none of its children at all:</para>
<screen>
@@ -3629,7 +3629,7 @@
<para>Subversion's changelist feature is a handy tool for
grouping working copy files, but it does have a few limitations.
Changelists are artifacts of a particular working copy, which
- means that changelist assignments cannot be propogated to the
+ means that changelist assignments cannot be propagated to the
repository or otherwise shared with other users. Changelists
can only be assigned to files—Subversion doesn't
currently support the use of changelists with directories.
Modified: trunk/src/de/book/ch04-branching-and-merging.xml
==============================================================================
--- trunk/src/de/book/ch04-branching-and-merging.xml (original)
+++ trunk/src/de/book/ch04-branching-and-merging.xml Sun May 4 06:57:32 2008
@@ -500,7 +500,7 @@
you use an issue tracker to manage bugs, you can use the
revision numbers to refer to particular patches that fix
bugs—for example,
- <quote>this issue was fixed by revision 9238.</quote> Somebody
+ <quote>this issue was fixed by r9238.</quote> Somebody
can then run <command>svn log -r 9238</command> to read about
the exact changeset that fixed the bug, and run
<command>svn diff -c 9238</command> to see the patch itself.
@@ -509,7 +509,7 @@
revision numbers. You can merge specific changesets from one
branch to another by naming them in the merge
arguments: <command>svn merge -c 9238</command> would merge
- changeset #9238 into your working copy.</para>
+ changeset r9238 into your working copy.</para>
</sect2>
@@ -525,8 +525,8 @@
project's <filename>/trunk</filename>. It's in your best
interest to replicate those changes to your own branch, just
to make sure they mesh well with your changes. In fact, this
- is a best practice: by frequently keeping your branch in sync
- with the main development line, it helps
+ is a best practice: frequently keeping your branch in sync
+ with the main development line helps
prevent <quote>surprise</quote> conflicts when it comes time
for you to fold your changes back into the trunk.</para>
@@ -571,7 +571,7 @@
changes by running <command>svn revert</command> and start a
long <quote>what's going on?</quote> discussion with your
collaborators. If things look good, however, then you can
- submit your changes into the repository:</para>
+ submit these changes into the repository:</para>
<screen>
$ svn commit -m "Merged latest trunk changes to my-calc-branch."
@@ -702,6 +702,9 @@
$ pwd
/home/user/calc-trunk
+$ svn update # (just to make sure the working copy is at latest everywhere)
+At revision 390.
+
$ svn merge --reintegrate http://svn.example.com/repos/calc/branches/my-calc-branch
--- Merging r341 through r390 into '.':
U button.c
@@ -725,8 +728,9 @@
back</quote> is a different sort of work than what you've been
doing up until now. Previously, we had been
asking <command>svn merge</command> to grab the <quote>next
- set</quote> of changes from one branch and duplicate them to
- another. This is fairly straightforward, and each time
+ set</quote> of changes from one line of development (the
+ trunk) and duplicate them to another (your branch). This is
+ fairly straightforward, and each time
Subversion knows how to pick up where it left off. In our
prior examples, you can see that first it merges the ranges
345:356 from trunk to branch; later on, it continues by
@@ -747,8 +751,7 @@
<para>Now that your branch is merged to trunk, you'll no longer
need your branch. You can destroy your working copy of the
- branch, and also do some basic housecleaning in the
- repository:</para>
+ branch, and also remove it from the repository:</para>
<screen>
$ svn delete http://svn.example.com/repos/calc/branches/my-calc-branch
@@ -800,7 +803,7 @@
its value indicates which changes have already been replicated
into a particular directory.</para>
- <para>As we saw earlier, there's also a subcommand <command>svn
+ <para>There's also a subcommand <command>svn
mergeinfo</command>, which can be helpful in seeing not only
which changesets a directory has absorbed, but also which
changesets it's still eligible to receive. This gives a sort
@@ -1012,21 +1015,24 @@
<warning>
<para>Did you notice how, in the last example, the merge
- invocation caused two distinct ranges of merges to be applied?
- The <command>svn merge</command> command applied two
- independent patches to your working copy in order to skip over
- changeset 355, which your branch already contained. There's
- nothing inherently wrong with this, except that it has the
- potential to make conflict resolution more tricky. If the
- first range of changes creates conflicts,
- you <emphasis>must</emphasis> resolve them interactively in
- order for the merge process to continue and apply the second
- range of changes. If you postpone a conflict from the first
- wave of changes, the whole merge command will bail out with an
- error message.<footnote><para>At least, this is true in
- Subversion 1.5 at the time of writing. This behavior may
- improve in future versions of
- Subversion.</para></footnote></para>
+ invocation caused two distinct ranges of merges to be
+ applied? The <command>svn merge</command> command applied
+ two independent patches to your working copy in order to
+ skip over changeset 355, which your branch already
+ contained. There's nothing inherently wrong with this,
+ except that it has the potential to make conflict resolution
+ more tricky. If the first range of changes creates
+ conflicts, you <emphasis>must</emphasis> resolve them
+ interactively in order for the merge process to continue and
+ apply the second range of changes. If you postpone a
+ conflict from the first wave of changes, the whole merge
+ command will bail out with an error message.
+ <footnote>
+ <para>At least, this is true in Subversion 1.5 at the time
+ of writing. This behavior may improve in future
+ versions of Subversion.</para>
+ </footnote>
+ </para>
</warning>
<para>A word of warning: while <command>svn diff</command> and
@@ -1931,7 +1937,8 @@
abandon an existing working copy. See <xref
linkend="svn.ref.svn.c.switch"/> for more information and an
example.</para>
- </footnote></para>
+ </footnote>
+ </para>
<sidebar>
<title>Switches and Updates</title>
@@ -1946,7 +1953,7 @@
and then sends a description of the differences back to the
client. The only difference between <command>svn
switch</command> and <command>svn update</command> is that the
- latter command always compares two identical repositoryx
+ latter command always compares two identical repository
paths.</para>
<para>That is, if your working copy is a mirror of
Modified: trunk/src/de/book/ch06-server-configuration.xml
==============================================================================
--- trunk/src/de/book/ch06-server-configuration.xml (original)
+++ trunk/src/de/book/ch06-server-configuration.xml Sun May 4 06:57:32 2008
@@ -442,7 +442,7 @@
<!-- ================================================================= -->
<sect1 id="svn.serverconfig.svnserve">
- <title>svnserve, a custom server</title>
+ <title><command>svnserve</command>, a Custom Server</title>
<para>The <command>svnserve</command> program is a lightweight
server, capable of speaking to clients over TCP/IP using a
@@ -734,9 +734,12 @@
</itemizedlist>
- <para>The <command>svnserve</command> server, by default, only
- knows how to send a CRAM-MD5 <footnote><para>See RFC
- 2195.</para></footnote> authentication challenge. In essence,
+ <para>The <command>svnserve</command> server, by default, knows
+ only how to send a CRAM-MD5
+ <footnote>
+ <para>See RFC 2195.</para>
+ </footnote>
+ authentication challenge. In essence,
the server sends a small amount of data to the client. The
client uses the MD5 hash algorithm to create a fingerprint of
the data and password combined, then sends the fingerprint as
@@ -907,18 +910,18 @@
options available to you.</para>
<sidebar>
- <title>What is SASL?</title>
+ <title>What Is SASL?</title>
<para>The Cyrus Simple Authentication and Security Layer is
- open-source software written by Carnegie Mellon University.
+ open source software written by Carnegie Mellon University.
It adds generic authentication and encryption capabilities
to any network protocol, and as of Subversion 1.5 and later,
both the <command>svnserve</command> server
and <command>svn</command> client know how to make use of
this library. It may or may not be available to you: if
you're building Subversion yourself, you'll need to have at
- least version 2.1 of SASL installed on your system and
+ least version 2.1 of SASL installed on your system, and
you'll need to make sure that it's detected during
- Subversion's build process. If you're using a pre-built
+ Subversion's build process. If you're using a prebuilt
Subversion binary package, you'll have to check with the
package maintainer as to whether SASL support was compiled
in. SASL comes with a number of pluggable modules that
@@ -933,22 +936,22 @@
<ulink url="http://asg.web.cmu.edu/sasl/sasl-library.html"/>.</para>
</sidebar>
- <para>Normally, when a subversion client connects
- to <command>svnserve</command>, the server sends a greeting
- which advertises a list of capabilities it supports, and the
+ <para>Normally, when a subversion client connects to
+ <command>svnserve</command>, the server sends a greeting that
+ advertises a list of the capabilities it supports, and the
client responds with a similar list of capabilities. If the
server is configured to require authentication, it then sends
- a challenge which lists the authentication mechanisms
+ a challenge that lists the authentication mechanisms
available; the client responds by choosing one of the
mechanisms, and then authentication is carried out in some
number of roundtrip messages. Even when SASL capabilities
aren't present, the client and server inherently know how to
- use the CRAM-MD5 and ANONYMOUS mechanisms (see
- <xref linkend="svn.serverconfig.svnserve.auth"/>). If server
- and client were linked against SASL, then a number of other
- authentication mechanisms may also be available. However,
- you'll need to explicitly configure SASL on the server-side to
- advertise them.</para>
+ use the CRAM-MD5 and ANONYMOUS mechanisms (see the earlier
+ section <xref linkend="svn.serverconfig.svnserve.auth"/>). If
+ server and client were linked against SASL, then a number of
+ other authentication mechanisms may also be available.
+ However, you'll need to explicitly configure SASL on the
+ server side to advertise them.</para>
<sect3 id="svn.serverconfig.svnserve.sasl.authn">
<title>Authenticating with SASL</title>
@@ -959,15 +962,15 @@
repository's <filename>svnserve.conf</filename> file, with
this key-value pair:</para>
- <screen>
+ <programlisting>
use-sasl = true
-</screen>
+</programlisting>
<para>Second, create a file
called <filename>subversion.conf</filename> in a place where
the SASL library can find it—typically in the
- directory where SASL plugins are located. You'll have to
- locate the plugin directory on your particular system, such
+ directory where SASL plug-ins are located. You'll have to
+ locate the plug-in directory on your particular system, such
as <filename>/usr/lib/sasl2/</filename>
or <filename>/etc/sasl2/</filename>. (Note that this
is <emphasis>not</emphasis>
@@ -975,29 +978,29 @@
within a repository!)</para>
<para>On a Windows server, you'll have to also edit the
- registry (using a tool like <command>regedit</command>) to
- tell SASL where to find things. Create a registry key
+ registry (using a tool such as <command>regedit</command>)
+ to tell SASL where to find things. Create a registry key
named <literal>[HKEY_LOCAL_MACHINE\SOFTWARE\Carnegie
Mellon\Project Cyrus\SASL Library]</literal>, and place two
keys inside it: a key called <literal>SearchPath</literal>
- (whose value is a path containing the
- SASL <filename>.dll</filename> plugins), and a key
- called <literal>ConfFile</literal> (whose value is a path
+ (whose value is a path containing the SASL
+ <filename>.dll</filename> plug-ins), and a key called
+ <literal>ConfFile</literal> (whose value is a path
containing the <filename>subversion.conf</filename>
- file.)</para>
+ file).</para>
<para>Because SASL provides so many different kinds of
authentication mechanisms, it would be foolish (and far
beyond the scope of this book) to try and describe every
possible server-side configuration. Instead, we recommend
- that you read the documentation supplied in
- the <filename>doc/</filename> subdirectory of the SASL
- source code. It goes into great detail about each mechanism
- and how to configure the server appropriately for each. For
- the purposes of this discussion, we'll just demonstrate a
- simple example of configuring the DIGEST-MD5 mechanism. For
+ that you read the documentation supplied in the
+ <filename>doc/</filename> subdirectory of the SASL source
+ code. It goes into great detail about every mechanism and
+ how to configure the server appropriately for each. For the
+ purposes of this discussion, we'll just demonstrate a simple
+ example of configuring the DIGEST-MD5 mechanism. For
example, if your <filename>subversion.conf</filename>
- contains:</para>
+ contains the following:</para>
<screen>
pwcheck_method: auxprop
@@ -1005,13 +1008,13 @@
mech_list: DIGEST-MD5
</screen>
- <para>...then you've told SASL to advertise the DIGEST-MD5
- mechanism to clients, and to check user passwords against a
- private password database (typically stored
- in <filename>/etc/sasldb2</filename>). A system
- administrator can then use
- the <command>saslpasswd2</command> program to add or modify
- usernames and passwords in the database:</para>
+ <para>then you've told SASL to advertise the DIGEST-MD5
+ mechanism to clients and to check user passwords against a
+ private password database (typically stored in
+ <filename>/etc/sasldb2</filename>). A system administrator
+ can then use the <command>saslpasswd2</command> program to
+ add or modify usernames and passwords in the
+ database:</para>
<screen>
$ saslpasswd2 -c -u realm username
@@ -1027,16 +1030,17 @@
standard SASL password database, make sure that
the <command>svnserve</command> program has read access to
the file (and possibly write access as well, if you're using
- a mechanism such as OTP.)</para>
+ a mechanism such as OTP).</para>
<para>This is just one simple way of configuring SASL. Many
- other authentication mechanisms available, and passwords can
- be stored in other places such as in LDAP or a SQL database.
- Consult the full SASL documentation for details.</para>
+ other authentication mechanisms are available, and passwords
+ can be stored in other places such as in LDAP or a SQL
+ database. Consult the full SASL documentation for
+ details.</para>
<para>Remember that if you configure your server to only allow
- certain SASL authentication mechanisms, this can also have
- the effect of forcing all of connecting clients to have SASL
+ certain SASL authentication mechanisms, this can have the
+ effect of forcing all of connecting clients to have SASL
support as well. Any Subversion client built without SASL
support (which includes all pre-1.5 clients) will be unable
to authenticate. On the one hand, this sort of restriction
@@ -1049,15 +1053,15 @@
</sect3>
<sect3 id="svn.serverconfig.svnserve.sasl.encryption">
- <title>SASL Encryption</title>
+ <title>SASL encryption</title>
- <para>SASL is also able to perform data-encryption if a
+ <para>SASL is also able to perform data encryption if a
particular mechanism supports it. The built-in CRAM-MD5
mechanism doesn't support encryption, but DIGEST-MD5 does,
- and mechanisms like SRP actually require use of the OpenSSL
- library . To enable or disable different levels of
- encryption, you can set two values in your
- repository's <filename>svnserve.conf</filename> file:</para>
+ and mechanisms such as SRP actually require use of the
+ OpenSSL library. To enable or disable different levels of
+ encryption, you can set two values in your repository's
+ <filename>svnserve.conf</filename> file:</para>
<screen>
[sasl]
@@ -1066,17 +1070,17 @@
max-encryption = 256
</screen>
- <para>The <literal>min-encryption</literal>
- and <literal>max-encryption</literal> variables control the
+ <para>The <literal>min-encryption</literal> and
+ <literal>max-encryption</literal> variables control the
level of encryption demanded by the server. To disable
encryption completely, set both values to 0. To enable
- simple checksumming of data (i.e. prevent tampering and
+ simple checksumming of data (i.e., prevent tampering and
guarantee data integrity without encryption), set both
values to 1. If you wish to allow—but not
require—encryption, set the minimum value to 0, and
the maximum value to some bit-length. To require encryption
unconditionally, set both values to numbers greater than 1.
- In our example above, we require clients to do at least
+ In our previous example, we require clients to do at least
128-bit encryption, but no more than 256-bit
encryption.</para>
@@ -1120,13 +1124,13 @@
<command>svnserve</command> process on the remote machine
running as the user <literal>harry</literal>. The
<command>svnserve</command> command is being invoked in tunnel
- mode (<option>-t</option>) and its network protocol is being
+ mode (<option>-t</option>), and its network protocol is being
<quote>tunneled</quote> over the encrypted connection by
- <command>ssh</command>, the tunnel-agent.
+ <command>ssh</command>, the tunnel agent.
<command>svnserve</command> is aware that it's running as the
user <literal>harry</literal>, and if the client performs a
- commit, the authenticated username will be used as the
- author of the new revision.</para>
+ commit, the authenticated username will be used as the author
+ of the new revision.</para>
<para>The important thing to understand here is that the
Subversion client is <emphasis>not</emphasis> connecting to a
@@ -1141,7 +1145,7 @@
repository, remember that it's the <command>ssh</command>
program prompting for authentication, and
<emphasis>not</emphasis> the <command>svn</command> client
- program. That means there's no automatic password caching
+ program. That means there's no automatic password-caching
going on (see <xref linkend="svn.serverconfig.netmodel.credcache"/>). The
Subversion client often makes multiple connections to the
repository, though users don't normally notice this due to the
@@ -1149,7 +1153,7 @@
<literal>svn+ssh://</literal> URLs, however, users may be
annoyed by <command>ssh</command> repeatedly asking for a
password for every outbound connection. The solution is to
- use a separate SSH password-caching tool like
+ use a separate SSH password-caching tool such as
<command>ssh-agent</command> on a Unix-like system, or
<command>pageant</command> on Windows.</para>
@@ -1160,27 +1164,24 @@
<literal>file://</literal> URL. If multiple system users are
going to be accessing the repository directly, you may want to
place them into a common group, and you'll need to be careful
- about umasks. (Be sure to read <xref
- linkend="svn.serverconfig.multimethod"/>.) But even in the case of
- tunneling, the <filename>svnserve.conf</filename> file can
- still be used to block access, by simply setting
- <literal>auth-access = read</literal> or <literal>auth-access
- = none</literal>.
- <footnote>
- <para>Note that using any sort
- of <command>svnserve</command>-enforced access control at
- all is a bit pointless; the user already has direct access to
- the repository database.</para>
- </footnote>
- </para>
+ about umasks (be sure to read <xref
+ linkend="svn.serverconfig.multimethod"/> later in this
+ chapter). But even in the case of tunneling, the
+ <filename>svnserve.conf</filename> file can still be used to
+ block access, by simply setting <literal>auth-access =
+ read</literal> or <literal>auth-access = none</literal>.
+ <footnote> <para>Note that using any sort of
+ <command>svnserve</command>-enforced access control at all is
+ a bit pointless; the user already has direct access to the
+ repository database.</para> </footnote> </para>
<para>You'd think that the story of SSH tunneling would end
here, but it doesn't. Subversion allows you to create custom
- tunnel behaviors in your run-time <filename>config</filename>
- file (see <xref linkend="svn.advanced.confarea"/>). For example,
- suppose you want to use RSH instead of SSH<footnote><para>We
- don't actually recommend this, since RSH is notably less
- secure than SSH.</para></footnote>. In the
+ tunnel behaviors in your runtime <filename>config</filename>
+ file (see <xref linkend="svn.advanced.confarea"/>.) For
+ example, suppose you want to use RSH instead of SSH.
+ <footnote> <para>We don't actually recommend this, since RSH
+ is notably less secure than SSH.</para> </footnote> In the
<literal>[tunnels]</literal> section of your
<filename>config</filename> file, simply define it like
this:</para>
@@ -1196,7 +1197,7 @@
URL scheme, the Subversion client will actually be running the
command <command>rsh host svnserve -t</command> behind the
scenes. If you include a username in the URL (for example,
- <literal>svn+rsh://username@host/path</literal>) the client
+ <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
tunneling schemes to be much more clever than that:</para>
@@ -1214,7 +1215,7 @@
<literal>svn+joessh://</literal> URL would invoke the
particular SSH binary with <option>-p 29934</option> as
arguments—useful if you want the tunnel program to
- connect to a non-standard port.</para>
+ connect to a nonstandard port.</para>
<para>Second, it shows how to define a custom environment
variable that can override the name of the tunneling program.
@@ -1305,9 +1306,9 @@
<para>In this example, <filename>/path/to/svnserve</filename>
might be a custom wrapper script
around <command>svnserve</command> which sets the umask (see
- <xref linkend="svn.serverconfig.multimethod"/>). It also shows how to
- anchor <command>svnserve</command> in a virtual root
- directory, just as one often does when
+ <xref linkend="svn.serverconfig.multimethod"/>.) It also
+ shows how to anchor <command>svnserve</command> in a virtual
+ root directory, just as one often does when
running <command>svnserve</command> as a daemon process.
This might be done either to restrict access to parts of the
system, or simply to relieve the user of having to type an
@@ -1316,7 +1317,7 @@
<para>It's also possible to have multiple users share a single
account. Instead of creating a separate system account for
- each user, generate a public/private keypair for each
+ each user, generate a public/private key-pair for each
person. Then place each public key into
the <filename>authorized_users</filename> file, one per
line, and use the <option>--tunnel-user</option>
@@ -1342,7 +1343,7 @@
other forms of SSH access, even if you've set
the <literal>command</literal> value
in <filename>authorized_keys</filename>. For example, the
- user may still get shell access through SSH, or be able to
+ user may still get shell access through SSH or be able to
perform X11 or general port-forwarding through your server.
To give the user as little permission as possible, you may
want to specify a number of restrictive options immediately
@@ -1374,7 +1375,7 @@
<!-- ================================================================= -->
<sect1 id="svn.serverconfig.httpd">
- <title>httpd, the Apache HTTP server</title>
+ <title>httpd, the Apache HTTP Server</title>
<para>The Apache HTTP Server is a <quote>heavy duty</quote>
network server that Subversion can leverage. Via a custom
@@ -1386,13 +1387,11 @@
writing—specifically, versioned
writing—capabilities. The result is a standardized,
robust system that is conveniently packaged as part of the
- Apache 2.0 software, is supported by numerous operating systems
+ Apache 2.0 software, supported by numerous operating systems
and third-party products, and doesn't require network
- administrators to open up yet another custom port.
- <footnote>
- <para>They really hate doing that.</para>
- </footnote>
- While an Apache-Subversion server has more features than
+ administrators to open up yet another custom port.<footnote>
+ <para>They really hate doing that.</para></footnote> While an
+ Apache-Subversion server has more features than
<command>svnserve</command>, it's also a bit more difficult
to set up. With flexibility often comes more complexity.</para>
@@ -1400,9 +1399,10 @@
Apache configuration directives. While some examples are given
of the use of these directives, describing them in full is
outside the scope of this chapter. The Apache team maintains
- excellent documentation, publicly available on their website at
+ excellent documentation, publicly available on their web site at
<ulink url="http://httpd.apache.org"/>. For example, a general
- reference for the configuration directives is located at <ulink url="
+ reference for the configuration directives is located at
+ <ulink url="
http://httpd.apache.org/docs-2.0/mod/directives.html"/>.</para>
<para>Also, as you make changes to your Apache setup, it is likely
@@ -1412,11 +1412,11 @@
file are directives that specify the on-disk locations of the
access and error logs generated by Apache (the
<literal>CustomLog</literal> and <literal>ErrorLog</literal>
- directives, respectively). Subversion's mod_dav_svn uses
- Apache's error logging interface as well. You can always browse
- the contents of those files for information that might reveal
- the source of a problem that is not clearly noticeable
- otherwise.</para>
+ directives, respectively).
+ Subversion's <command>mod_dav_svn</command> uses Apache's error
+ logging interface as well. You can always browse the contents
+ of those files for information that might reveal the source of a
+ problem that is not clearly noticeable otherwise.</para>
<sidebar>
<title>Why Apache 2?</title>
@@ -1428,21 +1428,21 @@
been somewhat slow to upgrade to the Apache 2.X series for
various reasons: some people fear change, especially changing
something as critical as a web server. Other people depend on
- plug-in modules that only work against the Apache 1.3 API, and
- are waiting for a 2.X port. Whatever the reason, many people
- begin to worry when they first discover that Subversion's
- Apache module is written specifically for the Apache 2 API.</para>
+ plug-in modules that work only against the Apache 1.3 API, and
+ they are waiting for a 2.X port. Whatever the reason, many
+ people begin to worry when they first discover that
+ Subversion's Apache module is written specifically for the
+ Apache 2 API.</para>
<para>The proper response to this problem is: don't worry about
- it. It's easy to run Apache 1.3 and Apache 2 side-by-side;
- simply install them to separate places, and use Apache 2 as a
+ it. It's easy to run Apache 1.3 and Apache 2 side by side;
+ simply install them to separate places and use Apache 2 as a
dedicated Subversion server that runs on a port other than 80.
Clients can access the repository by placing the port number
into the URL:</para>
<screen>
$ svn checkout http://host.example.com:7382/repos/project
-…
</screen>
</sidebar>
@@ -1462,23 +1462,23 @@
<itemizedlist>
<listitem>
- <para>getting httpd 2.0 up and running with the mod_dav
- module,</para>
+ <para>Getting httpd 2.0 up and running with
+ the <command>mod_dav</command> module</para>
</listitem>
<listitem>
- <para>installing the mod_dav_svn plugin to mod_dav, which
- uses Subversion's libraries to access the repository,
- and</para>
+ <para>Installing the <command>mod_dav_svn</command> back end
+ to <command>mod_dav</command>, which uses Subversion's
+ libraries to access the repository</para>
</listitem>
<listitem>
- <para>configuring your <filename>httpd.conf</filename>
- file to export (or expose) the repository.</para>
+ <para>Configuring your <filename>httpd.conf</filename>
+ file to export (or expose) the repository</para>
</listitem>
</itemizedlist>
<para>You can accomplish the first two items either by
compiling <command>httpd</command> and Subversion from
- source code, or by installing pre-built binary packages of
+ source code or by installing prebuilt binary packages of
them on your system. For the most up-to-date information on
how to compile Subversion for use with the Apache HTTP Server,
as well as how to compile and configure Apache itself for
@@ -1494,7 +1494,7 @@
<para>Once you have all the necessary components installed on
your system, all that remains is the configuration of Apache
via its <filename>httpd.conf</filename> file. Instruct Apache
- to load the mod_dav_svn module using the
+ to load the <command>mod_dav_svn</command> module using the
<literal>LoadModule</literal> directive. This directive must
precede any other Subversion-related configuration items. If
your Apache was installed using the default layout, your
@@ -1525,7 +1525,7 @@
<para>At a later location in your configuration file, you now
need to tell Apache where you keep your Subversion repository
(or repositories). The <literal>Location</literal> directive
- has an XML-like notation, starting with an opening tag, and
+ has an XML-like notation, starting with an opening tag and
ending with a closing tag, with various other configuration
directives in the middle. The purpose of the
<literal>Location</literal> directive is to instruct Apache to
@@ -1550,12 +1550,13 @@
<para>If you plan to support multiple Subversion repositories
that will reside in the same parent directory on your local
- disk, you can use an alternative directive, the
- <literal>SVNParentPath</literal> directive, to indicate that
- common parent directory. For example, if you know you will be
- creating multiple Subversion repositories in a directory
+ disk, you can use an alternative directive
+ —<literal>SVNParentPath</literal>— to indicate
+ that common parent directory. For example, if you know you
+ will be creating multiple Subversion repositories in a
+ directory
<filename>/var/svn</filename> that would be accessed via
- URLs like <uri>http://my.server.com/svn/repos1</uri>,
+ URLs such as <uri>http://my.server.com/svn/repos1</uri>,
<uri>http://my.server.com/svn/repos2</uri>, and
so on, you could use the <filename>httpd.conf</filename>
configuration syntax in the following example:</para>
@@ -1582,7 +1583,7 @@
<para>Be sure that when you define your new
<literal>Location</literal>, it doesn't overlap with other
- exported Locations. For example, if your main
+ exported locations. For example, if your main
<literal>DocumentRoot</literal> is exported to
<filename>/www</filename>, do not export a Subversion
repository in <literal><Location /www/repos></literal>.
@@ -1603,9 +1604,10 @@
directories. As part of the sanity checking done by the
Apache modules, the source of the copy is expected to be
located on the same machine as the destination of the copy.
- To satisfy this requirement, you might need to tell mod_dav
- the name you use as the hostname of your server. Generally,
- you can use the <literal>ServerName</literal> directive in
+ To satisfy this requirement, you might need to
+ tell <command>mod_dav</command> the name you use as the
+ hostname of your server. Generally, you can use
+ the <literal>ServerName</literal> directive in
<filename>httpd.conf</filename> to accomplish this.</para>
<screen>
@@ -1623,7 +1625,7 @@
<para>At this stage, you should strongly consider the question
of permissions. If you've been running Apache for some time
now as your regular web server, you probably already have a
- collection of content—web pages, scripts and such.
+ collection of content—web pages, scripts, and such.
These items have already been configured with a set of
permissions that allows them to work with Apache, or more
appropriately, that allows Apache to work with those files.
@@ -1654,7 +1656,8 @@
<title>Authentication Options</title>
<para>At this point, if you configured
- <filename>httpd.conf</filename> to contain something like</para>
+ <filename>httpd.conf</filename> to contain something like the
+ following:</para>
<screen>
<Location /svn>
@@ -1663,26 +1666,26 @@
</Location>
</screen>
- <para>…then your repository is <quote>anonymously</quote>
+ <para>then your repository is <quote>anonymously</quote>
accessible to the world. Until you configure some
authentication and authorization policies, the Subversion
- repositories you make available via the
+ repositories that you make available via the
<literal>Location</literal> directive will be generally
- accessible to everyone. In other words,</para>
+ accessible to everyone. In other words:</para>
<itemizedlist>
<listitem>
- <para>anyone can use their Subversion client to check out a
+ <para>Anyone can use a Subversion client to check out a
working copy of a repository URL (or any of its
- subdirectories),</para>
+ subdirectories).</para>
</listitem>
<listitem>
- <para>anyone can interactively browse the repository's
- latest revision simply by pointing their web browser to
- the repository URL, and</para>
+ <para>Anyone can interactively browse the repository's
+ latest revision simply by pointing a web browser to
+ the repository URL.</para>
</listitem>
<listitem>
- <para>anyone can commit to the repository.</para>
+ <para>Anyone can commit to the repository.</para>
</listitem>
</itemizedlist>
@@ -1695,7 +1698,7 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.serverconfig.httpd.authn.basic">
- <title>Setting Up HTTP Authentication</title>
+ <title>Setting up HTTP authentication</title>
<para>The easiest way to authenticate a client is via the
HTTP Basic authentication mechanism, which simply uses a
@@ -1704,7 +1707,7 @@
utility for managing the list of acceptable usernames and
passwords. Let's grant commit access to
Sally and Harry. First, we need to add them to the password
- file.</para>
+ file:</para>
<screen>
$ ### First time: use -c to create the file
@@ -1750,17 +1753,16 @@
</screen>
<para>This <literal><Location></literal> block is not
- yet complete, and will not do anything useful. It's merely
- telling Apache that whenever authorization is required,
- Apache should harvest a username and password from the
- Subversion client. What's missing here, however, are
+ yet complete, and it will not do anything useful. It's
+ merely telling Apache that whenever authorization is
+ required, Apache should harvest a username and password from
+ the Subversion client. What's missing here, however, are
directives that tell Apache <emphasis>which</emphasis> sorts
of client requests require authorization. Wherever
- authorization is required, Apache will demand
- authentication as well. The simplest thing to do is protect
- all requests. Adding <literal>Require valid-user</literal>
- tells Apache that all requests require an authenticated
- user:</para>
+ authorization is required, Apache will demand authentication
+ as well. The simplest thing to do is protect all requests.
+ Adding <literal>Require valid-user</literal> tells Apache
+ that all requests require an authenticated user:</para>
<screen>
<Location /svn>
@@ -1782,10 +1784,10 @@
very nearly plain-text over the network, and thus are
extremely insecure.</para>
- <para>Another option is to not use Basic authentication
- but <quote>Digest</quote> authentication instead. Digest
- authentication allows the server to verify the client's
- identity <emphasis>without</emphasis> passing the plaintext
+ <para>Another option is to not use Basic authentication but to
+ use Digest authentication instead. Digest authentication
+ allows the server to verify the client's
+ identity <emphasis>without</emphasis> passing the plain-text
password over the network. Assuming that the client and
server both know the user's password, they can verify that
the password is the same by using it to apply a hashing
@@ -1819,7 +1821,7 @@
configure Apache to use a self-signed server certificate.
<footnote>
<para>While self-signed server certificates are still
- vulnerable to a <quote>man in the middle</quote> attack,
+ vulnerable to a <quote>man-in-the-middle</quote> attack,
such an attack is much more difficult for a casual
observer to pull off, compared to sniffing unprotected
passwords.</para>
@@ -1832,7 +1834,7 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.serverconfig.httpd.authn.sslcerts">
- <title>SSL Certificate Management</title>
+ <title>SSL certificate management</title>
<para>Businesses that need to expose their repositories for access
outside the company firewall should be conscious of the
@@ -1851,7 +1853,7 @@
further communication is encrypted via a session key.</para>
<para>It's beyond the scope of this book to describe how to
- generate client and server certificates, and how to
+ generate client and server certificates and how to
configure Apache to use them. Many other books, including
Apache's own documentation, describe this task. But what
<emphasis>can</emphasis> be covered here is how to manage
@@ -1863,8 +1865,8 @@
information:</para>
<itemizedlist>
- <listitem><para>a server certificate</para></listitem>
- <listitem><para>a demand for a client certificate</para></listitem>
+ <listitem><para>A server certificate</para></listitem>
+ <listitem><para>A demand for a client certificate</para></listitem>
</itemizedlist>
<para>If the client receives a server certificate, it needs to
@@ -1897,14 +1899,14 @@
same question you've probably seen coming from your web
browser (which is just another HTTP client like Subversion).
If you choose the (p)ermanent option, the server certificate
- will be cached in your private run-time
+ will be cached in your private runtime
<filename>auth/</filename> area in just the same way your
username and password are cached (see <xref
linkend="svn.serverconfig.netmodel.credcache"/>). If cached,
Subversion will automatically trust this certificate
in future negotiations.</para>
- <para>Your run-time <filename>servers</filename> file also gives
+ <para>Your runtime <filename>servers</filename> file also gives
you the ability to make your Subversion client automatically
trust specific CAs, either globally or on a per-host basis.
Simply set the <literal>ssl-authority-files</literal>
@@ -1916,7 +1918,7 @@
ssl-authority-files = /path/to/CAcert1.pem;/path/to/CAcert2.pem
</screen>
- <para>Many OpenSSL installations also have a pre-defined set
+ <para>Many OpenSSL installations also have a predefined set
of <quote>default</quote> CAs that are nearly universally
trusted. To make the Subversion client automatically trust
these standard authorities, set the
@@ -1931,7 +1933,7 @@
Apache trusts. A client certificate is usually stored on
disk in encrypted format, protected by a local password.
When Subversion receives this challenge, it will ask you for
- both a path to the certificate and the password which
+ both a path to the certificate and for the password that
protects it:</para>
<screen>
@@ -1994,19 +1996,19 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.serverconfig.httpd.authz.blanket">
- <title>Blanket Access Control</title>
+ <title>Blanket access control</title>
<para>The simplest form of access control is to authorize
- certain users for either read-only access to a repository,
- or read/write access to a repository.</para>
+ certain users for either read-only access to a repository or
+ read/write access to a repository.</para>
<para>You can restrict access on all repository operations by
adding the <literal>Require valid-user</literal> directive
to your <literal><Location></literal> block. Using
our previous example, this would mean that only clients that
claimed to be either <literal>harry</literal> or
- <literal>sally</literal>, and provided the correct
- password for their respective username, would be allowed to
+ <literal>sally</literal> and that provided the correct
+ password for their respective username would be allowed to
do anything with the Subversion repository:</para>
<screen>
@@ -2027,7 +2029,7 @@
<para>Sometimes you don't need to run such a tight ship. For
example, Subversion's own source code repository at
<ulink url="http://svn.collab.net/repos/svn"/> allows anyone
- in the world to perform read-only repository tasks (like
+ in the world to perform read-only repository tasks (such as
checking out working copies and browsing the repository with
a web browser), but restricts all write operations to
authenticated users. To do this type of selective
@@ -2081,7 +2083,7 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.serverconfig.httpd.authz.perdir">
- <title>Per-Directory Access Control</title>
+ <title>Per-directory access control</title>
<para>It's possible to set up finer-grained permissions using
a second Apache httpd module,
@@ -2116,14 +2118,15 @@
<para>Apache is flexible, so you have the option to configure
your block in one of three general patterns. To begin,
choose one of these basic configuration patterns. (The
- examples below are very simple; look at Apache's own
+ following examples are very simple; look at Apache's own
documentation for much more detail on Apache authentication
and authorization options.)</para>
<para>The simplest block is to allow open access to everyone.
In this scenario, Apache never sends authentication
challenges, so all users are treated as
- <quote>anonymous</quote>.</para>
+ <quote>anonymous.</quote> (See
+ <xref linkend="svn.serverconfig.httpd.authz.perdir.ex-1"/>.)</para>
<example id="svn.serverconfig.httpd.authz.perdir.ex-1">
<title>A sample configuration for anonymous access.</title>
@@ -2142,8 +2145,9 @@
configure your block to demand authentication from everyone.
All clients must supply credentials to identify themselves.
Your block unconditionally requires authentication via the
- <literal>Require valid-user</literal> directive, and defines
- a means to authenticate.</para>
+ <literal>Require valid-user</literal> directive, and it
+ defines a means to authenticate. (See
+ <xref linkend="svn.serverconfig.httpd.authz.perdir.ex-2"/>.)</para>
<example id="svn.serverconfig.httpd.authz.perdir.ex-2">
<title>A sample configuration for authenticated access.</title>
@@ -2174,13 +2178,14 @@
users start out accessing the repository anonymously. If
your access control policy demands a real username at any
point, Apache will demand authentication from the client.
- To do this, you use both the <literal>Satisfy Any</literal>
+ To do this, use both the <literal>Satisfy Any</literal>
and <literal>Require valid-user</literal> directives
- together.</para>
+ together. (See
+ <xref linkend="svn.serverconfig.httpd.authz.perdir.ex-3"/>.)</para>
<example id="svn.serverconfig.httpd.authz.perdir.ex-3">
<title>A sample configuration for mixed
- authenticated/anonymous access.</title>
+ authenticated/anonymous access</title>
<programlisting>
<Location /repos>
DAV svn
@@ -2205,41 +2210,43 @@
<para>Once you've settled on one of these three
basic <filename>httpd.conf</filename> templates, you need to
create your file containing access rules for particular
- paths within the repository. This is described in
+ paths within the repository. This is described later in
+ this chapter in
<xref linkend="svn.serverconfig.pathbasedauthz"/>.</para>
</sect3>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.serverconfig.httpd.authz.pathauthzoff">
- <title>Disabling Path-based Checks</title>
+ <title>Disabling path-based checks</title>
<para>The <command>mod_dav_svn</command> module goes through a
lot of work to make sure that data you've marked
<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 like <command>svn
+ 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
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 like
- <command>svn cat -r OLD foo.c</command> 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
+ history or rename tracing—e.g., running a command such
+ as <command>svn cat -r OLD foo.c</command> 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>
- <para>All of this path-checking can sometimes be quite
+ <para>All of this path checking can sometimes be quite
expensive, especially in the case of <command>svn
- log</command>. When retrieving a list of revisions, the server
- looks at every changed path in each revision and checks it
- for readability. If an unreadable path is discovered, then
- it's omitted from the list of the revision's changed paths
- (normally seen with the <option>--verbose</option> option),
- and the whole log message is suppressed. Needless to say,
- this can be time-consuming on revisions that affect a large
- number of files. This is the cost of security: even if you
- haven't configured a module like
+ log</command>. When retrieving a list of revisions, the
+ server looks at every changed path in each revision and
+ checks it for readability. If an unreadable path is
+ discovered, then it's omitted from the list of the
+ revision's changed paths (normally seen with
+ the <option>--verbose</option> option), and the whole log
+ message is suppressed. Needless to say, this can be
+ time-consuming on revisions that affect a large number of
+ files. This is the cost of security: even if you haven't
+ configured a module such as
<command>mod_authz_svn</command> at all, the
<command>mod_dav_svn</command> module is still asking Apache
<command>httpd</command> to run authorization checks on
@@ -2248,14 +2255,16 @@
all it can do is ask Apache to invoke whatever might be
present.</para>
- <para>On the other hand, there's also an escape-hatch of
- sorts, one which allows you to trade security features for
+ <para>On the other hand, there's also an escape hatch of
+ sorts, which allows you to trade security features for
speed. If you're not enforcing any sort of per-directory
- authorization (i.e. not using
+ authorization (i.e., not using
<command>mod_authz_svn</command> or similar module), then
- you can disable all of this path-checking. In your
+ you can disable all of this path checking. In your
<filename>httpd.conf</filename> file, use the
- <literal>SVNPathAuthz</literal> directive:</para>
+ <literal>SVNPathAuthz</literal> directive as shown in
+ <xref linkend="svn.serverconfig.httpd.authz.pathauthzoff.ex-1"/>.
+ </para>
<example id="svn.serverconfig.httpd.authz.pathauthzoff.ex-1">
<title>Disabling path checks altogether</title>
@@ -2269,9 +2278,10 @@
</programlisting>
</example>
- <para>The <literal>SVNPathAuthz</literal> directive is <quote>on</quote> by
- default. When set <quote>off</quote>, all path-based
- authorization checking is disabled;
+ <para>The <literal>SVNPathAuthz</literal> directive
+ is <quote>on</quote> by default. When
+ set <quote>off,</quote> all path-based authorization
+ checking is disabled;
<command>mod_dav_svn</command> stops invoking authorization
checks on every path it discovers.</para>
@@ -2284,12 +2294,13 @@
<title>Extra Goodies</title>
<para>We've covered most of the authentication and authorization
- options for Apache and mod_dav_svn. But there are a few other
- nice features that Apache provides.</para>
+ options for Apache and <command>mod_dav_svn</command>. But
+ there are a few other nice features that Apache
+ provides.</para>
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.serverconfig.httpd.extra.browsing">
- <title>Repository Browsing</title>
+ <title>Repository browsing</title>
<para>One of the most useful benefits of an Apache/WebDAV
configuration for your Subversion repository is that the
@@ -2297,30 +2308,31 @@
are immediately available for viewing via a regular web
browser. Since Subversion uses URLs to identify versioned
resources, those URLs used for HTTP-based repository access
- can be typed directly into a Web browser. Your browser will
- issue an HTTP <literal>GET</literal> request for that URL, and
+ can be typed directly into a web browser. Your browser will
+ issue an HTTP <literal>GET</literal> request for that URL;
based on whether that URL represents a versioned directory
- or file, mod_dav_svn will respond with a directory listing
- or with file contents.</para>
+ or file, <command>mod_dav_svn</command> will respond with a
+ directory listing or with file contents.</para>
<para>Since the URLs do not contain any information about
- which version of the resource you wish to see, mod_dav_svn
- will always answer with the youngest version. This
- functionality has the wonderful side-effect that you can
- pass around Subversion URLs to your peers as references to
- documents, and those URLs will always point at the latest
- manifestation of that document. Of course, you can even use
- the URLs as hyperlinks from other web sites, too.</para>
+ which version of the resource you wish to
+ see, <command>mod_dav_svn</command> will always answer with
+ the youngest version. This functionality has the wonderful
+ side effect that you can pass around Subversion URLs to your
+ peers as references to documents, and those URLs will always
+ point at the latest manifestation of that document. Of
+ course, you can even use the URLs as hyperlinks from other
+ web sites, too.</para>
<sidebar>
- <title>Can I view older revisions?</title>
+ <title>Can I View Older Revisions?</title>
<para>With an ordinary web browser? In one word: nope. At
least, not with <command>mod_dav_svn</command> as your
only tool.</para>
- <para>Your web browser only speaks ordinary HTTP. That
- means it only knows how to GET public URLs, which
+ <para>Your web browser speaks ordinary HTTP only. That
+ means it knows only how to GET public URLs, which
represent the latest versions of files and directories.
According to the WebDAV/DeltaV specification, each server
defines a private URL syntax for older versions of
@@ -2339,7 +2351,7 @@
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,
+ written to display CVS repositories through the Web,
<footnote>
<para>Back then, it was called <quote>ViewCVS</quote>.</para>
</footnote>
@@ -2348,7 +2360,7 @@
</sidebar>
<sect4 id="svn.serverconfig.httpd.extra.browsing.mimetype">
- <title>Proper MIME Type</title>
+ <title>Proper MIME type</title>
<para>When browsing a Subversion repository, the web browser
gets a clue about how to render a file's contents by
@@ -2365,33 +2377,32 @@
in the repository actually render as HTML when
browsing.</para>
- <para>To make this happen, you only need to make sure that
+ <para>To make this happen, you need only to make sure that
your files have the
proper <literal>svn:mime-type</literal> set. This is
discussed in more detail in
<xref linkend="svn.advanced.props.special.mime-type"/>,
and you can even configure your client to automatically
attach proper <literal>svn:mime-type</literal> properties
- to files entering the repository for the first time; see
+ to files entering the repository for the first time; see
<xref linkend="svn.advanced.props.auto"/>.</para>
<para>So in our example, if one were to set
the <literal>svn:mime-type</literal> property
to <literal>text/html</literal> on
file <filename>foo.html</filename>, then Apache would
- properly tell your web browser to render the file as
- HTML. One could also attach
- proper <literal>image/*</literal> mime-type properties to
- images, and by doing this, ultimately get an entire web
- site to be viewable directly from a repository! There's
- generally no problem with doing this, as long as the
- website doesn't contain any dynamically-generated
+ properly tell your web browser to render the file as HTML.
+ One could also attach proper <literal>image/*</literal>
+ mime-type properties to image files and ultimately get an
+ entire web site to be viewable directly from a repository!
+ There's generally no problem with this, as long as the web
+ site doesn't contain any dynamically generated
content.</para>
</sect4>
<sect4 id="svn.serverconfig.httpd.extra.browsing.xslt">
- <title>Customizing the Look</title>
+ <title>Customizing the look</title>
<para>You generally will get more use out of URLs to
versioned files—after all, that's where the
@@ -2404,10 +2415,10 @@
displays, Subversion provides an XML index feature. A
single <literal>SVNIndexXSLT</literal> directive in your
repository's <literal>Location</literal> block of
- <filename>httpd.conf</filename> will instruct mod_dav_svn
- to generate XML output when displaying a directory
- listing, and to reference the XSLT stylesheet of your
- choice:</para>
+ <filename>httpd.conf</filename> will
+ instruct <command>mod_dav_svn</command> to generate XML
+ output when displaying a directory listing, and to
+ reference the XSLT stylesheet of your choice:</para>
<screen>
<Location /svn>
@@ -2421,7 +2432,7 @@
<para>Using the <literal>SVNIndexXSLT</literal> directive and
a creative XSLT stylesheet, you can make your directory
listings match the color schemes and imagery used in other
- parts of your website. Or, if you'd prefer, you can use
+ parts of your web site. Or, if you'd prefer, you can use
the sample stylesheets provided in the Subversion source
distribution's <filename>tools/xslt/</filename> directory.
Keep in mind that the path provided to the
@@ -2432,7 +2443,7 @@
</sect4>
<sect4 id="svn.serverconfig.httpd.extra.browsing.reposlisting">
- <title>Listing Repositories</title>
+ <title>Listing repositories</title>
<para>If you're serving a collection of repositories from a
single URL via the <literal>SVNParentPath</literal>
@@ -2452,7 +2463,7 @@
<para>If a user now points her web browser to the
URL <literal>http://host.example.com/svn/</literal>, she'll
- see list of all Subversion repositories sitting
+ see a list of all Subversion repositories sitting
in <filename>/var/svn</filename>. Obviously, this can
be a security problem, so this feature is turned off by
default.</para>
@@ -2463,7 +2474,7 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.serverconfig.httpd.extra.logging">
- <title>Apache Logging</title>
+ <title>Apache logging</title>
<para>Because Apache is an HTTP server at heart, it contains
fantastically flexible logging features. It's beyond the
@@ -2495,13 +2506,13 @@
of cryptic <literal>PROPPATCH</literal>, <literal>GET</literal>,
<literal>PUT</literal>, and <literal>REPORT</literal>
requests. To make things worse, many client operations send
- nearly-identical series of requests, so it's even harder to
+ nearly identical series of requests, so it's even harder to
tell them apart.</para>
- <para><literal>mod_dav_svn</literal>, however, can come to
+ <para><command>mod_dav_svn</command>, however, can come to
your aid. By activating an <quote>operational
logging</quote> feature, you can
- ask <literal>mod_dav_svn</literal> to create a separate log
+ ask <command>mod_dav_svn</command> to create a separate log
file describing what sort of high-level operations your
clients are performing.</para>
@@ -2530,7 +2541,7 @@
two instances of <literal>SVN-ACTION</literal>.
When Apache sees that variable, it substitutes the value of
the <literal>SVN-ACTION</literal> environment variable,
- which is automatically set by <literal>mod_dav_svn</literal>
+ which is automatically set by <command>mod_dav_svn</command>
whenever it detects a high-level client action.</para>
<para>So instead of having to interpret a
@@ -2547,8 +2558,9 @@
…
</screen>
- <para>… you can instead peruse a much more
- intelligible <filename>svn_logfile</filename> like this:</para>
+ <para>you can instead peruse a much more
+ intelligible <filename>svn_logfile</filename> like
+ this:</para>
<screen>
[26/Jan/2007:22:24:20 -0600] - list-dir '/'
@@ -2564,15 +2576,15 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.serverconfig.httpd.extra.writethruproxy">
- <title>Write-Through Proxying</title>
+ <title>Write-through proxying</title>
<para>One of the nice advantages of using Apache as a
Subversion server is that it can be set up for simple
replication. For example, suppose that your team is
distributed across four offices around the globe. The
Subversion repository can only exist in one of those
- offices, and that means the other three offices will not
- enjoy accessing it—they're likely to experience
+ offices, which means the other three offices will not enjoy
+ accessing it—they're likely to experience
significantly slower traffic and response times when
updating and committing code. A powerful solution is to set
up a system consisting of one <firstterm>master</firstterm>
@@ -2588,18 +2600,18 @@
<para>This configuration creates a huge perceptual speed
increase for your users, because Subversion client traffic
- is typically 80-90% read requests. And if those requests
- are coming from a <emphasis>local</emphasis> server, it's a
- huge win.</para>
+ is typically 80–90% read requests. And if those
+ requests are coming from a <emphasis>local</emphasis>
+ server, it's a huge win.</para>
<para>In this section, we'll walk you through a standard setup
of this single-master/multiple slave system. However, keep
in mind that your servers must be running at least Apache
2.2.0 (with <command>mod_proxy</command> loaded) and
- Subversion (<command>mod_dav_svn</command>) 1.5.</para>
+ Subversion 1.5 (<command>mod_dav_svn</command>).</para>
<sect4 id="svn.serverconfig.httpd.extra.writethruproxy.configure">
- <title>Configure the Servers</title>
+ <title>Configure the servers</title>
<para>First, configure your master server's
<filename>httpd.conf</filename> file in the usual way.
@@ -2643,8 +2655,8 @@
push revisions to a different
<literal><Location></literal> on the slaves. This
location is configured to <emphasis>not</emphasis> proxy
- write requests at all, but accept normal commits from (and
- only from) the master's IP address:</para>
+ write requests at all, but to accept normal commits from
+ (and only from) the master's IP address:</para>
<screen>
<Location /svn-proxy-sync>
@@ -2661,21 +2673,22 @@
</sect4>
<sect4 id="svn.serverconfig.httpd.extra.writethruproxy.replicate">
- <title>Set up Replication</title>
+ <title>Set up replication</title>
- <para>Now that you've configured your Location blocks on
- master and slaves, you need to configure the master to
- replicate to the slaves. This is done the usual way,
+ <para>Now that you've configured
+ your <literal>Location</literal> blocks on master and
+ slaves, you need to configure the master to replicate to
+ the slaves. This is done the usual way—
using <command>svnsync</command>. If you're not familiar
- with this tool, see <xref
- linkend="svn.reposadmin.maint.replication"/> for
+ with this tool, see
+ <xref linkend="svn.reposadmin.maint.replication"/> for
details.</para>
<para>First, make sure that each slave repository has a
<filename>pre-revprop-change</filename> hook script which
allows remote revision property changes. (This is
standard procedure for being on the receiving end of
- <command>svnsync</command>) Then log into the master
+ <command>svnsync</command>.) Then log into the master
server and configure each of the slave repository URIs to
receive data from the master repository on local
disk:</para>
@@ -2724,7 +2737,7 @@
<programlisting>
#!/bin/sh
-# Post-commit script to replicate newly-committed revision to slaves
+# Post-commit script to replicate newly committed revision to slaves
svnsync sync http://slave1.example.com/svn-proxy-sync > /dev/null 2>&1
svnsync sync http://slave2.example.com/svn-proxy-sync > /dev/null 2>&1
@@ -2739,7 +2752,7 @@
<filename>post-commit</filename> hook, you'll need a
<filename>post-revprop-change</filename> hook as well, so
that when a user, say, modifies a log message, the slave
- servers get that change as well:</para>
+ servers get that change also:</para>
<programlisting>
#!/bin/sh
@@ -2756,13 +2769,13 @@
server (the only place where commits happen), we don't
technically need to do anything. Many teams don't use
Subversion's locking features at all, so it may be a
- non-issue for you. However, if lock changes aren't
+ 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
- information about repository locks.) If this bothers you,
+ (e.g., <command>svn status -u</command> 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 which run
+ <filename>post-unlock</filename> hook scripts that run
<command>svn lock</command> and <command>svn
unlock</command> on each slave machine, presumably through
a remote shell method such as SSH. That's left as an
@@ -2793,7 +2806,7 @@
wrong.</para>
<sidebar>
- <title>Can we set up replication with
+ <title>Can We Set up Replication with
<command>svnserve</command>?</title>
<para>If you're using <command>svnserve</command> instead
@@ -2809,7 +2822,7 @@
servers. You'd have to configure your slave servers to
disallow write access completely. This might be useful
for creating read-only <quote>mirrors</quote> of popular
- open-source projects, but it's not a transparent
+ open source projects, but it's not a transparent
proxying system.</para> </sidebar>
</sect4>
@@ -2818,12 +2831,12 @@
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
<sect3 id="svn.serverconfig.httpd.extra.other">
- <title>Other Apache Features</title>
+ <title>Other Apache features</title>
<para>Several of the features already provided by Apache in
- its role as a robust Web server can be leveraged for
+ its role as a robust web server can be leveraged for
increased functionality or security in Subversion as well.
- The Subversion client is able to use SSL, (the Secure Socket
+ The Subversion client is able to use SSL (the Secure Socket
Layer, discussed earlier). If your Subversion client is
built to support SSL, then it can access your Apache server
using <literal>https://</literal> and enjoy a high-quality
@@ -2841,7 +2854,7 @@
possible to access the repository via third-party DAV
clients. Most modern operating systems (Win32, OS X, and
Linux) have the built-in ability to mount a DAV server as a
- standard network <quote>shared folder</quote>. This is a
+ standard network <quote>shared folder.</quote> This is a
complicated topic, but also wondrous when implemented. For
details, read <xref linkend="svn.webdav"/>.</para>
@@ -2880,15 +2893,15 @@
load the <command>mod_authz_svn</command> module and then add
the <literal>AuthzSVNAccessFile</literal> directive (within
the <filename>httpd.conf</filename> file) pointing to your own
- rules-file. (For a full explanation, see
+ rules file. (For a full explanation, see
<xref linkend="svn.serverconfig.httpd.authz.perdir"/>.) If
you're using <command>svnserve</command>, then you need to make
the <literal>authz-db</literal> variable
(within <filename>svnserve.conf</filename>) point to your
- rules-file.</para>
+ rules file.</para>
<sidebar>
- <title>Do you really need path-based access control?</title>
+ <title>Do You Really Need Path-based Access Control?</title>
<para>A lot of administrators setting up Subversion for the
first time tend to jump into path-based access control without
@@ -2931,13 +2944,16 @@
administrator. Decide whether it's worth sacrificing some
server speed for, and remember that there's very little risk
involved; it's bad to become dependent on technology as a
- crutch for social problems.<footnote><para>A common theme in
- this book!</para></footnote>.</para>
+ crutch for social problems.
+ <footnote>
+ <para>A common theme in this book!</para>
+ </footnote>
+ </para>
<para>As an example to ponder, consider that the Subversion
project itself has always had a notion of who is allowed to
commit where, but it's always been enforced socially. This is
- a good model of community trust, especially for open-source
+ a good model of community trust, especially for open source
projects. Of course, sometimes there <emphasis>are</emphasis>
truly legitimate needs for path-based access control; within
corporations, for example, certain types of data really can be
@@ -2946,14 +2962,14 @@
</sidebar>
- <para>Once your server knows where to find your rules-file, it's
+ <para>Once your server knows where to find your rules file, it's
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
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, and the
+ section names a repository and path within it, as well as the
authenticated usernames are the option names within each
section. The value of each option describes the user's level of
access to the repository path: either
@@ -2961,12 +2977,12 @@
(read-write). If the user is not mentioned at all, no access is
allowed.</para>
- <para>To be more specific: the value of the section-names are
+ <para>To be more specific: the value of the section names are
either of the form <literal>[repos-name:path]</literal> or the
form <literal>[path]</literal>. If you're using the
<literal>SVNParentPath</literal> directive, then it's important
to specify the repository names in your sections. If you omit
- them, then a section like
+ them, then a section such as
<literal>[/some/dir]</literal> will match the path
<filename>/some/dir</filename> in <emphasis>every</emphasis>
repository. If you're using the <literal>SVNPath</literal>
@@ -3044,14 +3060,14 @@
<para>This is a common setup; notice that there's no repository
name mentioned in the section name. This makes all repositories
- world readable to all users. Once all users have read-access to
+ world-readable to all users. Once all users have read-access to
the repositories, you can give explicit
<literal>rw</literal> permission to certain users on specific
subdirectories within specific repositories.</para>
<para>The asterisk variable (<literal>*</literal>) is also worth
- special mention here: it's the
- <emphasis>only</emphasis> pattern which matches an anonymous
+ special mention because it's the
+ <emphasis>only</emphasis> pattern that matches an anonymous
user. If you've configured your server block to allow a mixture
of anonymous and authenticated access, all users start out
accessing anonymously. The server looks for a
@@ -3101,20 +3117,19 @@
<para>If you're using Apache as your Subversion server and have
made certain subdirectories of your repository unreadable to
certain users, then you need to be aware of a possible
- non-optimal behavior with <command>svn
- checkout</command>.</para>
+ nonoptimal behavior with <command>svn checkout</command>.</para>
<para>When the client requests a checkout or update over HTTP, it
- makes a single server request, and receives a single (often
+ makes a single server request and receives a single (often
large) server response. When the server receives the request,
that is the <emphasis>only</emphasis> opportunity Apache has to
- demand user authentication. This has some odd side-effects.
+ demand user authentication. This has some odd side effects.
For example, if a certain subdirectory of the repository is only
readable by user Sally, and user Harry checks out a parent
directory, his client will respond to the initial authentication
challenge as Harry. As the server generates the large response,
there's no way it can re-send an authentication challenge when
- it reaches the special subdirectory; thus the subdirectory is
+ it reaches the special subdirectory; thus the subdirectory is
skipped altogether, rather than asking the user to
re-authenticate as Sally at the right moment. In a similar way,
if the root of the repository is anonymously world-readable,
@@ -3142,24 +3157,24 @@
<itemizedlist>
<listitem>
- <para>regular system users using a Subversion client (as
+ <para>Regular system users using a Subversion client (as
themselves) to access the repository directly via
- <literal>file://</literal> URLs;</para>
+ <literal>file://</literal> URLs</para>
</listitem>
<listitem>
- <para>regular system users connecting to SSH-spawned private
+ <para>Regular system users connecting to SSH-spawned private
<command>svnserve</command> processes (running as
- themselves) which access the repository;</para>
+ themselves), which access the repository</para>
</listitem>
<listitem>
- <para>an <command>svnserve</command> process—either a
+ <para>An <command>svnserve</command> process—either a
daemon or one launched by
<command>inetd</command>—running as a particular fixed
- user;</para>
+ user</para>
</listitem>
<listitem>
- <para>an Apache <command>httpd</command> process, running as a
- particular fixed user.</para>
+ <para>An Apache <command>httpd</command> process, running as a
+ particular fixed user</para>
</listitem>
</itemizedlist>
@@ -3203,7 +3218,7 @@
same group, which then creates more permissions problems for
your users. A good workaround is to set the group SUID bit on
the repository's <filename>db</filename> directory. This causes
- all newly-created log files to have the same group owner as the
+ all newly created log files to have the same group owner as the
parent directory.</para>
<para>Once you've jumped through these hoops, your repository
@@ -3220,45 +3235,49 @@
server or <command>svnserve</command> using
<literal>localhost</literal> for the server name in their
<literal>http://</literal> or <literal>svn://</literal> URLs.
- And to maintain multiple server processes for your Subversion
+ And maintaining multiple server processes for your Subversion
repositories is likely to be more of a headache than necessary.
We recommend you choose the server that best meets your needs
and stick with it!</para>
<sidebar>
- <title>The svn+ssh:// server checklist</title>
+ <title>The svn+ssh:// Server Checklist</title>
<para>It can be quite tricky to get a bunch of users with
existing SSH accounts to share a repository without
permissions problems. If you're confused about all the things
that you (as an administrator) need to do on a Unix-like
system, here's a quick checklist that resummarizes some of
- things discussed in this section:</para>
+ topics discussed in this section:</para>
<itemizedlist>
<listitem>
<para>All of your SSH users need to be able to read and
- write to the repository, so: put all the SSH users into a
- single group. </para>
+ write to the repository, so put all the SSH users into a
+ single group.</para>
</listitem>
<listitem>
<para>
Make the repository wholly owned by that group.
- </para></listitem>
- <listitem><para>Set the group permissions to read/write.</para></listitem>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Set the group permissions to
+ read/write.</para>
+ </listitem>
<listitem>
<para>Your users need to use a sane umask when accessing the
- 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 which sets <command>umask 002</command> and
+ 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
executes the real <command>svnserve</command>
- binary. </para></listitem>
-
+ binary.</para>
+ </listitem>
<listitem><para>Take similar measures when using
<command>svnlook</command> and
<command>svnadmin</command>. Either run them with a sane
- umask, or wrap them as described above.</para>
+ umask or wrap them as just described.</para>
</listitem>
</itemizedlist>
Modified: trunk/src/de/book/ch07-customizing-svn.xml
==============================================================================
--- trunk/src/de/book/ch07-customizing-svn.xml (original)
+++ trunk/src/de/book/ch07-customizing-svn.xml Sun May 4 06:57:32 2008
@@ -991,7 +991,7 @@
(<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
+ more flexibility—multiline, free-form log message editing
on demand.</para>
<para>Subversion supports this by allowing you to specify an
Modified: trunk/src/de/book/ch09-reference.xml
==============================================================================
--- trunk/src/de/book/ch09-reference.xml (original)
+++ trunk/src/de/book/ch09-reference.xml Sun May 4 06:57:32 2008
@@ -2,7 +2,7 @@
<title>Subversion Complete Reference</title>
<para>This chapter is intended to be a complete reference to using
- Subversion. This includes the command line client
+ Subversion. This includes the command-line client
(<command>svn</command>) and all its subcommands, as well as the
repository administration programs (<command>svnadmin</command>
and <command>svnlook</command>) and their respective
@@ -13,17 +13,19 @@
<!-- ================================================================= -->
<!-- ================================================================= -->
<sect1 id="svn.ref.svn">
- <title>The Subversion Command Line Client: <command>svn</command></title>
+ <title>The Subversion Command-Line Client: <command>svn</command></title>
- <para>To use the command line client, you type
- <command>svn</command>, the subcommand you wish to use
- <footnote><para>Yes, yes, you don't need a subcommand to use the
- <option>--version</option> option, but we'll get to that in just
- a minute.</para></footnote>, and any options or targets that
- you wish to operate on—there is no specific order that the
- subcommand and the options must appear in. For example, all of
- the following are valid ways to use <command>svn
- status</command>:</para>
+ <para>To use the command-line client, type
+ <command>svn</command>, the subcommand you wish to use, and
+ <footnote>
+ <para>Well, you don't need a subcommand to use the
+ <option>--version</option> option, but we'll get to that in
+ just a minute.</para>
+ </footnote>
+ any options or targets that you wish to operate on—there
+ is no specific order that the subcommand and the options must
+ appear in. For example, all of the following are valid ways to
+ use <command>svn status</command>:</para>
<screen>
$ svn -v status
@@ -44,7 +46,7 @@
option is guaranteed to mean the same thing regardless of
the subcommand you use it with. For example,
<option>--verbose</option> (<option>-v</option>) always
- means <quote>verbose output</quote>, regardless of the
+ means <quote>verbose output,</quote> regardless of the
subcommand you use it with.</para>
<variablelist>
@@ -57,7 +59,7 @@
Possible actions are (<literal>postpone</literal>,
<literal>base</literal>, <literal>mine</literal>,
<literal>theirs</literal>, <literal>edit</literal>, and
- <literal>launch</literal></para>
+ <literal>launch.</literal></para>
</listitem>
</varlistentry>
@@ -84,7 +86,7 @@
<term><option>--changelist</option>
<replaceable>ARG</replaceable></term>
<listitem>
- <para>Operate only on members of changelist named
+ <para>Operate only on members of the changelist named
<replaceable>ARG</replaceable>. This option can be used
multiple times to specify sets of changelists.</para>
</listitem>
@@ -210,7 +212,7 @@
you from doing in normal usage, but you can pass the
force option to tell Subversion <quote>I know what I'm
doing as well as the possible repercussions of doing it,
- so let me at 'em</quote>. This option is the
+ so let me at 'em.</quote> This option is the
programmatic equivalent of doing your own electrical
work with the power on—if you don't know what
you're doing, you're likely to get a nasty shock.</para>
@@ -231,21 +233,21 @@
Subversion will assume you've made a mistake, that the
path was instead intended as the target of the
operation, and that you simply failed to provide some
- other—unversioned—file as the source of your log
- message. To assert your intent and override these types
- of errors, pass the <option>--force-log</option> option
- to subcommands that accept log messages.</para>
+ other—unversioned—file as the source of your
+ log message. To assert your intent and override these
+ types of errors, pass the <option>--force-log</option>
+ option to subcommands that accept log messages.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--help</option> (<option>-h</option> or
+ <term><option>--help</option> (<option>-h</option>) or
<option>-?</option>)
</term>
<listitem>
<para>If used with one or more subcommands, shows the
- built-in help text for each subcommand. If used alone,
- it displays the general client help text.</para>
+ built-in help text for each. If used alone, it displays
+ the general client help text.</para>
</listitem>
</varlistentry>
@@ -276,7 +278,7 @@
<varlistentry>
<term><option>--keep-changelist</option></term>
<listitem>
- <para>Don't delete changelist after commit.</para>
+ <para>Don't delete the changelist after commit.</para>
</listitem>
</varlistentry>
@@ -302,9 +304,9 @@
<replaceable>MESSAGE</replaceable>
</term>
<listitem>
- <para>Indicates that you will specify a either a log
- message or a lock comment on the command line, following
- this option. For example:</para>
+ <para>Indicates that you will specify either a log message
+ or a lock comment on the command line, following this
+ option. For example:</para>
<screen>
$ svn commit -m "They don't make Sunday."
@@ -324,7 +326,7 @@
<term><option>--no-auth-cache</option></term>
<listitem>
<para>Prevents caching of authentication information
- (e.g. username and password) in the Subversion
+ (e.g., username and password) in the Subversion
administrative directories.</para>
</listitem>
</varlistentry>
@@ -375,11 +377,11 @@
<varlistentry>
<term><option>--non-interactive</option></term>
<listitem>
- <para>In the case of an authentication failure, or
+ <para>In the case of an authentication failure or
insufficient credentials, prevents prompting for
- credentials (e.g. username or password). This is useful
+ credentials (e.g., username or password). This is useful
if you're running Subversion inside of an automated
- script and it's more appropriate to have Subversion fail
+ script, and it's more appropriate to have Subversion fail
than to prompt for more information.</para>
</listitem>
</varlistentry>
@@ -414,7 +416,7 @@
<varlistentry>
<term><option>--parents</option></term>
<listitem>
- <para>Create and add non-existent or non-versioned parent
+ <para>Create and add nonexistent or nonversioned parent
subdirectories to the working copy or repository as part
of an operation. This is useful for automatically
creating multiple subdirectories where none currently
@@ -489,9 +491,9 @@
<listitem>
<para>Indicates that you're going to supply a revision (or
range of revisions) for a particular operation. You can
- provide revision numbers, revision keywords or dates (in
- curly braces), as arguments to the revision option. If
- you wish to provide a range of revisions, you can
+ provide revision numbers, keywords, or dates (in
+ curly braces) as arguments to the revision option. If
+ you wish to offer a range of revisions, you can
provide two revisions separated by a colon. For
example:</para>
@@ -534,7 +536,7 @@
<term><option>--show-updates</option> (<option>-u</option>)</term>
<listitem>
<para>Causes the client to display information about
- which files in your working copy are out-of-date.
+ 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>.
@@ -545,7 +547,7 @@
<varlistentry>
<term><option>--stop-on-copy</option></term>
<listitem>
- <para>Causes a Subversion subcommand which is traversing
+ <para>Causes a Subversion subcommand that traverses
the history of a versioned resource to stop harvesting
that historical information when a copy—that is, a
location in history where that resource was copied from
@@ -558,7 +560,7 @@
<term><option>--strict</option></term>
<listitem>
<para>Causes Subversion to use strict semantics, a notion
- which is rather vague unless talking about specific
+ that is rather vague unless talking about specific
subcommands (namely, <command>svn propget</command>).</para>
</listitem>
</varlistentry>
@@ -568,7 +570,7 @@
<replaceable>FILENAME</replaceable></term>
<listitem>
<para>Tells Subversion to get the list of files that you
- wish to operate on from the filename you provide
+ wish to operate on from the filename that you provide
instead of listing all the files on the command line.
</para>
</listitem>
@@ -590,11 +592,11 @@
(<option>-g</option>)</term>
<listitem>
<para>Use or display additional information from merge
- history. When used with svn copy or svn move, the
- client will contact the server in order to propagate
- merge history information. When used with other
- commands, the client will display merge history
- information.</para>
+ history. When used with <command>svn copy</command> or
+ <command>svn move</command>, the client will contact the
+ server in order to propagate merge history information.
+ When used with other commands, the client will display
+ merge history information.</para>
</listitem>
</varlistentry>
@@ -613,12 +615,11 @@
<term><option>--version</option></term>
<listitem>
<para>Prints the client version info. This information
- not only includes the version number of the client,
- but also a listing of all repository access modules
- that the client can use to access a Subversion
- repository. With <option>--quiet</option>
- (<option>-q</option>) it prints only the version number
- in a compact form.</para>
+ not only includes the version number of the client, but
+ also a listing of all repository access modules that the
+ client can use to access a Subversion repository.
+ With <option>--quiet</option> (<option>-q</option>) it
+ prints only the version number in a compact form.</para>
</listitem>
</varlistentry>
@@ -649,11 +650,11 @@
<replaceable>ARG</replaceable></term>
<listitem>
<para>When used with any command that writes to the
- repository, set the revision property, using thn
+ repository, this sets the revision property, using the
<replaceable>NAME=VALUE</replaceable> format,
<replaceable>NAME</replaceable> to
<replaceable>VALUE</replaceable>. When used with
- <command>svn log --xml</command>, display the value of
+ <command>svn log --xml</command>, this displays the value of
<replaceable>ARG</replaceable> in the log output.</para>
</listitem>
</varlistentry>
@@ -673,7 +674,7 @@
<sect2 id="svn.ref.svn.c">
<title><command>svn</command> Subcommands</title>
- <para>Here are the various subcommands:</para>
+ <para>Here are the various subcommands.</para>
<refentry id="svn.ref.svn.c.add">
@@ -795,7 +796,7 @@
<refnamediv>
<refname>svn blame</refname>
- <refpurpose>Show author and revision information in-line
+ <refpurpose>Show author and revision information inline
for the specified files or URLs.</refpurpose>
</refnamediv>
<refsect1>
@@ -805,7 +806,7 @@
<refsect1>
<title>Description</title>
- <para>Show author and revision information in-line for the
+ <para>Show author and revision information inline for the
specified files or URLs. Each line of text is annotated
at the beginning with the author (username) and the
revision number for the last change to that line.</para>
@@ -813,7 +814,7 @@
<refsect1>
<title>Alternate Names</title>
- <para>praise, annotate, ann</para>
+ <para><command>praise, annotate, ann</command></para>
</refsect1>
<refsect1>
@@ -874,7 +875,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>If you want to see blame annotated source for
<filename>readme.txt</filename> in your test
@@ -886,10 +887,11 @@
</screen>
<para>Even if <command>svn blame</command> says that Harry
- last modified readme.txt in revision 5, you'll have to
- examine exactly what the revision changed to be sure that
- Harry changed the <emphasis>context</emphasis> of the
- line—he may have just adjusted the whitespace.
+ last modified <filename>readme.txt</filename> in revision
+ 5, you'll have to examine exactly what the revision
+ changed to be sure that Harry changed
+ the <emphasis>context</emphasis> of the line—he may
+ have just adjusted the whitespace.
</para>
</refsect1>
</refentry>
@@ -916,7 +918,7 @@
<para>Output the contents of the specified files or URLs.
For listing the contents of directories, see <command>svn
- list</command>.</para>
+ list</command> later.</para>
</refsect1>
<refsect1>
@@ -948,10 +950,10 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
- <para>If you want to view readme.txt in your repository
- without checking it out:</para>
+ <para>If you want to view <filename>readme.txt</filename> in
+ your repository without checking it out:</para>
<screen>
$ svn cat http://svn.red-bean.com/repos/test/readme.txt
This is a README file.
@@ -1000,16 +1002,16 @@
<refsect1>
<title>Description</title>
- <para>Used for dividing files in a working copy into
- changelist (logical named groupings) to allow users to
- easily work on multiple file collections within a single
- working copy.</para>
+ <para>Used for dividing files in a working copy into a
+ changelist (logical named grouping) in order to allow
+ users to easily work on multiple file collections within a
+ single working copy.</para>
</refsect1>
<refsect1>
- <title>Alternate Names</title>
- <para>cl</para>
+ <title>Alternate Name</title>
+ <para><command>cl</command></para>
</refsect1>
<refsect1>
@@ -1035,7 +1037,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>Edit three files, add them to a changelist, then
commit only files in that changelist:</para>
@@ -1096,7 +1098,7 @@
<para>Check out a working copy from a repository. If
<replaceable>PATH</replaceable> is omitted, the
basename of the URL will be used as the destination.
- If multiple URLs are given each will be checked out into a
+ If multiple URLs are given, each will be checked out into a
subdirectory of <replaceable>PATH</replaceable>, with the
name of the subdirectory being the basename of the
URL.</para>
@@ -1104,8 +1106,8 @@
</refsect1>
<refsect1>
- <title>Alternate Names</title>
- <para>co</para>
+ <title>Alternate Name</title>
+ <para><command>co</command></para>
</refsect1>
<refsect1>
@@ -1183,10 +1185,10 @@
</screen>
<para>If you interrupt a checkout (or something else
- interrupts your checkout, like loss of connectivity, etc.),
- you can restart it either by issuing the
- identical checkout command again, or by updating the
- incomplete working copy:</para>
+ interrupts your checkout, such as loss of connectivity,
+ etc.), you can restart it either by issuing the identical
+ checkout command again or by updating the incomplete
+ working copy:</para>
<screen>
$ svn checkout file:///var/svn/repos/test test
@@ -1233,14 +1235,14 @@
<title>Description</title>
<para>Recursively clean up the working copy, removing
- working copy locks and resuming unfinished operations.
- If you ever get a <quote>working copy locked</quote> error,
- run this command to remove stale locks and get your working copy
- into a usable state again.</para>
+ working copy locks and resuming unfinished operations. If
+ you ever get a <literal>working copy locked</literal>
+ error, run this command to remove stale locks and get your
+ working copy into a usable state again.</para>
<para>If, for some reason, an <command>svn update</command>
fails due to a problem running an external diff program
- (e.g. user input or network failure), pass the
+ (e.g., user input or network failure), pass the
<option>--diff3-cmd</option> to allow cleanup to complete
any merging with your external diff program. You can also
specify any configuration directory with the
@@ -1275,11 +1277,11 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
- <para>Well, there's not much to the examples here as
+ <para>Well, there's not much to the examples here, as
<command>svn cleanup</command> generates no output. If
- you pass no <replaceable>PATH</replaceable>,
+ you pass no <replaceable>PATH</replaceable>, then
<quote><filename>.</filename></quote> is used.</para>
<screen>
@@ -1321,7 +1323,7 @@
<para><command>svn commit</command> will send any lock
tokens that it finds and will release locks on all
- <replaceable>PATHS</replaceable> committed (recursively),
+ <replaceable>PATHS</replaceable> committed (recursively)
unless <option>--no-unlock</option> is passed.</para>
<tip>
@@ -1339,15 +1341,15 @@
<refsect1>
- <title>Alternate Names</title>
- <para>ci (short for <quote>check in</quote>; not
- <quote>co</quote>, which is short for
- <quote>checkout</quote>)</para>
+ <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>
</refsect1>
<refsect1>
<title>Changes</title>
- <para>Working copy, repository</para>
+ <para>Working copy; repository</para>
</refsect1>
<refsect1>
@@ -1482,7 +1484,7 @@
<varlistentry>
<term>URL -> WC</term>
<listitem>
- <para>Check out URL into WC, and schedule it for
+ <para>Check out URL into WC and schedule it for
addition.</para>
</listitem>
</varlistentry>
@@ -1501,8 +1503,8 @@
children of <replaceable>DST</replaceable>, which must be
a directory.</para>
- <para>If no peg revision (ie
- <replaceable>@REV</replaceable>) is supplied, by default
+ <para>If no peg revision (i.e.,
+ <replaceable>@REV</replaceable>) is supplied, by default,
the <literal>BASE</literal> revision will be used for
files copied from the working copy, while the
<literal>HEAD</literal> revision will be used for files
@@ -1516,8 +1518,8 @@
</refsect1>
<refsect1>
- <title>Alternate Names</title>
- <para>cp</para>
+ <title>Alternate Name</title>
+ <para><command>cp</command></para>
</refsect1>
<refsect1>
@@ -1528,7 +1530,7 @@
<refsect1>
<title>Accesses Repository</title>
- <para>If source or destination is in the repository, or if needed
+ <para>Yes, if source or destination is in the repository, or if needed
to look up the source revision number.</para>
</refsect1>
@@ -1598,18 +1600,18 @@
<para>Copy an item from the repository to your working
copy (just schedules the copy—nothing goes into the
repository until you commit):</para>
+
+ <screen>
+$ svn copy file:///var/svn/repos/test/far-away near-here
+A near-here
+</screen>
<tip>
<para>This is the recommended way to resurrect a dead
file in your repository!</para>
</tip>
- <screen>
-$ svn copy file:///var/svn/repos/test/far-away near-here
-A near-here
-</screen>
-
- <para>And finally, copying between two URLs:</para>
+ <para>And finally, copy between two URLs:</para>
<screen>
$ svn copy file:///var/svn/repos/test/far-away file:///var/svn/repos/test/over-there -m "remote copy."
@@ -1617,6 +1619,13 @@
Committed revision 9.
</screen>
+ <screen>
+$ svn copy file:///var/svn/repos/test/trunk \
+ file:///var/svn/repos/test/tags/0.6.32-prerelease -m "tag tree"
+
+Committed revision 12.
+</screen>
+
<tip>
<para>This is the easiest way to <quote>tag</quote> a
revision in your repository—just <command>svn
@@ -1624,17 +1633,12 @@
<literal>HEAD</literal>) into your tags directory.</para>
</tip>
- <screen>
-$ svn copy file:///var/svn/repos/test/trunk file:///var/svn/repos/test/tags/0.6.32-prerelease -m "tag tree"
-
-Committed revision 12.
-</screen>
-
<para>And don't worry if you forgot to tag—you can
always specify an older revision and tag anytime:</para>
<screen>
-$ svn copy -r 11 file:///var/svn/repos/test/trunk file:///var/svn/repos/test/tags/0.6.32-prerelease -m "Forgot to tag at rev 11"
+$ svn copy -r 11 file:///var/svn/repos/test/trunk \
+ file:///var/svn/repos/test/tags/0.6.32-prerelease -m "Forgot to tag at rev 11"
Committed revision 13.
</screen>
@@ -1683,7 +1687,7 @@
<refsect1>
<title>Changes</title>
- <para>Working copy if operating on files, repository if
+ <para>Working copy if operating on files; repository if
operating on URLs</para>
</refsect1>
@@ -1719,8 +1723,8 @@
<para>Using <command>svn</command> to delete a file from
your working copy deletes your local copy of the file, but
- merely schedules it to be deleted from the repository.
- When you commit, the file is deleted in the
+ it merely schedules the file to be deleted from the
+ repository. When you commit, the file is deleted in the
repository.</para>
<screen>
@@ -1780,52 +1784,68 @@
<refsect1>
<title>Description</title>
+ <itemizedlist>
- <para>Display the differences between two paths. The ways
- you can use <command>svn diff</command> are:</para>
+ <listitem>
+ <para>Display the differences between two paths. You can
+ use <command>svn diff</command> in the following ways:</para>
+ </listitem>
+
+ <listitem>
+ <para>Use just <command>svn diff</command>to display local
+ modifications in a working copy.</para>
+ </listitem>
- <para>Use just <command>svn diff'</command>to display local
- modifications in a working copy.</para>
+ <listitem>
+ <para>Display the changes made to
+ <replaceable>TARGET</replaceable>s as they are seen in
+ <replaceable>REV</replaceable> between two revisions.
+ <replaceable>TARGET</replaceable>s may be all working copy
+ paths or all <replaceable>URL</replaceable>s. If
+ <replaceable>TARGET</replaceable>s are working copy paths,
+ <replaceable>N</replaceable> defaults to
+ <literal>BASE</literal> and <replaceable>M</replaceable>
+ to the working copy; if <replaceable>TARGET</replaceable>s
+ are <replaceable>URL</replaceable>s,
+ <replaceable>N</replaceable> must be specified and
+ <replaceable>M</replaceable> defaults to
+ <literal>HEAD</literal>. The <literal>-c M</literal> option
+ is equivalent to <literal>-r N:M</literal> where <literal>N =
+ M-1</literal>. Using <literal>-c -M</literal> does the
+ reverse: <literal>-r M:N</literal> where <literal>N =
+ M-1</literal>.</para>
+ </listitem>
- <para>Display the changes made to
- <replaceable>TARGET</replaceable>s as they are seen in
- <replaceable>REV</replaceable> between two revisions.
- <replaceable>TARGET</replaceable>s may be all working copy
- paths or all <replaceable>URL</replaceable>s. If
- <replaceable>TARGET</replaceable>s are working copy paths,
- <replaceable>N</replaceable> defaults to
- <literal>BASE</literal> and <replaceable>M</replaceable>
- to the working copy; if <replaceable>URL</replaceable>s,
- <replaceable>N</replaceable> must be specified and
- <replaceable>M</replaceable> defaults to
- <literal>HEAD</literal>. The <quote>-c M</quote> option
- is equivalent to <quote>-r N:M</quote> where <literal>N =
- M-1</literal>. Using <quote>-c -M</quote> does the
- reverse: <quote>-r M:N</quote> where <literal>N =
- M-1</literal>.</para>
-
- <para>Display the differences between
- <replaceable>OLD-TGT</replaceable> as it was seen in
- <replaceable>OLDREV</replaceable> and
- <replaceable>NEW-TGT</replaceable> as it was seen ain
- <replaceable>NEWREV</replaceable>.
- <replaceable>PATH</replaceable>s, if given, are relative
- to <replaceable>OLD-TGT</replaceable> and
- <replaceable>NEW-TGT</replaceable> and restrict the output
- to differences for those paths.
- <replaceable>OLD-TGT</replaceable> and
- <replaceable>NEW-TGT</replaceable> may be working copy
- paths or <replaceable>URL[@REV]</replaceable>.
- <replaceable>NEW-TGT</replaceable> defaults to
- <replaceable>OLD-TGT</replaceable> if not specified.
- <quote>-r N</quote> makes OLDREV default to N, -r N:M
- makes <replaceable>OLDREV</replaceable> default to
- <replaceable>N</replaceable> and
- <replaceable>NEWREV</replaceable> default to
- <replaceable>M</replaceable>.</para>
+ <listitem>
+ <para>Display the differences between
+ <replaceable>OLD-TGT</replaceable> as it was seen in
+ <replaceable>OLDREV</replaceable> and
+ <replaceable>NEW-TGT</replaceable> as it was seen in
+ <replaceable>NEWREV</replaceable>.
+ <replaceable>PATH</replaceable>s, if given, are relative
+ to <replaceable>OLD-TGT</replaceable> and
+ <replaceable>NEW-TGT</replaceable> and restrict the output
+ to differences for those paths.
+ <replaceable>OLD-TGT</replaceable> and
+ <replaceable>NEW-TGT</replaceable> may be working copy
+ paths or <replaceable>URL[@REV]</replaceable>.
+ <replaceable>NEW-TGT</replaceable> defaults to
+ <replaceable>OLD-TGT</replaceable> if not specified.
+ <literal>-r N</literal>
+ makes <replaceable>OLDREV</replaceable> default to
+ N; <literal>-r N:M</literal>
+ makes <replaceable>OLDREV</replaceable> default to
+ <replaceable>N</replaceable> and
+ <replaceable>NEWREV</replaceable> default to
+ <replaceable>M</replaceable>.</para>
+ </listitem>
+
+ </itemizedlist>
- <para>Shorthand for <command>svn diff --old=OLD-URL[@OLDREV]
- --new=NEW-URL[@NEWREV]</command></para>
+ <para><command>diff OLD-URL[@OLDREV]
+ NEW-URL[@NEWREV]</command> is shorthand for <command>svn
+ diff --old=OLD-URL[@OLDREV]
+ --new=NEW-URL[@NEWREV].</command></para>
<para><command>svn diff -r N:M URL</command> is shorthand
for <command>svn diff -r N:M --old=URL
@@ -1837,7 +1857,7 @@
<para>If <replaceable>TARGET</replaceable> is a URL, then
revs N and M can be given either via the
- <option>--revision</option> or by using
+ <option>--revision</option> option or by using the
<quote>@</quote> notation as described earlier.</para>
<para>If <replaceable>TARGET</replaceable> is a working copy
@@ -1850,9 +1870,9 @@
<term><option>--revision N:M</option></term>
<listitem>
<para>The server compares
- <replaceable>TARGET</replaceable>@<replaceable>N</replaceable>
+ <replaceable>TARGET at N</replaceable>
and
- <replaceable>TARGET</replaceable>@<replaceable>M</replaceable>.</para>
+ <replaceable>TARGET at M</replaceable>.</para>
</listitem>
</varlistentry>
@@ -1860,7 +1880,7 @@
<term><option>--revision N</option></term>
<listitem>
<para>The client compares
- <replaceable>TARGET</replaceable>@<replaceable>N</replaceable>
+ <replaceable>TARGET at N</replaceable>
against working copy.</para>
</listitem>
</varlistentry>
@@ -1891,13 +1911,13 @@
paths in question will be taken into consideration when
comparing revisions (that is, if you run <command>svn
diff</command> on two files with identical contents but
- different ancestry you will see the entire contents of the
- file as having been removed and added again).</para>
+ different ancestry, you will see the entire contents of
+ the file as having been removed and added again).</para>
</refsect1>
<refsect1>
- <title>Alternate Names</title>
- <para>di</para>
+ <title>Alternate Name</title>
+ <para><command>di</command></para>
</refsect1>
<refsect1>
@@ -1978,7 +1998,8 @@
syntax:</para>
<screen>
-$ svn diff http://svn.collab.net/repos/svn/trunk/COMMITTERS@3000 http://svn.collab.net/repos/svn/trunk/COMMITTERS@3500
+$ svn diff http://svn.collab.net/repos/svn/trunk/COMMITTERS@3000 \
+ http://svn.collab.net/repos/svn/trunk/COMMITTERS@3500
Index: COMMITTERS
===================================================================
--- COMMITTERS (revision 3000)
@@ -1987,7 +2008,7 @@
</screen>
<para>Compare revision 3000 to revision 3500 using range
- notation (you only pass the one URL in this
+ notation (pass only the one URL in this
case):</para>
<screen>
@@ -1999,7 +2020,7 @@
</screen>
- <para>Compare revision 3000 to revision 3500 of all files in
+ <para>Compare revision 3000 to revision 3500 of all the files in
<filename>trunk</filename> using range notation:</para>
<screen>
@@ -2029,7 +2050,7 @@
<para>Use <option>--diff-cmd</option>
<replaceable>CMD</replaceable> <option>-x</option> to
pass arguments directly to the external diff
- program</para>
+ program:</para>
<screen>
$ svn diff --diff-cmd /usr/bin/diff -x "-i -b" COMMITTERS
@@ -2064,7 +2085,7 @@
<title>Description</title>
<para>The first form exports a clean directory tree from the
- repository specified by URL, at revision
+ repository specified by URL—at revision
<replaceable>REV</replaceable> if it is given, otherwise
at <literal>HEAD</literal>, into
<replaceable>PATH</replaceable>. If
@@ -2135,14 +2156,15 @@
Exported revision 15.
</screen>
- <para>When rolling operating-system-specific release
- packages, it can be useful to export a tree which uses a
+ <para>When rolling operating system-specific release
+ packages, it can be useful to export a tree that uses a
specific EOL character for line endings. The
<option>--native-eol</option> option will do this, but it
- only affects files that have <literal>svn:eol-style =
+ affects only files that have <literal>svn:eol-style =
native</literal> properties attached to them. For
example, to export a tree with all CRLF line endings
- (possibly for a Windows .zip file distribution):</para>
+ (possibly for a Windows <literal>.zip</literal> file
+ distribution):</para>
<screen>
$ svn export file:///var/svn/repos my-export --native-eol CRLF
@@ -2154,7 +2176,7 @@
<para>You can specify <literal>LR</literal>,
<literal>CR</literal>, or <literal>CRLF</literal> as a
- line ending type with the <option>--native-eol</option>
+ line-ending type with the <option>--native-eol</option>
option.</para>
</refsect1>
@@ -2188,7 +2210,7 @@
<refsect1>
<title>Alternate Names</title>
<para>?, h</para>
- <para>The options <option>-?</option>, <option>-h</option>
+ <para>The options <option>-?</option>, <option>-h</option>,
and <option>--help</option> have the same effect as using the
<command>help</command> subcommand.</para>
</refsect1>
@@ -2235,7 +2257,7 @@
<para>Recursively commit a copy of
<replaceable>PATH</replaceable> to
<replaceable>URL</replaceable>. If
- <replaceable>PATH</replaceable> is omitted
+ <replaceable>PATH</replaceable> is omitted,
<quote><filename>.</filename></quote> is assumed. Parent
directories are created in the repository as necessary.
Unversionable items such as device files and pipes are
@@ -2350,17 +2372,17 @@
<listitem><para>Path</para></listitem>
<listitem><para>Name</para></listitem>
<listitem><para>URL</para></listitem>
- <listitem><para>Repository Root</para></listitem>
+ <listitem><para>Repository root</para></listitem>
<listitem><para>Repository UUID</para></listitem>
<listitem><para>Revision</para></listitem>
- <listitem><para>Node Kind</para></listitem>
- <listitem><para>Last Changed Author</para></listitem>
- <listitem><para>Last Changed Revision</para></listitem>
- <listitem><para>Last Changed Date</para></listitem>
- <listitem><para>Lock Token</para></listitem>
- <listitem><para>Lock Owner</para></listitem>
- <listitem><para>Lock Created (date)</para></listitem>
- <listitem><para>Lock Expires (date)</para></listitem>
+ <listitem><para>Node kind</para></listitem>
+ <listitem><para>Last changed author</para></listitem>
+ <listitem><para>Last changed revision</para></listitem>
+ <listitem><para>Last changed date</para></listitem>
+ <listitem><para>Lock token</para></listitem>
+ <listitem><para>Lock owner</para></listitem>
+ <listitem><para>Lock created (date)</para></listitem>
+ <listitem><para>Lock expires (date)</para></listitem>
</itemizedlist>
<para>Additional kinds of information available only for
@@ -2368,15 +2390,15 @@
<itemizedlist>
<listitem><para>Schedule</para></listitem>
- <listitem><para>Copied From URL</para></listitem>
- <listitem><para>Copied From Rev</para></listitem>
- <listitem><para>Text Last Updated</para></listitem>
- <listitem><para>Properties Last Updated</para></listitem>
+ <listitem><para>Copied from URL</para></listitem>
+ <listitem><para>Copied from rev</para></listitem>
+ <listitem><para>Text last updated</para></listitem>
+ <listitem><para>Properties last updated</para></listitem>
<listitem><para>Checksum</para></listitem>
- <listitem><para>Conflict Previous Base File</para></listitem>
- <listitem><para>Conflict Previous Working File</para></listitem>
- <listitem><para>Conflict Current Base File</para></listitem>
- <listitem><para>Conflict Properties File</para></listitem>
+ <listitem><para>Conflict previous base file</para></listitem>
+ <listitem><para>Conflict previous working file</para></listitem>
+ <listitem><para>Conflict current base file</para></listitem>
+ <listitem><para>Conflict properties file</para></listitem>
</itemizedlist>
</refsect1>
@@ -2456,8 +2478,9 @@
</screen>
<para><command>svn info</command> also acts on URLs (also
- note that the file readme.doc in this example is locked,
- so lock information is also provided):</para>
+ note that the file <filename>readme.doc</filename> in
+ this example is locked, so lock information is also
+ provided):</para>
<screen>
$ svn info http://svn.red-bean.com/repos/test/readme.doc
@@ -2588,7 +2611,7 @@
</screen>
<para>You can pass the <option>--verbose</option> option for
- additional information, rather like the UNIX command
+ additional information, rather like the Unix command
<command>ls -l</command>:</para>
<screen>
@@ -2598,7 +2621,7 @@
24 harry Jan 18 11:27 examples/
</screen>
- <para>For further details, see <xref
+ <para>For further details, see the earlier section <xref
linkend="svn.tour.history.browsing.list"/>.</para>
</refsect1>
@@ -2642,7 +2665,7 @@
<refsect1>
<title>Changes</title>
- <para>Working Copy, Repository</para>
+ <para>Working copy, repository</para>
</refsect1>
<refsect1>
@@ -2673,7 +2696,6 @@
<para>Lock two files in your working copy:</para>
<screen>
-
$ svn lock tree.jpg house.jpg
'tree.jpg' locked by user 'harry'.
'house.jpg' locked by user 'harry'.
@@ -2842,7 +2864,7 @@
<para>If you want several distinct paths underneath the
same URL, you can use the <literal>URL [PATH...]</literal>
- syntax.</para>
+ syntax:</para>
<screen>
$ svn log http://svn.red-bean.com/repos/test/ foo.c bar.c
@@ -2878,8 +2900,8 @@
------------------------------------------------------------------------
</screen>
- <para>However, if you wanted to gather 2 non-sequential
- log messages into a file, you might do something like
+ <para>However, if you wanted to gather two nonsequential log
+ messages into a file, you might do something like
this:</para>
<screen>
@@ -2902,7 +2924,8 @@
</screen>
<para>You can avoid the clutter of the double dashed lines
- in your output by using the incremental option:</para>
+ in your output by using the <option>--incremental</option>
+ option:</para>
<screen>
@@ -2929,7 +2952,7 @@
<tip>
<para>If you run <command>svn log</command> on a specific
path and provide a specific revision and get no output
- at all</para>
+ at all as in the following:</para>
<screen>
$ svn log -r 20 http://svn.red-bean.com/untouched.txt
@@ -2938,7 +2961,7 @@
<para>That just means that the path was not modified in
that revision. If you log from the top of the
- repository, or know the file that changed in that
+ repository or know the file that changed in that
revision, you can specify it explicitly:</para>
<screen>
@@ -3013,13 +3036,14 @@
<replaceable>WCPATH</replaceable> is omitted, a default
value of <quote><filename>.</filename></quote> is assumed,
unless the sources have identical basenames that match a
- file within <quote><filename>.</filename></quote>: in which
- case, the differences will be applied to that file.</para>
+ file within <quote><filename>.</filename></quote>. In
+ this case, the differences will be applied to that
+ file.</para>
<para>Subversion will only internally track metadata about
the merge operation if the two sources are ancestrally
related—if the first source is an ancestor of the
- second, or vice-versa. This is guaranteed to be the case
+ second or vice-versa. This is guaranteed to be the case
when using the third form. Unlike <command>svn
diff</command>, the merge command takes the ancestry of a
file into consideration when performing a merge operation.
@@ -3123,8 +3147,7 @@
</refsect1>
<refsect1>
<title>Description</title>
-
- <para></para>
+ <para>Query merge-related information.</para>
</refsect1>
<refsect1>
@@ -3156,7 +3179,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>Find out which changesets your trunk directory has
already received as well as what changesets it's still
@@ -3201,7 +3224,7 @@
in the working copy. A directory specified by a URL is
created in the repository via an immediate commit.
Multiple directory URLs are committed atomically. In both
- cases all the intermediate directories must already exist
+ cases, all the intermediate directories must already exist
unless the <option>--parents</option> option is
used.</para>
</refsect1>
@@ -3213,7 +3236,7 @@
<refsect1>
<title>Changes</title>
- <para>Working copy, repository if operating on a URL</para>
+ <para>Working copy; repository if operating on a URL</para>
</refsect1>
<refsect1>
@@ -3329,7 +3352,7 @@
<refsect1>
<title>Changes</title>
- <para>Working copy, repository if operating on a URL</para>
+ <para>Working copy; repository if operating on a URL</para>
</refsect1>
<refsect1>
@@ -3419,7 +3442,7 @@
revisions. The first form removes versioned properties in
your working copy, while the second removes unversioned
remote properties on a repository revision
- (<replaceable>TARGET</replaceable> only determines which
+ (<replaceable>TARGET</replaceable> determines only which
repository to access).</para>
</refsect1>
@@ -3430,7 +3453,7 @@
<refsect1>
<title>Changes</title>
- <para>Working copy, repository only if operating on a URL</para>
+ <para>Working copy; repository only if operating on a URL</para>
</refsect1>
<refsect1>
@@ -3459,7 +3482,7 @@
<title>Examples</title>
<para>Delete a property from a file in your working
- copy</para>
+ copy:</para>
<screen>
$ svn propdel svn:mime-type some-script
@@ -3502,7 +3525,7 @@
editor. The first form edits versioned properties in
your working copy, while the second edits unversioned
remote properties on a repository revision
- (<replaceable>TARGET</replaceable> only determines which
+ (<replaceable>TARGET</replaceable> determines only which
repository to access).</para>
</refsect1>
@@ -3513,7 +3536,7 @@
<refsect1>
<title>Changes</title>
- <para>Working copy, repository only if operating on a URL</para>
+ <para>Working copy; repository only if operating on a URL</para>
</refsect1>
<refsect1>
@@ -3542,7 +3565,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para><command>svn propedit</command> makes it easy to
modify properties that have multiple values:</para>
@@ -3595,7 +3618,7 @@
<refsect1>
<title>Changes</title>
- <para>Working copy, repository only if operating on a URL</para>
+ <para>Working copy; repository only if operating on a URL</para>
</refsect1>
<refsect1>
@@ -3668,7 +3691,7 @@
revisions. The first form lists versioned properties in
your working copy, while the second lists unversioned remote
properties on a repository revision
- (<replaceable>TARGET</replaceable> only determines which
+ (<replaceable>TARGET</replaceable> determines only which
repository to access).</para>
</refsect1>
@@ -3679,7 +3702,7 @@
<refsect1>
<title>Changes</title>
- <para>Working copy, repository only if operating on a URL</para>
+ <para>Working copy; repository only if operating on a URL</para>
</refsect1>
<refsect1>
@@ -3762,7 +3785,7 @@
property change in the working copy, and the second
creates an unversioned, remote property change on a
repository revision
- (<replaceable>TARGET</replaceable> only determines which
+ (<replaceable>TARGET</replaceable> determines only which
repository to access).</para>
<tip>
@@ -3780,7 +3803,7 @@
<refsect1>
<title>Changes</title>
- <para>Working copy, repository only if operating on a URL</para>
+ <para>Working copy; repository only if operating on a URL</para>
</refsect1>
<refsect1>
@@ -3819,7 +3842,7 @@
property 'svn:mime-type' set on 'foo.jpg'
</screen>
- <para>On a UNIX system, if you want a file to have the
+ <para>On a Unix system, if you want a file to have the
executable permission set:</para>
<screen>
@@ -3846,7 +3869,7 @@
</screen>
<para>Or, if you don't have a working copy, you can
- provide a URL.</para>
+ provide a URL:</para>
<screen>
$ svn propset --revprop -r 26 svn:log "Document nap." http://svn.red-bean.com/repos
@@ -3901,7 +3924,7 @@
conflict-related artifact files and allows
<replaceable>PATH</replaceable> to be committed again;
that is, it tells Subversion that the conflicts have been
- <quote>resolved</quote>. See <xref
+ <quote>resolved.</quote> See <xref
linkend="svn.tour.cycle.resolve"/> for an in-depth look at
resolving conflicts.</para> </refsect1>
@@ -3933,7 +3956,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>If you get a conflict on an update, your working
copy will sprout three new files:</para>
@@ -3990,7 +4013,7 @@
revert</command> will not only revert the contents of an
item in your working copy, but also any property
changes. Finally, you can use it to undo any scheduling
- operations that you may have done (e.g. files scheduled
+ operations that you may have done (e.g., files scheduled
for addition or deletion can be
<quote>unscheduled</quote>).</para>
</refsect1>
@@ -4117,35 +4140,35 @@
<variablelist>
<varlistentry>
- <term>' '</term>
+ <term><literal>' '</literal></term>
<listitem>
<para>No modifications.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'A'</term>
+ <term><literal>'A'</literal></term>
<listitem>
- <para>Item is scheduled for Addition.</para>
+ <para>Item is scheduled for addition.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'D'</term>
+ <term><literal>'D'</literal></term>
<listitem>
- <para>Item is scheduled for Deletion.</para>
+ <para>Item is scheduled for deletion.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'M'</term>
+ <term><literal>'M'</literal></term>
<listitem>
<para>Item has been modified.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'R'</term>
+ <term><literal>'R'</literal></term>
<listitem>
<para>Item has been replaced in your working copy.
This means the file was scheduled for deletion, and
@@ -4155,7 +4178,7 @@
</varlistentry>
<varlistentry>
- <term>'C'</term>
+ <term><literal>'C'</literal></term>
<listitem>
<para>The contents (as opposed to the properties) of
the item conflict with updates received from the
@@ -4164,29 +4187,29 @@
</varlistentry>
<varlistentry>
- <term>'X'</term>
+ <term><literal>'X'</literal></term>
<listitem>
<para>Item is present because of an externals definition.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'I'</term>
+ <term><literal>'I'</literal></term>
<listitem>
- <para>Item is being ignored (e.g. with the
+ <para>Item is being ignored (e.g., with the
<literal>svn:ignore</literal> property).</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'?'</term>
+ <term><literal>'?'</literal></term>
<listitem>
<para>Item is not under version control.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'!'</term>
+ <term><literal>'!'</literal></term>
<listitem>
<para>Item is missing (e.g. you moved or deleted it
without using <command>svn</command>). This also
@@ -4196,7 +4219,7 @@
</varlistentry>
<varlistentry>
- <term>'~'</term>
+ <term><literal>'~'</literal></term>
<listitem>
<para>Item is versioned as one kind of object (file,
directory, link), but has been replaced by different
@@ -4212,14 +4235,14 @@
<variablelist>
<varlistentry>
- <term>' '</term>
+ <term><literal>' '</literal></term>
<listitem>
<para>No modifications.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'M'</term>
+ <term><literal>'M'</literal></term>
<listitem>
<para>Properties for this item have been
modified.</para>
@@ -4227,7 +4250,7 @@
</varlistentry>
<varlistentry>
- <term>'C'</term>
+ <term><literal>'C'</literal></term>
<listitem>
<para>Properties for this item are in conflict with
property updates received from the
@@ -4244,14 +4267,14 @@
<variablelist>
<varlistentry>
- <term>' '</term>
+ <term><literal>' '</literal></term>
<listitem>
<para>Item is not locked.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'L'</term>
+ <term><literal>'L'</literal></term>
<listitem>
<para>Item is locked.</para>
</listitem>
@@ -4265,14 +4288,14 @@
<variablelist>
<varlistentry>
- <term>' '</term>
+ <term><literal>' '</literal></term>
<listitem>
<para>No history scheduled with commit.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'+'</term>
+ <term><literal>'+'</literal></term>
<listitem>
<para>History scheduled with commit.</para>
</listitem>
@@ -4287,14 +4310,14 @@
<variablelist>
<varlistentry>
- <term>' '</term>
+ <term><literal>' '</literal></term>
<listitem>
<para>Item is a child of its parent directory.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'S'</term>
+ <term><literal>'S'</literal></term>
<listitem>
<para>Item is switched.</para>
</listitem>
@@ -4307,7 +4330,7 @@
<variablelist>
<varlistentry>
- <term>' '</term>
+ <term><literal>' '</literal></term>
<listitem>
<para>When <option>--show-updates</option> is used,
the file is not locked. If
@@ -4328,7 +4351,7 @@
<term>O</term>
<listitem>
<para>File is locked either by another user or in
- another working copy. This only appears when
+ another working copy. This appears only when
<option>--show-updates</option> is used.</para>
</listitem>
</varlistentry>
@@ -4339,7 +4362,7 @@
<para>File was locked in this working copy, but the
lock has been <quote>stolen</quote> and is invalid.
The file is currently locked in the repository. This
- only appears when <option>--show-updates</option> is
+ appears only when <option>--show-updates</option> is
used.</para>
</listitem>
</varlistentry>
@@ -4349,7 +4372,7 @@
<listitem>
<para>File was locked in this working copy, but the
lock has been <quote>broken</quote> and is invalid.
- The file is no longer locked This only appears when
+ The file is no longer locked. This appears only when
<option>--show-updates</option> is used.</para>
</listitem>
</varlistentry>
@@ -4366,14 +4389,14 @@
<variablelist>
<varlistentry>
- <term>' '</term>
+ <term><literal>' '</literal></term>
<listitem>
- <para>The item in your working copy is up-to-date.</para>
+ <para>The item in your working copy is up to date.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'*'</term>
+ <term><literal>'*'</literal></term>
<listitem>
<para>A newer revision of the item exists on the
server.</para>
@@ -4472,7 +4495,7 @@
</note>
<para>And finally, the most information you can get out of
- the status subcommand:</para>
+ the status subcommand is as follows:</para>
<screen>
$ svn status --show-updates --verbose wc
@@ -4514,7 +4537,7 @@
<para>The first variant of this subcommand (without the
<option>--relocate</option> option) updates your working
- copy to point to a new URL—usually a URL which
+ copy to point to a new URL—usually a URL that
shares a common ancestor with your working copy, although
not necessarily. This is the Subversion way to move a
working copy to a new branch. If specified,
@@ -4527,7 +4550,7 @@
obstructing paths in the working copy do not automatically
cause a failure if the switch attempts to add the same
path. If the obstructing path is the same type (file or
- directory) as the corresponding path in the repository it
+ directory) as the corresponding path in the repository, it
becomes versioned but its contents are left untouched in
the working copy. This means that an obstructing
directory's unversioned children may also obstruct and
@@ -4557,7 +4580,7 @@
</refsect1>
<refsect1>
- <title>Alternate Names</title>
+ <title>Alternate Name</title>
<para>sw</para>
</refsect1>
@@ -4633,7 +4656,7 @@
words, the content of the repository doesn't change, but
the repository's root URL does. For example, the hostname
may change, the URL scheme may change, or any part of the
- URL which leads to the repository itself may change.
+ URL that leads to the repository itself may change.
Rather than check out a new working copy, you can have the
<command>svn switch</command> command
<quote>rewrite</quote> your working copy's administrative
@@ -4755,7 +4778,6 @@
<para>Unlock two files in your working copy:</para>
<screen>
-
$ svn unlock tree.jpg house.jpg
'tree.jpg' unlocked.
'house.jpg' unlocked.
@@ -4806,7 +4828,7 @@
<para><command>svn update</command> brings changes from the
repository into your working copy. If no revision is given,
- it brings your working copy up-to-date with the
+ it brings your working copy up to date with the
<literal>HEAD</literal> revision. Otherwise, it
synchronizes the working copy to the revision given by the
<option>--revision</option> option. As part of the
@@ -4822,42 +4844,42 @@
<variablelist>
<varlistentry>
- <term>A</term>
+ <term><literal>A</literal></term>
<listitem>
<para>Added</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>D</term>
+ <term><literal>D</literal></term>
<listitem>
<para>Deleted</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>U</term>
+ <term><literal>U</literal></term>
<listitem>
<para>Updated</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>C</term>
+ <term><literal>C</literal></term>
<listitem>
<para>Conflicted</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>G</term>
+ <term><literal>G</literal></term>
<listitem>
<para>Merged</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>E</term>
+ <term><literal>E</literal></term>
<listitem>
<para>Existed</para>
</listitem>
@@ -4880,8 +4902,8 @@
</refsect1>
<refsect1>
- <title>Alternate Names</title>
- <para>up</para>
+ <title>Alternate Name</title>
+ <para><command>up</command></para>
</refsect1>
<refsect1>
@@ -4919,7 +4941,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>Pick up repository changes that have happened since
your last update:</para>
@@ -4969,7 +4991,7 @@
<para><command>svnadmin</command> is the administrative tool for
monitoring and repairing your Subversion repository. For
- detailed information, see <xref
+ detailed information, see the maintenance section for <xref
linkend="svn.reposadmin.maint.tk.svnadmin"/>.</para>
<para>Since <command>svnadmin</command> works via direct repository access
@@ -4985,7 +5007,7 @@
<varlistentry>
<term><option>--bdb-log-keep</option></term>
<listitem>
- <para>(Berkeley DB specific) Disable automatic log removal
+ <para>(Berkeley DB-specific.) Disable automatic log removal
of database log files. Having these log files around
can be convenient if you need to restore from a
catastrophic repository failure.</para>
@@ -4996,10 +5018,10 @@
<term><option>--bdb-txn-nosync</option></term>
<listitem>
- <para>(Berkeley DB specific) Disables fsync when
+ <para>(Berkeley DB-specific.) Disables fsync when
committing database transactions. Used with the
<command>svnadmin create</command> command to create a
- Berkeley DB backed repository with
+ Berkeley DB-backed repository with
<literal>DB_TXN_NOSYNC</literal> enabled (which improves
speed but has some risks associated with it).</para>
</listitem>
@@ -5015,7 +5037,7 @@
<varlistentry>
<term><option>--clean-logs</option></term>
<listitem>
- <para>Removes unused Berkeley DB logs.</para>
+ <para>Remove unused Berkeley DB logs.</para>
</listitem>
</varlistentry>
@@ -5127,13 +5149,16 @@
<para>Create a new, empty repository at the path provided.
If the provided directory does not exist, it will be
- created for you.<footnote><para>Remember,
- <command>svnadmin</command> works only with local
- <emphasis>paths</emphasis>, not
- <emphasis>URLs</emphasis>.</para></footnote> As of
- Subversion 1.2, <command>svnadmin</command> creates new
- repositories with the <literal>fsfs</literal> filesystem
- backend by default.</para>
+ created for you.
+ <footnote>
+ <para>Remember, <command>svnadmin</command> works only
+ with local <emphasis>paths</emphasis>, not
+ <emphasis>URLs</emphasis>.</para>
+ </footnote>
+ As of Subversion 1.2, <command>svnadmin</command>
+ creates new repositories with the
+ <literal>fsfs</literal> filesystem backend by
+ default.</para>
<para>While <command>svnadmin create</command> will create
the base directory for a new repository, it will not
@@ -5254,14 +5279,14 @@
revision range) in which every file and directory in the
repository in that revision is presented as if that whole
tree was added at once, followed by other revisions (the
- remainder of the revisions in the requested range) which
- contain only the files and directories which were modified
+ remainder of the revisions in the requested range), which
+ contain only the files and directories that were modified
in those revisions. For a modified file, the complete
fulltext representation of its contents, as well as all of
its properties, are presented in the dumpfile; for a
directory, all of its properties are presented.</para>
- <para>There are two useful options which modify the dumpfile
+ <para>There are two useful options that modify the dumpfile
generator's behavior. The first is the
<option>--incremental</option> option, which simply causes
that first revision in the dumpfile stream to contain only
@@ -5270,7 +5295,7 @@
and in exactly the same way that every other revision in
the dumpfile is presented. This is useful for generating
a relatively small dumpfile to be loaded into another
- repository which already has the files and directories
+ repository that already has the files and directories
that exist in the original repository.</para>
<para>The second useful option is <option>--deltas</option>.
@@ -5281,10 +5306,10 @@
some cases, drastically) the size of the dumpfile that
<command>svnadmin dump</command> creates. There are, however,
disadvantages to using this option—deltified
- dumpfiles are more CPU intensive to create, cannot be
+ dumpfiles are more CPU-intensive to create, cannot be
operated on by <command>svndumpfilter</command>, and tend
- not to compress as well as their non-deltified counterparts
- when using third-party tools like <command>gzip</command>
+ not to compress as well as their nondeltified counterparts
+ when using third-party tools such as <command>gzip</command>
and <command>bzip2</command>.</para>
</refsect1>
<refsect1>
@@ -5423,10 +5448,10 @@
</indexterm>
<refnamediv>
- <refname>svnadmin list-dblogs</refname> <refpurpose>Ask
- Berkeley DB which log files exist for a given Subversion
- repository (applies only to repositories using the
- <literal>bdb</literal> backend).</refpurpose>
+ <refname>svnadmin list-dblogs</refname>
+ <refpurpose>Ask Berkeley DB which log files exist for a
+ given Subversion repository (applies only to repositories
+ using the <literal>bdb</literal> backend).</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -5479,9 +5504,9 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
- <para>Remove all unused log files from a repository:</para>
+ <para>Remove all unused log files from the repository:</para>
<screen>
$ svnadmin list-unused-dblogs /var/svn/repos
@@ -5535,7 +5560,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>This shows the beginning of loading a repository from
a backup file (made, of course, with <command>svnadmin
@@ -5636,7 +5661,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>List all outstanding transactions in a
repository.</para>
@@ -5767,7 +5792,7 @@
<para>This deletes the locks on
<filename>tree.jpg</filename> and
<filename>house.jpg</filename> in the repository at
- <filename>/var/svn/repos</filename></para>
+ <filename>/var/svn/repos</filename>:</para>
<screen>
$ svnadmin rmlocks /var/svn/repos tree.jpg house.jpg
@@ -5826,7 +5851,7 @@
$ svnadmin rmtxns /var/svn/repos/ `svnadmin lstxns /var/svn/repos/`
</screen>
- <para>Which will remove all uncommitted transactions from
+ <para>This removes all uncommitted transactions from
your repository.</para>
</refsect1>
@@ -5843,7 +5868,7 @@
<refnamediv>
<refname>svnadmin setlog</refname>
- <refpurpose>Set the log-message on a revision.</refpurpose>
+ <refpurpose>Set the log message on a revision.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -5852,16 +5877,17 @@
<refsect1>
<title>Description</title>
- <para>Set the log-message on revision REVISION to the
- contents of FILE.</para>
+ <para>Set the log message on
+ 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
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 of
- revision properties has not been enabled in the pre-revprop-change
- hook.</para>
+ <option>--bypass-hooks</option> to avoid running any pre-
+ or post-commit hooks, which is useful if the modification
+ of revision properties has not been enabled in
+ the <literal>pre-revprop-change</literal> hook.</para>
<warning>
<para>Revision properties are not under version control,
@@ -5881,7 +5907,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>Set the log message for revision 19 to the contents of
the file <filename>msg</filename>:</para>
@@ -5919,17 +5945,17 @@
revisions in the repository by internally dumping all
revisions and discarding the output—it's a good idea
to run this on a regular basis to guard against latent
- hard disk failures and <quote>bitrot</quote>. If this
+ hard disk failures and <quote>bitrot.</quote> If this
command fails—which it will do at the first sign of
a problem—that means that your repository has at
- least one corrupted revision and you should restore the
+ least one corrupted revision, and you should restore the
corrupted revision from a backup (you did make a backup,
didn't you?).</para>
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>Verify a hung repository:</para>
@@ -5954,7 +5980,7 @@
<para><command>svnlook</command> is a command-line utility for
examining different aspects of a Subversion repository. It
does not make any changes to the repository—it's just
- used for <quote>peeking</quote>.
+ used for <quote>peeking.</quote>
<command>svnlook</command> is typically used by the
repository hooks, but a repository administrator might find it
useful for diagnostic purposes.</para>
@@ -5973,8 +5999,8 @@
<para>Options in <command>svnlook</command> are global, just
like in <command>svn</command> and
- <command>svnadmin</command>; however, most options only
- apply to one subcommand since the functionality of
+ <command>svnadmin</command>; however, most options apply
+ only to one subcommand since the functionality of
<command>svnlook</command> is (intentionally) limited in
scope.</para>
@@ -6126,7 +6152,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows the contents of a file in transaction
<literal>ax8</literal>, located at
@@ -6178,44 +6204,45 @@
<variablelist>
<varlistentry>
- <term>'<literal>A </literal>'</term>
+ <term><literal>'A '</literal></term>
<listitem>
- <para>Item added to repository.</para>
+ <para>Item added to repository</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'<literal>D </literal>'</term>
+ <term><literal>'D '</literal></term>
<listitem>
- <para>Item deleted from repository.</para>
+ <para>Item deleted from repository</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'<literal>U </literal>'</term>
+ <term><literal>'U '</literal></term>
<listitem>
- <para>File contents changed.</para>
+ <para>File contents changed</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'<literal> U</literal>'</term>
+ <term><literal>' U'</literal></term>
<listitem>
- <para>Properties of item changed. Note the leading space.</para>
+ <para>Properties of item changed; note the leading space</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>'<literal>UU</literal>'</term>
+ <term><literal>'UU'</literal></term>
<listitem>
- <para>File contents and properties changed.</para>
+ <para>File contents and properties changed</para>
</listitem>
</varlistentry>
</variablelist>
- <para>Files and directories can be distinguished, as directory
- paths are displayed with a trailing '<literal>/</literal>'
+ <para>Files and directories can be distinguished, as
+ directory paths are displayed with a
+ trailing <quote><literal>/</literal></quote>
character.</para>
</refsect1>
@@ -6230,7 +6257,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows a list of all the changed files and
directories in revision 39 of a test repository. Note
@@ -6285,7 +6312,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows the date of revision 40 of a test
repository:</para>
@@ -6329,11 +6356,12 @@
--transaction (-t)
--no-diff-added
--no-diff-deleted
+--diff-copy-from
</screen>
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows a newly added (empty) file, a deleted
file, and a copied file:</para>
@@ -6363,7 +6391,7 @@
==============================================================================
</screen>
- <para>If a file has a non-textual
+ <para>If a file has a nontextual
<literal>svn:mime-type</literal> property, then the
differences are not explicitly shown.</para>
</refsect1>
@@ -6403,7 +6431,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows the directories that changed in
revision 40 in our sample repository:</para>
@@ -6434,10 +6462,16 @@
<refsect1>
<title>Description</title>
- <para>Displays the help message for svnlook. This
- command, like its brother <command>svn help</command>, is
- also your friend, even though you never call it anymore
- and forgot to invite it to your last party.</para>
+ <para>Displays the help message
+ for <command>svnlook</command>. This command, like its
+ brother <command>svn help</command>, is also your friend,
+ even though you never call it anymore and forgot to invite
+ it to your last party.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+ <para>None</para>
</refsect1>
<refsect1>
@@ -6483,11 +6517,11 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows the history output for the path
<filename>/tags/1.0</filename> as of revision 20 in our
- sample repository.</para>
+ sample repository:</para>
<screen>
$ svnlook history -r 20 /var/svn/repos /tags/1.0 --show-ids
@@ -6532,7 +6566,7 @@
<refsect1>
<title>Description</title>
- <para>Print the author, datestamp, log message size (in bytes)
+ <para>Print the author, datestamp, log message size (in bytes),
and log message, followed by a newline character.</para>
</refsect1>
@@ -6546,10 +6580,10 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows the info output for revision 40 in our
- sample repository.</para>
+ sample repository:</para>
<screen>
$ svnlook info -r 40 /var/svn/repos
@@ -6596,10 +6630,10 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This describes the lock on the file
- <filename>tree.jpg</filename>.</para>
+ <filename>tree.jpg</filename>:</para>
<screen>
$ svnlook lock /var/svn/repos tree.jpg
@@ -6648,7 +6682,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows the log output for revision 40 in our sample
repository:</para>
@@ -6702,7 +6736,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows the value of the <quote>seasonings</quote> property
on the file <filename>/trunk/sandwich</filename> in the
@@ -6800,7 +6834,7 @@
<refsect1>
<title>Description</title>
<para>Print the tree, starting at
- <replaceable>PATH_IN_REPOS</replaceable> (if supplied, at
+ <replaceable>PATH_IN_REPOS</replaceable> (if supplied; at
the root of the tree otherwise), optionally showing node
revision IDs.</para>
</refsect1>
@@ -6812,13 +6846,14 @@
--revision (-r) REV
--transaction (-t)
--show-ids
+--full-paths
</screen>
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
- <para>This shows the tree output (with node-IDs) for revision
+ <para>This shows the tree output (with nodeIDs) for revision
40 in our sample repository:</para>
<screen>
@@ -6856,7 +6891,7 @@
<title>Description</title>
<para>Print the <literal>UUID</literal> for the repository.
- the UUID is the repository's
+ The <literal>UUID</literal> is the repository's
<emphasis>u</emphasis>niversal <emphasis>u</emphasis>nique
<emphasis>id</emphasis>entifier. The Subversion client
uses this identifier to differentiate between one
@@ -6864,7 +6899,12 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Options</title>
+ <para>None</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Example</title>
<screen>
$ svnlook uuid /var/svn/repos
@@ -6897,7 +6937,12 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Options</title>
+ <para>None</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Example</title>
<para>This shows the youngest revision of our sample
repository:</para>
@@ -6966,7 +7011,7 @@
<term><option>--no-auth-cache</option></term>
<listitem>
<para>Prevents caching of authentication information
- (e.g. username and password) in the Subversion
+ (e.g., username and password) in the Subversion
administrative directories.</para>
</listitem>
</varlistentry>
@@ -6974,9 +7019,9 @@
<varlistentry>
<term><option>--non-interactive</option></term>
<listitem>
- <para>In the case of an authentication failure, or
+ <para>In the case of an authentication failure or
insufficient credentials, prevents prompting for
- credentials (e.g. username or password). This is useful
+ credentials (e.g., username or password). This is useful
if you're running Subversion inside of an automated
script and it's more appropriate to have Subversion fail
than to prompt for more information.</para>
@@ -7013,7 +7058,7 @@
<sect2 id="svn.ref.svnsync.c">
<title><command>svnsync</command> Subcommands</title>
- <para>Here are the various subcommands:</para>
+ <para>The following lists the various subcommands.</para>
<refentry id="svn.ref.svnsync.c.copy-revprops">
@@ -7047,16 +7092,11 @@
in the values of that revision's properties between the
source and mirror repositories. <command>svnsync
copy-revprops</command> is the answer to this problem.
- Use it to re-synchronize the revision properties for a
+ Use it to resynchronize the revision properties for a
particular revision.</para>
</refsect1>
<refsect1>
- <title>Alternate Names</title>
- <para>None</para>
- </refsect1>
-
- <refsect1>
<title>Options</title>
<screen>
@@ -7069,9 +7109,9 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
- <para>Re-synchronize revision properties for a single revision:</para>
+ <para>Resynchronize revision properties for a single revision:</para>
<screen>
$ svnsync copy-revprops file:///var/svn/repos-mirror 6
@@ -7105,16 +7145,16 @@
<para><command>svnsync initialize</command> verifies that a
repository meets the requirements of a new mirror
repository—that it has no previous existing version
- history, and that it allows revision property
+ history and that it allows revision property
modifications—and records the initial administrative
- information which associates the mirror repository with
+ information that associates the mirror repository with
the source repository. This is the first
<command>svnsync</command> operation you run on a would-be
mirror repository.</para>
</refsect1>
<refsect1>
- <title>Alternate Names</title>
+ <title>Alternate Name</title>
<para>init</para>
</refsect1>
@@ -7144,8 +7184,8 @@
</screen>
<para>Initialize a repository as a mirror, having already
- created a pre-revprop-change hook which permits all revision
- property changes:</para>
+ created a <literal>pre-revprop-change</literal> hook that
+ permits all revision property changes:</para>
<screen>
$ svnsync initialize file:///var/svn/repos-mirror http://svn.example.com/repos
@@ -7188,7 +7228,7 @@
</refsect1>
<refsect1>
- <title>Alternate Names</title>
+ <title>Alternate Name</title>
<para>sync</para>
</refsect1>
@@ -7205,7 +7245,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>Copy unsynchronized revisions from the source
repository to the mirror repository:</para>
@@ -7270,8 +7310,8 @@
<para>Unlike the previous commands we've
described, <command>svnserve</command> has no
- subcommands—<command>svnserve</command> is controlled
- exclusively by options.</para>
+ subcommands—it is controlled exclusively by
+ options.</para>
<variablelist>
@@ -7280,8 +7320,9 @@
<listitem>
<para>Causes <command>svnserve</command> to run in daemon
mode. <command>svnserve</command> backgrounds itself
- and accepts and serves TCP/IP connections on the svn
- port (3690, by default).</para>
+ and accepts and serves TCP/IP connections on
+ the <literal>svn</literal> port (3690, by
+ default).</para>
</listitem>
</varlistentry>
@@ -7290,7 +7331,7 @@
<listitem>
<para>Causes svnserve to listen on
<replaceable>PORT</replaceable> when run in daemon mode.
- (FreeBSD daemons only listen on tcp6 by default—this
+ (FreeBSD daemons listen only on tcp6 by default—this
option tells them to also listen on tcp4.)</para>
</listitem>
</varlistentry>
@@ -7309,8 +7350,7 @@
<listitem>
<para>When used together with <option>-d</option>, this
option causes <command>svnserve</command> to stay in the
- foreground. This option is mainly useful for
- debugging.</para>
+ foreground. This is mainly useful for debugging.</para>
</listitem>
</varlistentry>
@@ -7333,8 +7373,8 @@
<varlistentry>
<term><option>--version</option></term>
<listitem>
- <para>Displays version information, a list of repository
- back-end modules available, and exits.</para>
+ <para>Displays version information and a list of repository
+ backend modules available, and then exits.</para>
</listitem>
</varlistentry>
@@ -7345,7 +7385,7 @@
<para>Sets the virtual root for repositories served by
<command>svnserve</command>. The pathname in URLs
provided by the client will be interpreted relative to
- this root, and will not be allowed to escape this
+ this root and will not be allowed to escape this
root.</para>
</listitem>
</varlistentry>
@@ -7356,15 +7396,16 @@
<para>Causes <command>svnserve</command> to run in tunnel
mode, which is just like the <command>inetd</command>
mode of operation (both modes serve one connection over
- stdin/stdout, then exit), except that the connection is
- considered to be pre-authenticated with the username of
- the current uid. This flag is automatically passed for
- you by the client when running over a tunnel agent such
- as <command>ssh</command>. That means there's rarely
- any need for <emphasis>you</emphasis> to pass this
- option to <command>svnserve</command>. So if you find
- yourself typing <literal>svnserve --tunnel</literal> on
- the command line, and wondering what to do next, see
+ stdin/stdout, and then exit), except that the connection
+ is considered to be preauthenticated with the username
+ of the current UID. This flag is automatically passed
+ for you by the client when running over a tunnel agent
+ such as <command>ssh</command>. That means there's
+ rarely any need for <emphasis>you</emphasis> to pass
+ this option to <command>svnserve</command>. So if you
+ find yourself
+ typing <literal>svnserve --tunnel</literal> on the
+ command line and wondering what to do next, see
<xref linkend="svn.serverconfig.svnserve.sshauth"/>.
</para>
</listitem>
@@ -7388,7 +7429,7 @@
<listitem>
<para>When running in daemon mode, causes
<command>svnserve</command> to spawn a thread instead of
- a process for each connection (e.g. for when running on
+ a process for each connection (e.g., for when running on
Windows). The <command>svnserve</command> process still
backgrounds itself at startup time.</para>
</listitem>
@@ -7398,8 +7439,9 @@
<term><option>--listen-once</option> (<option>-X</option>)</term>
<listitem>
<para>Causes <command>svnserve</command> to accept one
- connection on the svn port, serve it, and exit. This
- option is mainly useful for debugging.</para>
+ connection on the <literal>svn</literal> port, serve it,
+ and exit. This option is mainly useful for
+ debugging.</para>
</listitem>
</varlistentry>
@@ -7463,8 +7505,8 @@
<title>Options</title>
<para>Like <command>svnserve</command>,
- <command>svnversion</command> has no subcommands, it only
- has options.</para>
+ <command>svnversion</command> has no subcommands—only
+ options.</para>
<variablelist>
@@ -7581,8 +7623,8 @@
<refname><literal>mod_dav_svn</literal> Configuration
Directives</refname> <refpurpose>Apache configuration
- directives for serving Subversion repositories through Apache
- HTTP Server.</refpurpose>
+ directives for serving Subversion repositories through the
+ Apache HTTP Server.</refpurpose>
</refnamediv>
@@ -7609,7 +7651,8 @@
<literal>Directory</literal> or
<literal>Location</literal> block for a Subversion
repository. It tells httpd to use the Subversion
- backend for mod_dav to handle all requests.</para>
+ backend for <literal>mod_dav</literal> to handle all
+ requests.</para>
</listitem>
</varlistentry>
@@ -7620,7 +7663,7 @@
<para>This directive allows write requests from WebDAV
clients to result in automatic commits. A generic log
- message is auto-generated and attached to each
+ message is autogenerated and attached to each
revision. If you enable Autoversioning, you'll likely
want to set <literal>ModMimeUsePathInfo On</literal>
so that <literal>mod_mime</literal> can set
@@ -7628,7 +7671,7 @@
mime-type automatically (as best as
<literal>mod_mime</literal> is able to, of course).
For more information, see <xref
- linkend="svn.webdav"/></para>
+ linkend="svn.webdav"/>.</para>
</listitem>
</varlistentry>
@@ -7654,11 +7697,11 @@
<para>Specifies the URI component (namespace) for
special Subversion resources. The default is
<quote><literal>!svn</literal></quote>, and most
- administrators will never use this directive. Only
- set this if there is a pressing need to have a file
- named <filename>!svn</filename> in your repository. If
- you change this on a server already in use, it will
- break all of the outstanding working copies and your
+ administrators will never use this directive. Set
+ this only if there is a pressing need to have a file
+ named <filename>!svn</filename> in your repository.
+ If you change this on a server already in use, it will
+ break all of the outstanding working copies, and your
users will hunt you down with pitchforks and flaming
torches.</para>
@@ -7708,8 +7751,9 @@
<listitem>
<para>Control path-based authorization by enabling or
- disabling subrequests. See <xref
- linkend="svn.serverconfig.httpd.authz.pathauthzoff"/> for details.</para>
+ disabling subrequests. See
+ <xref linkend="svn.serverconfig.httpd.authz.pathauthzoff"/>
+ for details.</para>
</listitem>
</varlistentry>
@@ -7718,9 +7762,11 @@
<term><literal>SVNListParentPath</literal></term>
<listitem>
- <para>When set to <literal>On</literal>, allows a GET of
- SVNParentPath, which results in a listing of all
- repositories under that path. The default setting is
+ <para>When set to <literal>On</literal>, allows
+ a <literal>GET</literal>
+ of <literal>SVNParentPath</literal>, which results in
+ a listing of all repositories under that path. The
+ default setting is
<literal>Off</literal>.</para>
</listitem>
@@ -7741,7 +7787,28 @@
<listitem>
<para>Specifies the location in the filesystem where the
- activities database should be stored.</para>
+ activities database should be stored. By default,
+ mod_dav_svn creates and uses a directory in the
+ repository
+ called <filename>dav/activities.d</filename>. The
+ path specified with this option must be an absolute
+ path.</para>
+
+ <para>If specified for
+ an <literal>SVNParentPath</literal> area, mod_dav_svn
+ appends the basename of the repository to the path
+ specified here. For example:</para>
+
+ <screen>
+<Location /svn>
+ DAV svn
+
+ # any "/svn/foo" URL will map to a repository in /net/svn.nfs/repositories/foo
+ SVNParentPath "/net/svn.nfs/repositories"
+ # any "/svn/foo" URL will map to an activities db in /var/db/svn/activities/foo
+ SVNActivitiesDB "/var/db/svn/activities"
+</Location>
+</screen>
</listitem>
</varlistentry>
@@ -7750,7 +7817,7 @@
</refsect1>
<refsect1 id="svn.ref.mod_dav_svn.conf.logging">
- <title>High Level Logging</title>
+ <title>High-level logging</title>
<para>This is a list of Subversion action log messages
produced by Apache's high-level logging mechanism, followed
@@ -7862,16 +7929,8 @@
</listitem>
</varlistentry>
- <varlistentry>
- <term></term>
- <listitem>
- <para></para>
- </listitem>
- </varlistentry>
-
</variablelist>
-
</refsect1>
</refentry>
@@ -7882,7 +7941,7 @@
<!-- ================================================================= -->
<sect1 id="svn.ref.properties">
- <title>Subversion properties</title>
+ <title>Subversion Properties</title>
<para>Subversion allows users to invent arbitrarily-named
versioned properties on files and directories, as well as
@@ -7933,7 +7992,7 @@
by <command>svn status</command> and other
subcommands. See
<xref
- linkend="svn.advanced.props.special.ignore"/></para>
+ linkend="svn.advanced.props.special.ignore"/>.</para>
</listitem>
</varlistentry>
@@ -7957,7 +8016,7 @@
<para>If present on a file, the value tells the client how
to manipulate the file's line-endings in the working
- copy, and in exported trees. See <xref
+ copy and in exported trees. See <xref
linkend="svn.advanced.props.special.eol-style"/> and
<xref linkend="svn.ref.svn.c.export" />.</para>
@@ -7968,11 +8027,10 @@
<term><literal>svn:externals</literal></term>
<listitem>
- <para>If present on a directory, the value is a
- multi-line list of other paths and URLs the client
- should check out. See
- <xref
- linkend="svn.advanced.externals"/>.</para>
+ <para>If present on a directory, the value is a multiline
+ list of other paths and URLs the client should check
+ out. See
+ <xref linkend="svn.advanced.externals"/>.</para>
</listitem>
</varlistentry>
@@ -7983,10 +8041,14 @@
<para>If present on a file, indicates that the file is not
an ordinary file, but a symbolic link or other special
- object<footnote><para>As of this writing, symbolic links
- are indeed the only <quote>special</quote> objects. But
- there might be more in future releases of
- Subversion.</para></footnote>.</para>
+ object.
+ <footnote>
+ <para>As of this writing, symbolic links are indeed
+ the only <quote>special</quote> objects. But there
+ might be more in future releases of
+ Subversion.</para>
+ </footnote>
+ </para>
</listitem>
</varlistentry>
@@ -8089,7 +8151,7 @@
transaction is even created. It is typically used to
decide if the user has commit privileges at all.</para>
- <para>If the start-commit hook program returns a non-zero exit
+ <para>If the start-commit hook program returns a nonzero exit
value, the commit is stopped before the commit transaction
is even created, and anything printed to stderr is
marshalled back to the client.</para>
@@ -8104,13 +8166,13 @@
<orderedlist>
<listitem>
- <para>repository path</para>
+ <para>Repository path</para>
</listitem>
<listitem>
- <para>authenticated username attempting the commit</para>
+ <para>Authenticated username attempting the commit</para>
</listitem>
<listitem>
- <para>(new in Subversion 1.5) colon separated list of
+ <para>(New in Subversion 1.5.) Colon-separated list of
capabilities that a client passes to the server,
including <literal>depth</literal>,
<literal>mergeinfo</literal>, and
@@ -8122,10 +8184,10 @@
<refsect1>
<title>Common Uses</title>
- <para>access control (e.g. temporarily lock out commits for
- some reason)</para>
+ <para>Access control (e.g., temporarily lock out commits for
+ some reason).</para>
- <para>a means to allow access only from clients that have
+ <para>A means to allow access only from clients that have
certain capabilities.</para>
</refsect1>
@@ -8148,18 +8210,18 @@
<refsect1>
<title>Description</title>
- <para>The pre-commit hook is run just before a commit
- transaction is promoted to a new revision. Typically,
- this hook is used to protect against commits that are
- disallowed due to content or location (for example, your
+ <para>The <literal>pre-commit</literal> hook is run just
+ before a commit transaction is promoted to a new revision.
+ Typically, this hook is used to protect against commits that
+ are disallowed due to content or location (for example, your
site might require that all commits to a certain branch
include a ticket number from the bug tracker, or that the
- incoming log message is non-empty).</para>
+ incoming log message is nonempty).</para>
- <para>If the pre-commit hook program returns a non-zero exit
- value, the commit is aborted, the commit transaction is
- removed, and anything printed to stderr is marshalled back
- to the client.</para>
+ <para>If the <literal>pre-commit</literal> hook program
+ returns a nonzero exit value, the commit is aborted, the
+ commit transaction is removed, and anything printed to
+ stderr is marshalled back to the client.</para>
</refsect1>
@@ -8171,17 +8233,17 @@
<orderedlist>
<listitem>
- <para>repository path</para>
+ <para>Repository path</para>
</listitem>
<listitem>
- <para>commit transaction name</para>
+ <para>Commit transaction name</para>
</listitem>
</orderedlist>
</refsect1>
<refsect1>
<title>Common Uses</title>
- <para>change validation and control</para>
+ <para>Change validation and control</para>
</refsect1>
</refentry>
@@ -8203,15 +8265,19 @@
<refsect1>
<title>Description</title>
- <para>The post-commit hook is run after the transaction is
- committed, and a new revision created. Most people use
- this hook to send out descriptive emails about the commit
- or to notify some other tool (such as an issue tracker)
- that a commit has happened. Some configurations also use
- this hook to trigger backup processes.</para>
-
- <para>The output from, and exit value returned by the
- post-commit hook program are ignored.</para>
+ <para>The <literal>post-commit</literal> hook is run after the
+ transaction is committed and a new revision created. Most
+ people use this hook to send out descriptive emails about
+ the commit or to notify some other tool (such as an issue
+ tracker) that a commit has happened. Some configurations
+ also use this hook to trigger backup processes.</para>
+
+ <para>If the <literal>post-commit</literal> hook returns a
+ nonzero exit status, the commit <emphasis>will
+ not</emphasis> be aborted since it has already
+ completed. However, anything that the hook printed
+ to <literal>STDERR</literal> will be marshalled back to the
+ client, making it easier to diagnose hook failures.</para>
</refsect1>
@@ -8223,17 +8289,17 @@
<orderedlist>
<listitem>
- <para>repository path</para>
+ <para>Repository path</para>
</listitem>
<listitem>
- <para>revision number created by the commit</para>
+ <para>Revision number created by the commit</para>
</listitem>
</orderedlist>
</refsect1>
<refsect1>
<title>Common Uses</title>
- <para>commit notification, tool integration</para>
+ <para>Commit notification; tool integration</para>
</refsect1>
</refentry>
@@ -8256,18 +8322,18 @@
<refsect1>
<title>Description</title>
- <para>The pre-revprop-change hook is run immediately prior to
- the modification of a revision property when performed
- outside the scope of a normal commit. Unlike the other
- hooks, the default state of this one is to deny the proposed
- action. The hook must actually exist and return a zero
- exit value before a revision property modification can
- happen.</para>
-
- <para>If the pre-revprop-change hook doesn't exist, isn't
- executable, or returns a non-zero exit value, no change to
- the property will be made, and anything printed to stderr is
- marshalled back to the client.</para>
+ <para>The <literal>pre-revprop-change</literal> hook is run
+ immediately prior to the modification of a revision property
+ when performed outside the scope of a normal commit. Unlike
+ the other hooks, the default state of this one is to deny
+ the proposed action. The hook must actually exist and
+ return a zero exit value before a revision property
+ modification can happen.</para>
+
+ <para>If the <literal>pre-revprop-change</literal> hook
+ doesn't exist, isn't executable, or returns a nonzero exit
+ value, no change to the property will be made, and anything
+ printed to stderr is marshalled back to the client.</para>
</refsect1>
@@ -8279,19 +8345,19 @@
<orderedlist>
<listitem>
- <para>repository path</para>
+ <para>Repository path</para>
</listitem>
<listitem>
- <para>revision whose property is about to be modified</para>
+ <para>Revision whose property is about to be modified</para>
</listitem>
<listitem>
- <para>authenticated username attempting the propchange</para>
+ <para>Authenticated username attempting the propchange</para>
</listitem>
<listitem>
- <para>name of the property changed</para>
+ <para>Name of the property changed</para>
</listitem>
<listitem>
- <para>change description: <literal>A</literal> (added),
+ <para>Change description: <literal>A</literal> (added),
<literal>D</literal> (deleted), or <literal>M</literal>
(modified)</para>
</listitem>
@@ -8304,7 +8370,7 @@
<refsect1>
<title>Common Uses</title>
- <para>access control, change validation and control</para>
+ <para>Access control; change validation and control</para>
</refsect1>
</refentry>
@@ -8327,17 +8393,22 @@
<refsect1>
<title>Description</title>
- <para>The post-revprop-change hook is run immediately after to
- the modification of a revision property when performed
- outside the scope of a normal commit. As can be derived
- from the description of its counterpart, the
- pre-revprop-change hook, this hook will not run at all
- unless the pre-revprop-change hook is implemented. It is
- typically used to send email notification of the property
- change.</para>
-
- <para>The output from, and exit value returned by, the
- post-revprop-change hook program are ignored.</para>
+ <para>The <literal>post-revprop-change</literal> hook is run
+ immediately after to the modification of a revision property
+ when performed outside the scope of a normal commit. As can
+ be derived from the description of its counterpart, the
+ <literal>pre-revprop-change</literal> hook, this hook will
+ not run at all unless
+ the <literal>pre-revprop-change</literal> hook is
+ implemented. It is typically used to send email
+ notification of the property change.</para>
+
+ <para>If the <literal>post-revprop-change</literal> hook returns a
+ nonzero exit status, the change <emphasis>will
+ not</emphasis> be aborted since it has already
+ completed. However, anything that the hook printed
+ to <literal>STDERR</literal> will be marshalled back to the
+ client, making it easier to diagnose hook failures.</para>
</refsect1>
@@ -8349,19 +8420,19 @@
<orderedlist>
<listitem>
- <para>repository path</para>
+ <para>Repository path</para>
</listitem>
<listitem>
- <para>revision whose property was modified</para>
+ <para>Revision whose property was modified</para>
</listitem>
<listitem>
- <para>authenticated username of the person making the change</para>
+ <para>Authenticated username of the person making the change</para>
</listitem>
<listitem>
- <para>name of the property changed</para>
+ <para>Name of the property changed</para>
</listitem>
<listitem>
- <para>change description: <literal>A</literal> (added),
+ <para>Change description: <literal>A</literal> (added),
<literal>D</literal> (deleted), or <literal>M</literal>
(modified)</para>
</listitem>
@@ -8396,16 +8467,18 @@
<refsect1>
<title>Description</title>
- <para>The pre-lock hook runs whenever someone attempts to lock
- a path. It can be used to prevent locks altogether, or to
- create a more complex policy specifying exactly which users
- are allowed to lock particular paths. If the hook notices a
- pre-existing lock, then it can also decide whether a user is
- allowed to <quote>steal</quote> the existing lock.</para>
-
- <para>If the pre-lock hook program returns a non-zero exit
- value, the lock action is aborted and anything printed to
- stderr is marshalled back to the client.</para>
+ <para>The <literal>pre-lock</literal> hook runs whenever
+ someone attempts to lock a path. It can be used to prevent
+ locks altogether or to create a more complex policy
+ specifying exactly which users are allowed to lock
+ particular paths. If the hook notices a pre-existing lock,
+ then it can also decide whether a user is allowed
+ to <quote>steal</quote> the existing lock.</para>
+
+ <para>If the <literal>pre-lock</literal> hook program returns
+ a nonzero exit value, the lock action is aborted and
+ anything printed to stderr is marshalled back to the
+ client.</para>
</refsect1>
@@ -8417,13 +8490,13 @@
<orderedlist>
<listitem>
- <para>repository path</para>
+ <para>Repository path</para>
</listitem>
<listitem>
- <para>versioned path which is to be locked</para>
+ <para>Versioned path that is to be locked</para>
</listitem>
<listitem>
- <para>authenticated username of the person attempting the
+ <para>Authenticated username of the person attempting the
lock</para>
</listitem>
</orderedlist>
@@ -8431,7 +8504,7 @@
<refsect1>
<title>Common Uses</title>
- <para>access control</para>
+ <para>Access control</para>
</refsect1>
</refentry>
@@ -8453,12 +8526,16 @@
<refsect1>
<title>Description</title>
- <para>The post-lock hook runs after one or more paths has been
- locked. It is typically used to send email notification of
- the lock event.</para>
-
- <para>The output from and exit value returned by the post-lock
- hook program are ignored.</para>
+ <para>The <literal>post-lock</literal> hook runs after one or
+ more paths has been locked. It is typically used to send
+ email notification of the lock event.</para>
+
+ <para>If the <literal>post-lock</literal> hook returns a
+ nonzero exit status, the lock <emphasis>will
+ not</emphasis> be aborted since it has already
+ completed. However, anything that the hook printed
+ to <literal>STDERR</literal> will be marshalled back to the
+ client, making it easier to diagnose hook failures.</para>
</refsect1>
@@ -8470,10 +8547,10 @@
<orderedlist>
<listitem>
- <para>repository path</para>
+ <para>Repository path</para>
</listitem>
<listitem>
- <para>authenticated username of the person who locked the
+ <para>Authenticated username of the person who locked the
paths</para>
</listitem>
</orderedlist>
@@ -8485,7 +8562,7 @@
<refsect1>
<title>Common Uses</title>
- <para>lock notification</para>
+ <para>Lock notification</para>
</refsect1>
</refentry>
@@ -8507,18 +8584,19 @@
<refsect1>
<title>Description</title>
- <para>The pre-unlock hook runs whenever someone attempts to
- remove a lock on a file. It can be used to create policies
- that specify which users are allowed to unlock particular
- paths. It's particularly important for determining policies
- about lock breakage. If user A locks a file, is user B
- allowed to break the lock? What if the lock is more than a
- week old? These sorts of things can be decided and enforced
- by the hook.</para>
-
- <para>If the pre-unlock hook program returns a non-zero exit
- value, the unlock action is aborted and anything printed to
- stderr is marshalled back to the client.</para>
+ <para>The <literal>pre-unlock</literal> hook runs whenever
+ someone attempts to remove a lock on a file. It can be used
+ to create policies that specify which users are allowed to
+ unlock particular paths. It's particularly important for
+ determining policies about lock breakage. If user A locks a
+ file, is user B allowed to break the lock? What if the lock
+ is more than a week old? These sorts of things can be
+ decided and enforced by the hook.</para>
+
+ <para>If the <literal>pre-unlock</literal> hook program
+ returns a nonzero exit value, the unlock action is aborted
+ and anything printed to stderr is marshalled back to the
+ client.</para>
</refsect1>
@@ -8530,13 +8608,13 @@
<orderedlist>
<listitem>
- <para>repository path</para>
+ <para>Repository path</para>
</listitem>
<listitem>
- <para>versioned path which is to be locked</para>
+ <para>Versioned path which is to be locked</para>
</listitem>
<listitem>
- <para>authenticated username of the person attempting the
+ <para>Authenticated username of the person attempting the
lock</para>
</listitem>
</orderedlist>
@@ -8544,7 +8622,7 @@
<refsect1>
<title>Common Uses</title>
- <para>access control</para>
+ <para>Access control</para>
</refsect1>
</refentry>
@@ -8566,12 +8644,16 @@
<refsect1>
<title>Description</title>
- <para>The post-unlock hook runs after one or more paths has
- been unlocked. It is typically used to send email
- notification of the unlock event.</para>
-
- <para>The output from and exit value returned by, the
- post-unlock hook program are ignored.</para>
+ <para>The <literal>post-unlock</literal> hook runs after one
+ or more paths has been unlocked. It is typically used to
+ send email notification of the unlock event.</para>
+
+ <para>If the <literal>post-unlock</literal> hook returns a
+ nonzero exit status, the unlock <emphasis>will
+ not</emphasis> be aborted since it has already
+ completed. However, anything that the hook printed
+ to <literal>STDERR</literal> will be marshalled back to the
+ client, making it easier to diagnose hook failures.</para>
</refsect1>
@@ -8583,10 +8665,10 @@
<orderedlist>
<listitem>
- <para>repository path</para>
+ <para>Repository path</para>
</listitem>
<listitem>
- <para>authenticated username of the person who unlocked the
+ <para>Authenticated username of the person who unlocked the
paths</para>
</listitem>
</orderedlist>
@@ -8598,7 +8680,7 @@
<refsect1>
<title>Common Uses</title>
- <para>unlock notification</para>
+ <para>Unlock notification</para>
</refsect1>
</refentry>
More information about the svnbook-dev
mailing list