[svnbook commit] r3049 - trunk/src/en/book
fitz
noreply at red-bean.com
Sat May 3 20:55:55 CDT 2008
Author: fitz
Date: Sat May 3 20:55:55 2008
New Revision: 3049
Log:
Copyedits for the rest of Chapter 9.
* src/en/book/ch06-server-configuration.xml: Title tweak.
* src/en/book/ch09-reference.xml: Finish chapter copyedits.
Modified:
trunk/src/en/book/ch06-server-configuration.xml
trunk/src/en/book/ch09-reference.xml
Modified: trunk/src/en/book/ch06-server-configuration.xml
==============================================================================
--- trunk/src/en/book/ch06-server-configuration.xml (original)
+++ trunk/src/en/book/ch06-server-configuration.xml Sat May 3 20:55:55 2008
@@ -440,7 +440,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
Modified: trunk/src/en/book/ch09-reference.xml
==============================================================================
--- trunk/src/en/book/ch09-reference.xml (original)
+++ trunk/src/en/book/ch09-reference.xml Sat May 3 20:55:55 2008
@@ -4992,7 +4992,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
@@ -5008,7 +5008,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>
@@ -5019,10 +5019,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>
@@ -5038,7 +5038,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>
@@ -5280,14 +5280,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
@@ -5296,7 +5296,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>.
@@ -5307,10 +5307,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>
@@ -5449,10 +5449,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>
@@ -5505,9 +5505,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
@@ -5561,7 +5561,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
@@ -5662,7 +5662,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>List all outstanding transactions in a
repository.</para>
@@ -5793,7 +5793,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
@@ -5852,7 +5852,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>
@@ -5869,7 +5869,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>
@@ -5878,16 +5878,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,
@@ -5907,7 +5908,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>
@@ -5945,17 +5946,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>
@@ -5980,7 +5981,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>
@@ -5999,8 +6000,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>
@@ -6160,7 +6161,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows the contents of a file in transaction
<literal>ax8</literal>, located at
@@ -6212,44 +6213,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>
@@ -6265,7 +6267,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
@@ -6341,7 +6343,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows the date of revision 40 of a test
repository:</para>
@@ -6390,7 +6392,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows a newly added (empty) file, a deleted
file, and a copied file:</para>
@@ -6420,7 +6422,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>
@@ -6460,7 +6462,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows the directories that changed in
revision 40 in our sample repository:</para>
@@ -6491,10 +6493,11 @@
<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>
@@ -6540,11 +6543,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
@@ -6589,7 +6592,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>
@@ -6603,10 +6606,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
@@ -6653,10 +6656,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
@@ -6705,7 +6708,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows the log output for revision 40 in our sample
repository:</para>
@@ -6759,7 +6762,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
@@ -6857,7 +6860,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>
@@ -6874,9 +6877,9 @@
</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>
@@ -6914,7 +6917,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
@@ -6922,7 +6925,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<screen>
$ svnlook uuid /var/svn/repos
@@ -6955,7 +6958,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>This shows the youngest revision of our sample
repository:</para>
@@ -7024,7 +7027,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>
@@ -7032,9 +7035,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>
@@ -7071,7 +7074,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">
@@ -7105,7 +7108,7 @@
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>
@@ -7127,9 +7130,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
@@ -7163,16 +7166,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>
@@ -7202,8 +7205,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
@@ -7246,7 +7249,7 @@
</refsect1>
<refsect1>
- <title>Alternate Names</title>
+ <title>Alternate Name</title>
<para>sync</para>
</refsect1>
@@ -7263,7 +7266,7 @@
</refsect1>
<refsect1>
- <title>Examples</title>
+ <title>Example</title>
<para>Copy unsynchronized revisions from the source
repository to the mirror repository:</para>
@@ -7328,8 +7331,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>
@@ -7338,8 +7341,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>
@@ -7348,7 +7352,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>
@@ -7367,8 +7371,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>
@@ -7391,8 +7394,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>
@@ -7403,7 +7406,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>
@@ -7414,15 +7417,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>
@@ -7446,7 +7450,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>
@@ -7456,8 +7460,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>
@@ -7521,8 +7526,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>
@@ -7639,8 +7644,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>
@@ -7667,7 +7672,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>
@@ -7678,7 +7684,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
@@ -7686,7 +7692,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>
@@ -7712,11 +7718,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>
@@ -7766,8 +7772,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>
@@ -7776,9 +7783,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>
@@ -7808,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
@@ -7920,16 +7929,8 @@
</listitem>
</varlistentry>
- <varlistentry>
- <term></term>
- <listitem>
- <para></para>
- </listitem>
- </varlistentry>
-
</variablelist>
-
</refsect1>
</refentry>
@@ -7940,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
@@ -7991,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>
@@ -8015,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>
@@ -8150,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>
@@ -8165,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
@@ -8183,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>
@@ -8209,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>
@@ -8232,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>
@@ -8264,15 +8265,16 @@
<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>The output from and the exit value returned by the
+ <literal>post-commit</literal> hook program are
+ ignored.</para>
</refsect1>
@@ -8284,17 +8286,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>
@@ -8317,18 +8319,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>
@@ -8340,19 +8342,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>
@@ -8365,7 +8367,7 @@
<refsect1>
<title>Common Uses</title>
- <para>access control, change validation and control</para>
+ <para>Access control; change validation and control</para>
</refsect1>
</refentry>
@@ -8388,17 +8390,19 @@
<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 <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>The output from, and exit value returned by, the
- post-revprop-change hook program are ignored.</para>
+ <literal>post-revprop-change</literal> hook program is
+ ignored.</para>
</refsect1>
@@ -8410,19 +8414,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>
@@ -8457,16 +8461,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>
@@ -8478,13 +8484,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>
@@ -8492,7 +8498,7 @@
<refsect1>
<title>Common Uses</title>
- <para>access control</para>
+ <para>Access control</para>
</refsect1>
</refentry>
@@ -8514,12 +8520,13 @@
<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>The output from and exit value returned by
+ the <literal>post-lock</literal> hook program is
+ ignored.</para>
</refsect1>
@@ -8531,10 +8538,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>
@@ -8546,7 +8553,7 @@
<refsect1>
<title>Common Uses</title>
- <para>lock notification</para>
+ <para>Lock notification</para>
</refsect1>
</refentry>
@@ -8568,18 +8575,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>
@@ -8591,13 +8599,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>
@@ -8605,7 +8613,7 @@
<refsect1>
<title>Common Uses</title>
- <para>access control</para>
+ <para>Access control</para>
</refsect1>
</refentry>
@@ -8627,12 +8635,13 @@
<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 <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>The output from and exit value returned by, the
- post-unlock hook program are ignored.</para>
+ <literal>post-unlock</literal> hook program is
+ ignored.</para>
</refsect1>
@@ -8644,10 +8653,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>
@@ -8659,7 +8668,7 @@
<refsect1>
<title>Common Uses</title>
- <para>unlock notification</para>
+ <para>Unlock notification</para>
</refsect1>
</refentry>
More information about the svnbook-dev
mailing list