[svnbook commit] r3244 - trunk/src/en/book
fitz
noreply at red-bean.com
Wed Aug 6 00:38:42 CDT 2008
Author: fitz
Date: Wed Aug 6 00:38:41 2008
New Revision: 3244
Log:
Second round of copyedits for chapter 9, part 3 of 3.
Done. *whew*
* src/en/book/ch09-reference.xml: Copyedit.
Modified:
trunk/src/en/book/ch09-reference.xml
Modified: trunk/src/en/book/ch09-reference.xml
==============================================================================
--- trunk/src/en/book/ch09-reference.xml (original)
+++ trunk/src/en/book/ch09-reference.xml Wed Aug 6 00:38:41 2008
@@ -5677,7 +5677,7 @@
<refnamediv>
<refname>svnadmin dump</refname>
- <refpurpose>Dump the contents of the filesystem to stdout.</refpurpose>
+ <refpurpose>Dump the contents of the filesystem to <literal>stdout</literal>.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -6327,7 +6327,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>Set the log message for revision 19 to the contents of
the file <filename>msg</filename>:</para>
@@ -6364,8 +6364,7 @@
<option>--use-pre-revprop-change-hook</option>
or <option>--use-post-revprop-change-hook</option> to
trigger the revision property-related hooks (e.g., if
- you want an email notification sent from your post
- revprop change hook).</para>
+ you want an email notification sent from your <literal>post-revprop-change-hook</literal>).</para>
</refsect1>
@@ -6384,7 +6383,7 @@
<para>The following sets the revision
property <literal>repository-photo</literal> to the contents
- of the file <literal>sandwich.png</literal>:</para>
+ of the file <filename>sandwich.png</filename>:</para>
<screen>
$svnadmin setrevprop /var/svn/repos -r 0 repository-photo sandwich.png
@@ -6419,7 +6418,7 @@
at <replaceable>REPOS_PATH</replaceable>.
If <replaceable>NEW_UUID</replaceable> is provided, use
that as the new repository UUID; otherwise, generate a
- brand new UUID for the repository.</para>
+ brand-new UUID for the repository.</para>
</refsect1>
@@ -6437,7 +6436,7 @@
to <filename>/var/svn/repos-new</filename> and intend to use <filename>repos-new</filename> as your
canonical repository, you may want to change the UUID for
<filename>repos-new</filename> to the UUID of <filename>repos</filename> so that your users don't
- have to check out a new working copy to accomodate the
+ have to check out a new working copy to accommodate the
change:</para>
<screen>
@@ -6481,12 +6480,12 @@
operation. As such, the upgrade performs only the
minimum amount of work needed to accomplish this while
still maintaining the integrity of the repository.
- While a dump and subsequent load guarantees the most
+ While a dump and subsequent load guarantee the most
optimized repository state, <command>svnadmin
upgrade</command> does not.</para>
<warning>
- <para>You should <emphasis>always</emphasis> backup your
+ <para>You should <emphasis>always</emphasis> back up your
repository before upgrading.</para>
</warning>
@@ -6503,7 +6502,7 @@
<title>Examples</title>
<para>Upgrade the repository at
- path <filename>/var/repos/svn</filename></para>
+ path <filename>/var/repos/svn</filename>:</para>
<screen>
$ svnadmin upgrade /var/repos/svn
@@ -6544,7 +6543,7 @@
to run this on a regular basis to guard against latent
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
+ a problem—that means your repository has at
least one corrupted revision, and you should restore the
corrupted revision from a backup (you did make a backup,
didn't you?).</para>
@@ -6561,7 +6560,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>Verify a hung repository:</para>
@@ -6581,7 +6580,7 @@
<!-- ================================================================= -->
<!-- ================================================================= -->
<sect1 id="svn.ref.svnlook">
- <title><command>svnlook</command></title>
+ <title>svnlook</title>
<para><command>svnlook</command> is a command-line utility for
examining different aspects of a Subversion repository. It
@@ -6592,7 +6591,7 @@
useful for diagnostic purposes.</para>
<para>Since <command>svnlook</command> works via direct repository access
- (and thus can only be used on the machine that holds the
+ (and thus can be used only on the machine that holds the
repository), it refers to the repository with a path, not a URL.</para>
<para>If no revision or transaction is specified,
@@ -6601,12 +6600,12 @@
<!-- =============================================================== -->
<sect2 id="svn.ref.svnlook.sw">
- <title><command>svnlook</command> Options</title>
+ <title>svnlook Options</title>
<para>Options in <command>svnlook</command> are global, just
like in <command>svn</command> and
<command>svnadmin</command>; however, most options apply
- only to one subcommand since the functionality of
+ to only one subcommand since the functionality of
<command>svnlook</command> is (intentionally) limited in
scope.</para>
@@ -6646,7 +6645,7 @@
<term><option>--revision</option>
(<option>-r</option>)</term>
<listitem>
- <para>Specify a particular revision number that you wish
+ <para>Specifies a particular revision number that you wish
to examine.</para>
</listitem>
</varlistentry>
@@ -6666,7 +6665,7 @@
<term><option>--transaction</option>
(<option>-t</option>)</term>
<listitem>
- <para>Specify a particular transaction ID that you wish to
+ <para>Specifies a particular transaction ID that you wish to
examine.</para>
</listitem>
</varlistentry>
@@ -6674,7 +6673,7 @@
<varlistentry>
<term><option>--show-ids</option></term>
<listitem>
- <para>Show the filesystem node revision IDs for each path in the filesystem
+ <para>Shows the filesystem node revision IDs for each path in the filesystem
tree.</para>
</listitem>
</varlistentry>
@@ -6685,7 +6684,10 @@
<!-- =============================================================== -->
<sect2 id="svn.ref.svnlook.c">
- <title><command>svnlook</command> Subcommands</title>
+ <title>svnlook Subcommands</title>
+
+ <para>Here are the various subcommands
+ for <command>svnlook</command>.</para>
<refentry id="svn.ref.svnlook.c.author">
@@ -6766,7 +6768,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>This shows the contents of a file in transaction
<literal>ax8</literal>, located at
@@ -6872,7 +6874,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>This shows a list of all the changed files and
directories in revision 39 of a test repository. Note
@@ -6900,7 +6902,7 @@
D trunk/vendors/baker/bread.txt
</screen>
- <para>Unfortunately, nothing in the previous output reveals
+ <para>Unfortunately, nothing in the preceding output reveals
the connection between the deleted and added files. Use
the <option>--copy-info</option> option to make this
relationship more apparent:</para>
@@ -6948,7 +6950,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>This shows the date of revision 40 of a test
repository:</para>
@@ -6997,7 +6999,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>This shows a newly added (empty) file, a deleted
file, and a copied file:</para>
@@ -7028,7 +7030,7 @@
</screen>
<para>If a file has a nontextual
- <literal>svn:mime-type</literal> property, then the
+ <literal>svn:mime-type</literal> property, the
differences are not explicitly shown.</para>
</refsect1>
</refentry>
@@ -7067,7 +7069,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>This shows the directories that changed in
revision 40 in our sample repository:</para>
@@ -7100,7 +7102,7 @@
<para>Displays the help message
for <command>svnlook</command>. This command, like its
- brother <command>svn help</command>, is also your friend,
+ 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>
@@ -7112,7 +7114,7 @@
<refsect1>
<title>Alternate names</title>
- <para>?, h</para>
+ <para><command>?</command>, <command>h</command></para>
</refsect1>
</refentry>
@@ -7154,7 +7156,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>This shows the history output for the path
<filename>/branches/bookstore</filename> as of revision 13 in our
@@ -7215,7 +7217,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>This shows the info output for revision 40 in our
sample repository:</para>
@@ -7265,7 +7267,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>This describes the lock on the file
<filename>tree.jpg</filename>:</para>
@@ -7317,7 +7319,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>This shows the log output for revision 40 in our sample
repository:</para>
@@ -7357,7 +7359,7 @@
<refsect1>
<title>Alternate names</title>
- <para>pg, pget</para>
+ <para><command>pg</command>, <command>pget</command></para>
</refsect1>
<refsect1>
@@ -7371,7 +7373,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>This shows the value of the <quote>seasonings</quote> property
on the file <filename>/trunk/sandwich</filename> in the
@@ -7412,7 +7414,7 @@
<refsect1>
<title>Alternate names</title>
- <para>pl, plist</para>
+ <para><command>pl</command>, <command>plist</command></para>
</refsect1>
<refsect1>
@@ -7439,7 +7441,7 @@
svn:mime-type
</screen>
- <para>This is the same command as in the previous example,
+ <para>This is the same command as in the preceding example,
but this time showing the property values as well:</para>
<screen>
@@ -7543,7 +7545,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<screen>
$ svnlook uuid /var/svn/repos
@@ -7581,7 +7583,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>This shows the youngest revision of our sample
repository:</para>
@@ -7602,7 +7604,7 @@
<!-- ================================================================= -->
<sect1 id="svn.ref.svnsync">
- <title><command>svnsync</command></title>
+ <title>svnsync</title>
<para><command>svnsync</command> is the Subversion remote
repository mirroring tool. Put simply, it allows you to replay
@@ -7631,7 +7633,10 @@
<!-- =============================================================== -->
<sect2 id="svn.ref.svnsync.sw">
- <title><command>svnsync</command> Options</title>
+ <title>svnsync Options</title>
+
+ <para>Here are the various subcommands
+ for <command>svnsync</command>.</para>
<variablelist>
@@ -7661,7 +7666,7 @@
<para>In the case of an authentication failure or
insufficient credentials, prevents prompting for
credentials (e.g., username or password). This is useful
- if you're running Subversion inside of an automated
+ if you're running Subversion inside an automated
script and it's more appropriate to have Subversion fail
than to prompt for more information.</para>
</listitem>
@@ -7725,7 +7730,7 @@
<!-- =============================================================== -->
<sect2 id="svn.ref.svnsync.c">
- <title><command>svnsync</command> Subcommands</title>
+ <title>svnsync Subcommands</title>
<para>The following lists the various subcommands.</para>
@@ -7786,7 +7791,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>Resynchronize revision properties for a single revision:</para>
@@ -7819,8 +7824,8 @@
<title>Description</title>
<para>This subcommand is useful when you're trapped in a
- foreign prison with neither a net connection nor a copy of
- this book, but you do have a local wifi network running
+ foreign prison with neither a Net connection nor a copy of
+ this book, but you do have a local Wi-Fi network running
and you'd like to sync a copy of your repository over to
the backup server that Ira The Knife is running over in
cell block D.</para>
@@ -7850,7 +7855,7 @@
<refnamediv>
<refname>svnsync initialize</refname>
<refpurpose>Initialize a mirror repository for
- synchronization from source repository.</refpurpose>
+ synchronization from the source repository.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -7872,7 +7877,7 @@
<refsect1>
<title>Alternate name</title>
- <para>init</para>
+ <para><command>init</command></para>
</refsect1>
<refsect1>
@@ -7940,13 +7945,13 @@
does all the heavy lifting of a repository mirroring
operation. After consulting with the mirror repository to
see which revisions have already been copied into it, it
- then begins copying any not-yet-mirrored revisions from
+ then begins to copy any not-yet-mirrored revisions from
the source repository.</para>
<para><command>svnsync synchronize</command> can be
- gracefully cancelled and restarted.</para>
+ gracefully canceled and restarted.</para>
- <para>As of Subversion 1.5, you can limit svnsync to a
+ <para>As of Subversion 1.5, you can limit <command>svnsync</command> to a
subdirectory of the source repository by specifying the
subdirectory as part of
the <replaceable>SOURCE_URL</replaceable>.</para>
@@ -7955,7 +7960,7 @@
<refsect1>
<title>Alternate name</title>
- <para>sync</para>
+ <para><command>sync</command></para>
</refsect1>
<refsect1>
@@ -7974,7 +7979,7 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>Copy unsynchronized revisions from the source
repository to the mirror repository:</para>
@@ -8009,7 +8014,7 @@
<!-- ================================================================= -->
<sect1 id="svn.ref.svnserve">
- <title><command>svnserve</command></title>
+ <title>svnserve</title>
<para><command>svnserve</command> allows access to Subversion
repositories using Subversion's custom network protocol.</para>
@@ -8035,7 +8040,7 @@
<!-- =============================================================== -->
<sect2 id="svn.ref.svnserve.sw">
- <title><command>svnserve</command> Options</title>
+ <title>svnserve Options</title>
<para>Unlike the previous commands we've
described, <command>svnserve</command> has no
@@ -8058,8 +8063,8 @@
<varlistentry>
<term><option>--foreground</option></term>
<listitem>
- <para>When used together with <option>-d</option>, this
- option causes <command>svnserve</command> to stay in the
+ <para>When used together with <option>-d</option>,
+ causes <command>svnserve</command> to stay in the
foreground. This is mainly useful for debugging.</para>
</listitem>
</varlistentry>
@@ -8068,7 +8073,7 @@
<term><option>--inetd</option> (<option>-i</option>)</term>
<listitem>
<para>Causes <command>svnserve</command> to use the
- stdin/stdout file descriptors, as is appropriate for a
+ <literal>stdin</literal>/<literal>stdout</literal> file descriptors, as is appropriate for a
daemon running out of <command>inetd</command>.</para>
</listitem>
</varlistentry>
@@ -8102,7 +8107,7 @@
<varlistentry>
<term><option>--listen-port</option>=<replaceable>PORT</replaceable></term>
<listitem>
- <para>Causes svnserve to listen on
+ <para>Causes <command>svnserve</command> to listen on
<replaceable>PORT</replaceable> when run in daemon mode.
(FreeBSD daemons listen only on tcp6 by default—this
option tells them to also listen on tcp4.)</para>
@@ -8114,7 +8119,7 @@
<listitem>
<para>Causes <command>svnserve</command> to write its
process ID to <replaceable>FILENAME</replaceable>, which
- must be writeable by the user under
+ must be writable by the user under
which <command>svnserve</command> is running.</para>
</listitem>
</varlistentry>
@@ -8148,13 +8153,13 @@
<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, and then exit), except that the connection
+ <literal>stdin</literal>/<literal>stdout</literal>, 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
+ 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
@@ -8167,11 +8172,11 @@
<term><option>--tunnel-user NAME</option></term>
<listitem>
<para>Used in conjunction with the <option>--tunnel</option>
- option; tells svnserve to assume that
+ option, tells <command>svnserve</command> to assume that
<replaceable>NAME</replaceable> is the authenticated
- user, rather than the UID of the svnserve
- process. Useful for users wishing to share a single
- system account over SSH, but maintaining separate commit
+ user, rather than the UID of the <command>svnserve</command>
+ process. This is useful for users wishing to share a single
+ system account over SSH, but to maintain separate commit
identities.</para>
</listitem>
</varlistentry>
@@ -8194,7 +8199,7 @@
<!-- ================================================================= -->
<!-- ================================================================= -->
<sect1 id="svn.ref.svndumpfilter">
- <title><command>svndumpfilter</command></title>
+ <title>svndumpfilter</title>
<para><command>svndumpfilter</command> is a command-line utility
for removing history from a Subversion dumpfile by either
@@ -8204,11 +8209,11 @@
<!-- =============================================================== -->
<sect2 id="svn.ref.svndumpfilter.options">
- <title><command>svndumpfilter</command> Options</title>
+ <title>svndumpfilter Options</title>
<para>Options in <command>svndumpfilter</command> are global, just
like in <command>svn</command> and
- <command>svnadmin</command>.</para>
+ <command>svnadmin</command>:</para>
<variablelist>
@@ -8216,7 +8221,7 @@
<term><option>--drop-empty-revs</option></term>
<listitem>
<para>If filtering causes any revision to be empty (i.e.,
- cause no change to the repository), remove these
+ causes no change to the repository), removes these
revisions from the final dumpfile.</para>
</listitem>
</varlistentry>
@@ -8224,7 +8229,7 @@
<varlistentry>
<term><option>--renumber-revs</option></term>
<listitem>
- <para>Renumbering revisions that remain after
+ <para>Renumber revisions that remain after
filtering.</para>
</listitem>
</varlistentry>
@@ -8232,7 +8237,7 @@
<varlistentry>
<term><option>--skip-missing-merge-sources</option></term>
<listitem>
- <para>Skip merge sources that have been removed as part of
+ <para>Skips merge sources that have been removed as part of
the filtering. Without this
option, <command>svndumpfilter</command> will exit with
an error if the merge source for a retained path is
@@ -8258,7 +8263,7 @@
<varlistentry>
<term><option>--quiet</option></term>
<listitem>
- <para>Do not display filtering statistics.</para>
+ <para>Does not display filtering statistics.</para>
</listitem>
</varlistentry>
@@ -8268,7 +8273,9 @@
<!-- =============================================================== -->
<sect2 id="svn.ref.svndumpfilter.c">
- <title><command>svndumpfilter</command> Subcommands</title>
+ <title>svndumpfilter Subcommands</title>
+
+ <para>The following lists the various subcommands for <command>svndumpfilter</command>.</para>
<refentry id="svn.ref.svndumpfilter.commands.c.exclude">
@@ -8280,7 +8287,7 @@
<refnamediv>
<refname>svndumpfilter exclude</refname>
- <refpurpose>Filter out nodes with given prefixes from dumpstream.</refpurpose>
+ <refpurpose>Filter out nodes with given prefixes from the dumpstream.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -8289,7 +8296,7 @@
<refsect1>
<title>Description</title>
- <para>Can be used to exclude nodes that begin with one or
+ <para>This can be used to exclude nodes that begin with one or
more <replaceable>PATH_PREFIX</replaceable>es from a
filtered dumpfile.</para>
</refsect1>
@@ -8307,10 +8314,10 @@
</refsect1>
<refsect1>
- <title>Example</title>
+ <title>Examples</title>
<para>If we have a dumpfile from a repository with a number of
- different picnic-related directories in it, but want to keep
+ different picnic-related directories in it, but we want to keep
everything <emphasis>except</emphasis>
the <filename>sandwiches</filename> part of the repository,
we'll exclude only that path:</para>
@@ -8333,12 +8340,6 @@
</refsect1>
</refentry>
- </sect2>
-
- <!-- =============================================================== -->
- <sect2 id="svn.ref.svndumpfilter.c.include">
- <title><command>svndumpfilter</command> Subcommands</title>
-
<refentry id="svn.ref.svndumpfilter.commands.c.include">
<indexterm>
@@ -8381,7 +8382,7 @@
<para>If we have a dumpfile from a repository with a number of
different picnic-related directories in it, but only want to
- keep the <filename>sandwiches</filename> part of the
+ keep only the <filename>sandwiches</filename> part of the
repository, we'll include only that path:</para>
<screen>
@@ -8404,12 +8405,6 @@
</refsect1>
</refentry>
- </sect2>
-
- <!-- =============================================================== -->
- <sect2 id="svn.ref.svndumpfilter.c.help">
- <title><command>svndumpfilter</command> Subcommands</title>
-
<refentry id="svn.ref.svndumpfilter.commands.c.help">
<indexterm>
@@ -8482,7 +8477,7 @@
when defining the version number of your program.</para>
<para><replaceable>TRAIL_URL</replaceable>, if present, is the
- trailing portion of the URL used to determine if
+ trailing portion of the URL used to determine whether
<replaceable>WC_PATH</replaceable> itself is switched
(detection of switches within
<replaceable>WC_PATH</replaceable> does not rely on
@@ -8501,21 +8496,21 @@
<para>Like <command>svnserve</command>,
<command>svnversion</command> has no subcommands—only
- options.</para>
+ options:</para>
<variablelist>
<varlistentry>
<term><option>--no-newline</option> (<option>-n</option>)</term>
<listitem>
- <para>Omit the usual trailing newline from the output.</para>
+ <para>Omits the usual trailing newline from the output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--committed</option> (<option>-c</option>)</term>
<listitem>
- <para>Use the last-changed revisions rather than the
+ <para>Uses the last-changed revisions rather than the
current (i.e., highest locally available) revisions.</para>
</listitem>
</varlistentry>
@@ -8523,14 +8518,14 @@
<varlistentry>
<term><option>--help</option> (<option>-h</option>)</term>
<listitem>
- <para>Print a help summary.</para>
+ <para>Prints a help summary.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem>
- <para>Print the version of <command>svnversion</command>
+ <para>Prints the version of <command>svnversion</command>
and exit with no error.</para>
</listitem>
</varlistentry>
@@ -8541,8 +8536,8 @@
<refsect1 id="svn.ref.svnversion.re.examples">
<title>Examples</title>
- <para>If the working copy is all at the same revision (for
- example, immediately after an update), then that revision is
+ <para>If the working copy is all at the same revision (e.g.,
+ immediately after an update), then that revision is
printed out:</para>
<screen>
@@ -8551,7 +8546,7 @@
</screen>
<para>You can add <replaceable>TRAIL_URL</replaceable> to make
- sure that the working copy is not switched from what you
+ sure the working copy is not switched from what you
expect. Note that the <replaceable>WC_PATH</replaceable>
is required in this command:</para>
@@ -8611,12 +8606,12 @@
<!-- ================================================================= -->
<sect1 id="svn.ref.mod_dav_svn">
- <title><command>mod_dav_svn</command></title>
+ <title>mod_dav_svn</title>
<refentry id="svn.ref.mod_dav_svn.conf">
<refnamediv>
- <refname><literal>mod_dav_svn</literal> Configuration
+ <refname><command>mod_dav_svn</command> Configuration
Directives</refname> <refpurpose>Apache configuration
directives for serving Subversion repositories through the
Apache HTTP Server.</refpurpose>
@@ -8626,8 +8621,8 @@
<refsect1 id="svn.ref.mod_dav_svn.conf.desc">
<title>Description</title>
- <para>This section briefly describes each of the Subversion
- Apache configuration directives. For an in-depth
+ <para>This section briefly describes each Subversion
+ Apache configuration directive. For an in-depth
description of configuring Apache with Subversion, see <xref
linkend="svn.serverconfig.httpd"/>.)</para>
@@ -8636,16 +8631,19 @@
<refsect1 id="svn.ref.mod_dav_svn.conf.directives">
<title>Directives</title>
+ <para>These are the <filename>httpd.conf</filename> directives
+ that apply to <command>mod_dav_svn</command>:</para>
+
<variablelist>
<varlistentry>
<term><literal>DAV svn</literal></term>
<listitem>
- <para>This directive must be included in any
+ <para>Must be included in any
<literal>Directory</literal> or
<literal>Location</literal> block for a Subversion
- repository. It tells httpd to use the Subversion
+ repository. It tells <command>httpd</command> to use the Subversion
backend for <literal>mod_dav</literal> to handle all
requests.</para>
@@ -8656,12 +8654,12 @@
<term><literal>SVNAllowBulkUpdates On|Off</literal></term>
<listitem>
- <para>This directive toggles support for all-inclusive
+ <para>Toggles support for all-inclusive
responses to update-style <literal>REPORT</literal>
requests. Subversion clients use
<literal>REPORT</literal> requests to get information
about directory tree checkouts and updates from
- <literal>mod_dav_svn</literal>. They can ask the
+ <command>mod_dav_svn</command>. They can ask the
server to send that information in one of two ways:
with the entirety of the tree's information in one
massive response, or with a
@@ -8671,7 +8669,7 @@
<emphasis>additional</emphasis> data to request from
the server. When this directive is included with a
value of <literal>off</literal>,
- <literal>mod_dav_svn</literal> will only ever respond
+ <command>mod_dav_svn</command> will only ever respond
to these <literal>REPORT</literal> requests with
skelta responses, regardless of the type of responses
requested by the client.</para>
@@ -8692,11 +8690,11 @@
<term><literal>SVNAutoversioning On|Off</literal></term>
<listitem>
- <para>This directive, when its value is
+ <para>When its value is
<literal>on</literal>, allows write requests from
WebDAV clients to result in automatic commits. A
- generic log message is autogenerated and attached to
- each revision. If you enable Autoversioning, you'll
+ generic log message is auto-generated 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 <literal>svn:mime-type</literal> to the correct
@@ -8714,7 +8712,7 @@
<replaceable>directory-path</replaceable></literal></term>
<listitem>
- <para>This directive specifies the location in the
+ <para>Specifies the location in the
filesystem for a Subversion repository's files. In a
configuration block for a Subversion repository,
either this directive or
@@ -8731,7 +8729,7 @@
<para>Specifies the URI component (namespace) for
special Subversion resources. The default is
- <quote><literal>!svn</literal></quote>, and most
+ <literal>!svn</literal>, and most
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.
@@ -8789,7 +8787,7 @@
<replaceable>file-path</replaceable></literal></term>
<listitem>
- <para>Control path-based authorization by enabling or
+ <para>Controls path-based authorization by enabling or
disabling subrequests. See
<xref linkend="svn.serverconfig.httpd.authz.pathauthzoff"/>
for details.</para>
@@ -8829,14 +8827,14 @@
<para>Specifies the location in the filesystem where the
activities database should be stored. By default,
- mod_dav_svn creates and uses a directory in the
+ <command>mod_dav_svn</command> 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
+ an <literal>SVNParentPath</literal> area, <command>mod_dav_svn</command>
appends the basename of the repository to the path
specified here. For example:</para>
@@ -8895,7 +8893,7 @@
</varlistentry>
<varlistentry>
- <term>Fetching a directory</term>
+ <term>Fetch a directory</term>
<listitem>
<para><literal>get-dir /trunk r17 text</literal></para>
</listitem>
@@ -8909,14 +8907,14 @@
</varlistentry>
<varlistentry>
- <term>Fetch file revision</term>
+ <term>Fetch a file revision</term>
<listitem>
<para><literal>get-file-revs /path r12:15 include-merged-revisions</literal></para>
</listitem>
</varlistentry>
<varlistentry>
- <term>Fetching of merge information</term>
+ <term>Fetch merge information</term>
<listitem>
<para><literal>get-mergeinfo (/path1 /path2)</literal></para>
</listitem>
@@ -8938,7 +8936,7 @@
</varlistentry>
<varlistentry>
- <term>Replaying of revisions (svnsync)</term>
+ <term>Replay revisions (svnsync)</term>
<listitem>
<para><literal>replay /path r19</literal></para>
</listitem>
@@ -9002,7 +9000,7 @@
<title>Subversion Properties</title>
- <para>Subversion allows users to invent arbitrarily-named
+ <para>Subversion allows users to invent arbitrarily named
versioned properties on files and directories, as well as
unversioned properties on revisions. The only restriction is on
properties whose names begin with <literal>svn:</literal> (those
@@ -9013,6 +9011,9 @@
<sect2 id="svn.ref.properties.versioned-props">
<title>Versioned Properties</title>
+ <para>These are the versioned properties tht Subversion reserves
+ for its own use:</para>
+
<variablelist>
<varlistentry>
@@ -9035,7 +9036,7 @@
file's MIME type. This allows the client to decide
whether line-based contextual merging is safe to
perform during updates, and can also affect how the
- file behaves when fetched via web browser. See
+ file behaves when fetched via a web browser. See
<xref
linkend="svn.advanced.props.special.mime-type"/>. </para>
@@ -9077,7 +9078,7 @@
to manipulate the file's line-endings in the working
copy and in exported trees. See <xref
linkend="svn.advanced.props.special.eol-style"/> and
- <xref linkend="svn.ref.svn.c.export" />.</para>
+ <xref linkend="svn.ref.svn.c.export" /> earlier in this chapter.</para>
</listitem>
</varlistentry>
@@ -9100,13 +9101,12 @@
<para>If present on a file, indicates that the file is not
an ordinary file, but a symbolic link or other special
- object.
- <footnote>
+ 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>
+ </footnote>.
</para>
</listitem>
@@ -9144,6 +9144,9 @@
<sect2 id="svn.ref.properties.unversioned-props">
<title>Unversioned Properties</title>
+ <para>These are the unversioned properties tht Subversion reserves
+ for its own use:</para>
+
<variablelist>
<varlistentry>
@@ -9152,7 +9155,7 @@
<para>If present, contains the authenticated username of
the person who created the revision. (If not present,
- then the revision was committed anonymously.)</para>
+ the revision was committed anonymously.)</para>
</listitem>
</varlistentry>
@@ -9201,6 +9204,9 @@
<sect1 id="svn.ref.reposhooks">
<title>Repository Hooks</title>
+
+ <para>These are the repository hooks that Subversion
+ provides:</para>
<!-- =============================================================== -->
<refentry id="svn.ref.reposhooks.start-commit">
@@ -9221,11 +9227,11 @@
<para>The start-commit hook is run before the commit
transaction is even created. It is typically used to
- decide if the user has commit privileges at all.</para>
+ decide whether the user has commit privileges at all.</para>
<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
+ is even created, and anything printed to <filename>stderr</filename> is
marshalled back to the client.</para>
</refsect1>
@@ -9244,17 +9250,17 @@
<para>Authenticated username attempting the commit</para>
</listitem>
<listitem>
- <para>(New in Subversion 1.5.) Colon-separated list of
+ <para>Colon-separated list of
capabilities that a client passes to the server,
including <literal>depth</literal>,
<literal>mergeinfo</literal>, and
- <literal>log-revprops</literal>.</para>
+ <literal>log-revprops</literal> (New in Subversion 1.5.).</para>
</listitem>
</orderedlist>
</refsect1>
<refsect1>
- <title>Common Uses</title>
+ <title>Common uses</title>
<para>Access control (e.g., temporarily lock out commits for
some reason).</para>
@@ -9285,7 +9291,7 @@
<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
+ are disallowed due to content or location (e.g., 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 nonempty).</para>
@@ -9293,12 +9299,12 @@
<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>
+ <filename>stderr</filename> is marshalled back to the client.</para>
</refsect1>
<refsect1>
- <title>Input Parameter(s)</title>
+ <title>Input parameter(s)</title>
<para>The command-line arguments passed to the hook program,
in order, are:</para>
@@ -9314,7 +9320,7 @@
</refsect1>
<refsect1>
- <title>Common Uses</title>
+ <title>Common uses</title>
<para>Change validation and control</para>
</refsect1>
@@ -9338,7 +9344,7 @@
<title>Description</title>
<para>The <literal>post-commit</literal> hook is run after the
- transaction is committed and a new revision created. Most
+ transaction is committed and a new revision is 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
@@ -9348,13 +9354,13 @@
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
+ to <literal>stderr</literal> will be marshalled back to the
client, making it easier to diagnose hook failures.</para>
</refsect1>
<refsect1>
- <title>Input Parameter(s)</title>
+ <title>Input parameter(s)</title>
<para>The command-line arguments passed to the hook program,
in order, are:</para>
@@ -9370,7 +9376,7 @@
</refsect1>
<refsect1>
- <title>Common Uses</title>
+ <title>Common uses</title>
<para>Commit notification; tool integration</para>
</refsect1>
@@ -9405,12 +9411,12 @@
<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>
+ printed to <literal>stderr</literal> is marshalled back to the client.</para>
</refsect1>
<refsect1>
- <title>Input Parameter(s)</title>
+ <title>Input parameter(s)</title>
<para>The command-line arguments passed to the hook program,
in order, are:</para>
@@ -9423,7 +9429,7 @@
<para>Revision whose property is about to be modified</para>
</listitem>
<listitem>
- <para>Authenticated username attempting the propchange</para>
+ <para>Authenticated username attempting the property change</para>
</listitem>
<listitem>
<para>Name of the property changed</para>
@@ -9442,7 +9448,7 @@
</refsect1>
<refsect1>
- <title>Common Uses</title>
+ <title>Common uses</title>
<para>Access control; change validation and control</para>
</refsect1>
@@ -9467,9 +9473,9 @@
<title>Description</title>
<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
+ immediately after the modification of a revision property
+ when performed outside the scope of a normal commit. As you can
+ derive 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
@@ -9480,13 +9486,13 @@
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
+ to <literal>stderr</literal> will be marshalled back to the
client, making it easier to diagnose hook failures.</para>
</refsect1>
<refsect1>
- <title>Input Parameter(s)</title>
+ <title>Input parameter(s)</title>
<para>The command-line arguments passed to the hook program,
in order, are:</para>
@@ -9517,8 +9523,8 @@
</refsect1>
<refsect1>
- <title>Common Uses</title>
- <para>propchange notification</para>
+ <title>Common uses</title>
+ <para>Property change notification</para>
</refsect1>
</refentry>
@@ -9544,19 +9550,19 @@
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
+ particular paths. If the hook notices a preexisting lock,
+ 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
+ anything printed to <literal>stderr</literal> is marshalled back to the
client.</para>
</refsect1>
<refsect1>
- <title>Input Parameter(s)</title>
+ <title>Input parameter(s)</title>
<para>The command-line arguments passed to the hook program,
in order, are:</para>
@@ -9576,7 +9582,7 @@
</refsect1>
<refsect1>
- <title>Common Uses</title>
+ <title>Common uses</title>
<para>Access control</para>
</refsect1>
@@ -9600,20 +9606,20 @@
<title>Description</title>
<para>The <literal>post-lock</literal> hook runs after one or
- more paths has been locked. It is typically used to send
+ more paths have 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
+ to <literal>stderr</literal> will be marshalled back to the
client, making it easier to diagnose hook failures.</para>
</refsect1>
<refsect1>
- <title>Input Parameter(s)</title>
+ <title>Input parameter(s)</title>
<para>The command-line arguments passed to the hook program,
in order, are:</para>
@@ -9634,7 +9640,7 @@
</refsect1>
<refsect1>
- <title>Common Uses</title>
+ <title>Common uses</title>
<para>Lock notification</para>
</refsect1>
@@ -9668,13 +9674,13 @@
<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
+ and anything printed to <literal>stderr</literal> is marshalled back to the
client.</para>
</refsect1>
<refsect1>
- <title>Input Parameter(s)</title>
+ <title>Input parameter(s)</title>
<para>The command-line arguments passed to the hook program,
in order, are:</para>
@@ -9694,7 +9700,7 @@
</refsect1>
<refsect1>
- <title>Common Uses</title>
+ <title>Common uses</title>
<para>Access control</para>
</refsect1>
@@ -9718,20 +9724,20 @@
<title>Description</title>
<para>The <literal>post-unlock</literal> hook runs after one
- or more paths has been unlocked. It is typically used to
+ or more paths have 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
+ to <literal>stderr</literal> will be marshalled back to the
client, making it easier to diagnose hook failures.</para>
</refsect1>
<refsect1>
- <title>Input Parameter(s)</title>
+ <title>Input parameter(s)</title>
<para>The command-line arguments passed to the hook program,
in order, are:</para>
@@ -9752,7 +9758,7 @@
</refsect1>
<refsect1>
- <title>Common Uses</title>
+ <title>Common uses</title>
<para>Unlock notification</para>
</refsect1>
More information about the svnbook-dev
mailing list