Merge branch 'en/strmap'
[git] / Documentation / config / gitcvs.txt
1 gitcvs.commitMsgAnnotation::
2         Append this string to each commit message. Set to empty string
3         to disable this feature. Defaults to "via git-CVS emulator".
4
5 gitcvs.enabled::
6         Whether the CVS server interface is enabled for this repository.
7         See linkgit:git-cvsserver[1].
8
9 gitcvs.logFile::
10         Path to a log file where the CVS server interface well... logs
11         various stuff. See linkgit:git-cvsserver[1].
12
13 gitcvs.usecrlfattr::
14         If true, the server will look up the end-of-line conversion
15         attributes for files to determine the `-k` modes to use. If
16         the attributes force Git to treat a file as text,
17         the `-k` mode will be left blank so CVS clients will
18         treat it as text. If they suppress text conversion, the file
19         will be set with '-kb' mode, which suppresses any newline munging
20         the client might otherwise do. If the attributes do not allow
21         the file type to be determined, then `gitcvs.allBinary` is
22         used. See linkgit:gitattributes[5].
23
24 gitcvs.allBinary::
25         This is used if `gitcvs.usecrlfattr` does not resolve
26         the correct '-kb' mode to use. If true, all
27         unresolved files are sent to the client in
28         mode '-kb'. This causes the client to treat them
29         as binary files, which suppresses any newline munging it
30         otherwise might do. Alternatively, if it is set to "guess",
31         then the contents of the file are examined to decide if
32         it is binary, similar to `core.autocrlf`.
33
34 gitcvs.dbName::
35         Database used by git-cvsserver to cache revision information
36         derived from the Git repository. The exact meaning depends on the
37         used database driver, for SQLite (which is the default driver) this
38         is a filename. Supports variable substitution (see
39         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
40         Default: '%Ggitcvs.%m.sqlite'
41
42 gitcvs.dbDriver::
43         Used Perl DBI driver. You can specify any available driver
44         for this here, but it might not work. git-cvsserver is tested
45         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
46         reported *not* to work with 'DBD::mysql'. Experimental feature.
47         May not contain double colons (`:`). Default: 'SQLite'.
48         See linkgit:git-cvsserver[1].
49
50 gitcvs.dbUser, gitcvs.dbPass::
51         Database user and password. Only useful if setting `gitcvs.dbDriver`,
52         since SQLite has no concept of database users and/or passwords.
53         'gitcvs.dbUser' supports variable substitution (see
54         linkgit:git-cvsserver[1] for details).
55
56 gitcvs.dbTableNamePrefix::
57         Database table name prefix.  Prepended to the names of any
58         database tables used, allowing a single database to be used
59         for several repositories.  Supports variable substitution (see
60         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
61         characters will be replaced with underscores.
62
63 All gitcvs variables except for `gitcvs.usecrlfattr` and
64 `gitcvs.allBinary` can also be specified as
65 'gitcvs.<access_method>.<varname>' (where 'access_method'
66 is one of "ext" and "pserver") to make them apply only for the given
67 access method.