README.txt 4.2 KB

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