[svnbook] r3767 committed - * src/en/book/ch07-customizing-svn.xml...
svnbook at googlecode.com
svnbook at googlecode.com
Fri Aug 13 14:40:12 CDT 2010
Revision: 3767
Author: cmpilato at gmail.com
Date: Fri Aug 13 12:38:23 2010
Log: * src/en/book/ch07-customizing-svn.xml
Update some runtime configuration stuffs:
- refer to sections in the config files as [sectionname] (which
square braces) to help connect the reader visually with the
way those sections appear in the files themselves.
- document the 'password-stores' configuration (using a patch from
Nick Lewycky <nlewycky{__AT__}google.com> as a starting point).
- document that 'store-passwords' and 'store-auth-creds' are
deprecated from the 'config' file, and now live in the 'servers'
file.
http://code.google.com/p/svnbook/source/detail?r=3767
Modified:
/trunk/src/en/book/ch07-customizing-svn.xml
=======================================
--- /trunk/src/en/book/ch07-customizing-svn.xml Tue May 26 07:26:48 2009
+++ /trunk/src/en/book/ch07-customizing-svn.xml Fri Aug 13 12:38:23 2010
@@ -253,9 +253,9 @@
<para>The <filename>servers</filename> file contains
Subversion configuration options related to the network
- layers. There are two special section names in this
- file—<literal>groups</literal> and
- <literal>global</literal>. The <literal>groups</literal>
+ layers. There are two special sections in this
+ file—<literal>[groups]</literal> and
+ <literal>[global]</literal>. The <literal>[groups]</literal>
section is essentially a cross-reference table. The keys in
this section are the names of other sections in the file;
their values are <firstterm>globs</firstterm>—textual
@@ -277,19 +277,19 @@
<para>When Subversion is used over a network, it attempts to
match the name of the server it is trying to reach with a
- group name under the <literal>groups</literal> section. If
+ group name under the <literal>[groups]</literal> section. If
a match is made, Subversion then looks for a section in the
<filename>servers</filename> file whose name is the matched
group's name. From that section, it reads the actual network
configuration settings.</para>
- <para>The <literal>global</literal> section contains the
+ <para>The <literal>[global]</literal> section contains the
settings that are meant for all of the servers not matched
- by one of the globs under the <literal>groups</literal>
+ by one of the globs under the <literal>[groups]</literal>
section. The options available in this section are
exactly the same as those that are valid for the other server
sections in the file (except, of course, the special
- <literal>groups</literal> section), and are as
+ <literal>[groups]</literal> section), and are as
follows:</para>
<variablelist>
@@ -449,6 +449,37 @@
you can set this variable to the certificate's
passphrase. You won't be prompted anymore.</para>
</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>store-passwords</literal></term>
+ <listitem>
+ <para>This instructs Subversion to cache, or not to
+ cache, passwords that are supplied by the user in
+ response to server authentication challenges. The
+ default value is <literal>yes</literal>. Set this to
+ <literal>no</literal> to disable this on-disk password
+ caching. You can override this option for a single
+ instance of the <command>svn</command> command using
+ the <option>--no-auth-cache</option> command-line
+ parameter (for those subcommands that support it).
+ For more information regarding that, see
+ <xref linkend="svn.serverconfig.netmodel.credcache"/>.
Note that regardless of how this option is
+ configured, Subversion will not store passwords in
+ plaintext unless
+ the <literal>store-plaintext-passwords</literal>
+ option is also set to <literal>yes</literal>. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>store-auth-creds</literal></term>
+ <listitem>
+ <para>This setting is the same as
+ <literal>store-passwords</literal>, except that it
+ enables or disables on-disk caching of
+ <emphasis>all</emphasis> authentication information:
+ usernames, passwords, server certificates, and any
+ other types of cacheable credentials.</para>
+ </listitem>
</varlistentry>
<varlistentry>
<term><literal>store-plaintext-passwords</literal></term>
@@ -458,10 +489,6 @@
the password for the current authentication realm can
only be cached on disk in unencrypted form, in the
<filename>~/.subversion/auth/</filename> caching area.
- <!-- TODO: Using GNOME Keyring and KDE Wallet needs to
- be documented. Then:
- "See section xyz for information on how to configure
- an encrypted password cache on your system." -->
You can set it to <literal>yes</literal> or
<literal>no</literal> to enable or disable caching of
passwords in unencrypted form, respectively.
@@ -487,41 +514,52 @@
again grouped into sections in expectation of future
additions.</para>
- <para>The <literal>auth</literal> section contains settings
+ <para>The <literal>[auth]</literal> section contains settings
related to Subversion's authentication and authorization
against the repository. It contains the following:</para>
<variablelist>
<varlistentry>
+ <term><literal>password-stores</literal></term>
+ <listitem>
+ <para>This comma-delimited list specifies which (if any)
+ system-provided password stores Subversion should
+ attempt to use when saving and retrieving cached
+ authentication credentials, and in what order
+ Subversion should prefer them. The default value is
+ <literal>gnome-keyring, kwallet, keychain,
+ windows-crypto-api</literal>, representing the GNOME
+ Keyring, KDE Wallet, Mac OS X Keychain, and Microsoft
+ Windows cryptography API, respectively. Listed stores
+ which are not available on the system are
+ ignored.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><literal>store-passwords</literal></term>
<listitem>
- <para>This instructs Subversion to cache, or not to
- cache, passwords that are supplied by the user in
- response to server authentication challenges. The
- default value is <literal>yes</literal>. Set this to
- <literal>no</literal> to disable this on-disk password
- caching. You can override this option for a single
- instance of the <command>svn</command> command using
- the <option>--no-auth-cache</option> command-line
- parameter (for those subcommands that support it).
- For more information, see <xref
- linkend="svn.serverconfig.netmodel.credcache"/>.</para>
+ <para>This option has been deprecated from
+ the <filename>config</filename> file. It now lives as
+ a per-server configuration item in
+ the <filename>servers</filename> configuration area.
+ See <xref linkend="svn.advanced.confarea.opts.servers"/>
+ for details.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>store-auth-creds</literal></term>
<listitem>
- <para>This setting is the same as
- <literal>store-passwords</literal>, except that it
- enables or disables on-disk caching of
- <emphasis>all</emphasis> authentication information:
- usernames, passwords, server certificates, and any
- other types of cacheable credentials.</para>
+ <para>This option has been deprecated from
+ the <filename>config</filename> file. It now lives as
+ a per-server configuration item in
+ the <filename>servers</filename> configuration area.
+ See <xref linkend="svn.advanced.confarea.opts.servers"/>
+ for details.</para>
</listitem>
</varlistentry>
</variablelist>
- <para>The <literal>helpers</literal> section controls which
+ <para>The <literal>[helpers]</literal> section controls which
external applications Subversion uses to accomplish its
tasks. Valid options in this section are:</para>
@@ -587,7 +625,7 @@
</varlistentry>
</variablelist>
- <para>The <literal>tunnels</literal> section allows you to
+ <para>The <literal>[tunnels]</literal> section allows you to
define new tunnel schemes for use with
<command>svnserve</command> and <literal>svn://</literal>
client connections. For more details, see <xref
@@ -641,7 +679,7 @@
properties on newly added or imported files. The
default value is <literal>no</literal>, so set this to
<literal>yes</literal> to enable this feature.
- The <literal>auto-props</literal> section of this file
+ The <literal>[auto-props]</literal> section of this file
specifies which properties are to be set on which
files.</para>
</listitem>
</varlistentry>
@@ -788,7 +826,7 @@
</variablelist>
- <para>The <literal>auto-props</literal> section controls
+ <para>The <literal>[auto-props]</literal> section controls
the Subversion client's ability to automatically set
properties on files when they are added or imported.
It contains any number of key-value pairs in the
More information about the svnbook-dev
mailing list