.subversion/README.txt

   1 This directory holds run-time configuration information for Subversion
   2 clients.  The configuration files all share the same syntax, but you
   3 should examine a particular file to learn what configuration
   4 directives are valid for that file.
   5
   6 The syntax is standard INI format:
   7
   8    - Empty lines, and lines starting with '#', are ignored.
   9      The first significant line in a file must be a section header.
  10
  11    - A section starts with a section header, which must start in
  12      the first column:
  13
  14        [section-name]
  15
  16    - An option, which must always appear within a section, is a pair
  17      (name, value).  There are two valid forms for defining an
  18      option, both of which must start in the first column:
  19
  20        name: value
  21        name = value
  22
  23      Whitespace around the separator (:, =) is optional.
  24
  25    - Section and option names are case-insensitive, but case is
  26      preserved.
  27
  28    - An option's value may be broken into several lines.  The value
  29      continuation lines must start with at least one whitespace.
  30      Trailing whitespace in the previous line, the newline character
  31      and the leading whitespace in the continuation line is compressed
  32      into a single space character.
  33
  34    - All leading and trailing whitespace around a value is trimmed,
  35      but the whitespace within a value is preserved, with the
  36      exception of whitespace around line continuations, as
  37      described above.
  38
  39    - When a value is a list, it is comma-separated.  Again, the
  40      whitespace around each element of the list is trimmed.
  41
  42    - Option values may be expanded within a value by enclosing the
  43      option name in parentheses, preceded by a percent sign:
  44
  45        %(name)
  46
  47      The expansion is performed recursively and on demand, during
  48      svn_option_get.  The name is first searched for in the same
  49      section, then in the special [DEFAULT] section. If the name
  50      is not found, the whole %(name) placeholder is left
  51      unchanged.
  52
  53      Any modifications to the configuration data invalidate all
  54      previously expanded values, so that the next svn_option_get
  55      will take the modifications into account.
  56
  57
  58 Configuration data in the Windows registry
  59 ==========================================
  60
  61 On Windows, configuration data may also be stored in the registry.  The
  62 functions svn_config_read and svn_config_merge will read from the
  63 registry when passed file names of the form:
  64
  65    REGISTRY:<hive>/path/to/config-key
  66
  67 The REGISTRY: prefix must be in upper case. The <hive> part must be
  68 one of:
  69
  70    HKLM for HKEY_LOCAL_MACHINE
  71    HKCU for HKEY_CURRENT_USER
  72
  73 The values in config-key represent the options in the [DEFAULT] section.
  74 The keys below config-key represent other sections, and their values
  75 represent the options. Only values of type REG_SZ whose name doesn't
  76 start with a '#' will be used; other values, as well as the keys'
  77 default values, will be ignored.
  78
  79
  80 File locations
  81 ==============
  82
  83 Typically, Subversion uses two config directories, one for site-wide
  84 configuration,
  85
  86   Unix:
  87     /etc/subversion/servers
  88     /etc/subversion/config
  89     /etc/subversion/hairstyles
  90   Windows:
  91     %ALLUSERSPROFILE%\Application Data\Subversion\servers
  92     %ALLUSERSPROFILE%\Application Data\Subversion\config
  93     %ALLUSERSPROFILE%\Application Data\Subversion\hairstyles
  94     REGISTRY:HKLM\Software\Tigris.org\Subversion\Servers
  95     REGISTRY:HKLM\Software\Tigris.org\Subversion\Config
  96     REGISTRY:HKLM\Software\Tigris.org\Subversion\Hairstyles
  97
  98 and one for per-user configuration:
  99
 100   Unix:
 101     ~/.subversion/servers
 102     ~/.subversion/config
 103     ~/.subversion/hairstyles
 104   Windows:
 105     %APPDATA%\Subversion\servers
 106     %APPDATA%\Subversion\config
 107     %APPDATA%\Subversion\hairstyles
 108     REGISTRY:HKCU\Software\Tigris.org\Subversion\Servers
 109     REGISTRY:HKCU\Software\Tigris.org\Subversion\Config
 110     REGISTRY:HKCU\Software\Tigris.org\Subversion\Hairstyles
 111