Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 328 lines (254 sloc) 10.324 kB
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
1 git-cvsserver(1)
2 ================
3
4 NAME
5 ----
6 git-cvsserver - A CVS server emulator for git
7
8 SYNOPSIS
9 --------
693b632 @flichtenheld cvsserver: Add some useful commandline options
flichtenheld authored
10
11 SSH:
12
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
13 [verse]
14 export CVS_SERVER=git-cvsserver
15 'cvs' -d :ext:user@server/path/repo.git co <HEAD_name>
16
693b632 @flichtenheld cvsserver: Add some useful commandline options
flichtenheld authored
17 pserver (/etc/inetd.conf):
18
19 [verse]
20 cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver
21
22 Usage:
23
24 [verse]
25 'git-cvsserver' [options] [pserver|server] [<directory> ...]
26
27 OPTIONS
28 -------
29
30 All these options obviously only make sense if enforced by the server side.
5162e69 @toofishes Documentation: rename gitlink macro to linkgit
toofishes authored
31 They have been implemented to resemble the linkgit:git-daemon[1] options as
693b632 @flichtenheld cvsserver: Add some useful commandline options
flichtenheld authored
32 closely as possible.
33
34 --base-path <path>::
35 Prepend 'path' to requested CVSROOT
36
37 --strict-paths::
38 Don't allow recursing into subdirectories
39
40 --export-all::
226bccb @flichtenheld cvsserver: Actually implement --export-all
flichtenheld authored
41 Don't check for `gitcvs.enabled` in config. You also have to specify a list
42 of allowed directories (see below) if you want to use this option.
693b632 @flichtenheld cvsserver: Add some useful commandline options
flichtenheld authored
43
44 --version, -V::
45 Print version information and exit
46
47 --help, -h, -H::
48 Print usage information and exit
49
50 <directory>::
51 You can specify a list of allowed directories. If no directories
52 are given, all are allowed. This is an additional restriction, gitcvs
53 access still needs to be enabled by the `gitcvs.enabled` config option
54 unless '--export-all' was given, too.
55
56
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
57 DESCRIPTION
58 -----------
59
60 This application is a CVS emulation layer for git.
61
62 It is highly functional. However, not all methods are implemented,
63 and for those methods that are implemented,
64 not all switches are implemented.
65
66 Testing has been done using both the CLI CVS client, and the Eclipse CVS
67 plugin. Most functionality works fine with both of these clients.
68
69 LIMITATIONS
70 -----------
71
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
72 Currently cvsserver works over SSH connections for read/write clients, and
73 over pserver for anonymous CVS access.
74
75 CVS clients cannot tag, branch or perform GIT merges.
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
76
b247570 @flichtenheld cvsserver: Document the GIT branches -> CVS modules mapping more prom…
flichtenheld authored
77 git-cvsserver maps GIT branches to CVS modules. This is very different
78 from what most CVS users would expect since in CVS modules usually represent
79 one or more directories.
80
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
81 INSTALLATION
82 ------------
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
83
84 1. If you are going to offer anonymous CVS access via pserver, add a line in
85 /etc/inetd.conf like
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
86 +
87 --
88 ------
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
89 cvspserver stream tcp nowait nobody git-cvsserver pserver
90
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
91 ------
893c365 @flichtenheld cvsserver: Correct inetd.conf example in asciidoc documentation
flichtenheld authored
92 Note: Some inetd servers let you specify the name of the executable
93 independently of the value of argv[0] (i.e. the name the program assumes
94 it was executed with). In this case the correct line in /etc/inetd.conf
95 looks like
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
96
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
97 ------
893c365 @flichtenheld cvsserver: Correct inetd.conf example in asciidoc documentation
flichtenheld authored
98 cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
99
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
100 ------
101 No special setup is needed for SSH access, other than having GIT tools
102 in the PATH. If you have clients that do not accept the CVS_SERVER
5484289 @flichtenheld cvsserver: Note that CVS_SERVER can also be specified as method variable
flichtenheld authored
103 environment variable, you can rename git-cvsserver to cvs.
104
db21872 @whee Documentation: For consistency, use CVS instead of cvs.
whee authored
105 Note: Newer CVS versions (>= 1.12.11) also support specifying
5484289 @flichtenheld cvsserver: Note that CVS_SERVER can also be specified as method variable
flichtenheld authored
106 CVS_SERVER directly in CVSROOT like
107
108 ------
109 cvs -d ":ext;CVS_SERVER=git-cvsserver:user@server/path/repo.git" co <HEAD_name>
110 ------
111 This has the advantage that it will be saved in your 'CVS/Root' files and
112 you don't need to worry about always setting the correct environment
113 variable.
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
114 --
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
115 2. For each repo that you want accessible from CVS you need to edit config in
116 the repo and add the following section.
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
117 +
118 --
119 ------
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
120 [gitcvs]
121 enabled=1
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
122 # optional for debugging
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
123 logfile=/path/to/logfile
124
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
125 ------
126 Note: you need to ensure each user that is going to invoke git-cvsserver has
febe7dc @flichtenheld cvsserver: Add asciidoc documentation for new database backend config…
flichtenheld authored
127 write access to the log file and to the database (see
128 <<dbbackend,Database Backend>>. If you want to offer write access over
129 SSH, the users of course also need write access to the git repository itself.
d55820c @flichtenheld cvsserver: Allow to override the configuration per access method
flichtenheld authored
130
febe7dc @flichtenheld cvsserver: Add asciidoc documentation for new database backend config…
flichtenheld authored
131 [[configaccessmethod]]
a192a90 @flichtenheld cvsserver: Fix some typos in asciidoc documentation
flichtenheld authored
132 All configuration variables can also be overridden for a specific method of
d55820c @flichtenheld cvsserver: Allow to override the configuration per access method
flichtenheld authored
133 access. Valid method names are "ext" (for SSH access) and "pserver". The
134 following example configuration would disable pserver access while still
135 allowing access over SSH.
136 ------
137 [gitcvs]
138 enabled=0
139
140 [gitcvs "ext"]
141 enabled=1
142 ------
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
143 --
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
144 3. On the client machine you need to set the following variables.
145 CVSROOT should be set as per normal, but the directory should point at the
146 appropriate git repo. For example:
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
147 +
148 --
149 For SSH access, CVS_SERVER should be set to git-cvsserver
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
150
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
151 Example:
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
152
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
153 ------
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
154 export CVSROOT=:ext:user@server:/var/git/project.git
155 export CVS_SERVER=git-cvsserver
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
156 ------
157 --
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
158 4. For SSH clients that will make commits, make sure their .bashrc file
159 sets the GIT_AUTHOR and GIT_COMMITTER variables.
160
161 5. Clients should now be able to check out the project. Use the CVS 'module'
162 name to indicate what GIT 'head' you want to check out. Example:
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
163 +
164 ------
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
165 cvs co -d project-master master
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
166 ------
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
167
febe7dc @flichtenheld cvsserver: Add asciidoc documentation for new database backend config…
flichtenheld authored
168 [[dbbackend]]
169 Database Backend
170 ----------------
171
172 git-cvsserver uses one database per git head (i.e. CVS module) to
173 store information about the repository for faster access. The
a192a90 @flichtenheld cvsserver: Fix some typos in asciidoc documentation
flichtenheld authored
174 database doesn't contain any persistent data and can be completely
febe7dc @flichtenheld cvsserver: Add asciidoc documentation for new database backend config…
flichtenheld authored
175 regenerated from the git repository at any time. The database
0f76a54 @flichtenheld cvsserver: Reword documentation on necessity of write access
flichtenheld authored
176 needs to be updated (i.e. written to) after every commit.
177
178 If the commit is done directly by using git (as opposed to
179 using git-cvsserver) the update will need to happen on the
180 next repository access by git-cvsserver, independent of
181 access method and requested operation.
182
183 That means that even if you offer only read access (e.g. by using
febe7dc @flichtenheld cvsserver: Add asciidoc documentation for new database backend config…
flichtenheld authored
184 the pserver method), git-cvsserver should have write access to
185 the database to work reliably (otherwise you need to make sure
c02792e @jlherren Documentation/git-cvsserver: Fix typo
jlherren authored
186 that the database is up-to-date any time git-cvsserver is executed).
febe7dc @flichtenheld cvsserver: Add asciidoc documentation for new database backend config…
flichtenheld authored
187
188 By default it uses SQLite databases in the git directory, named
189 `gitcvs.<module_name>.sqlite`. Note that the SQLite backend creates
190 temporary files in the same directory as the database file on
191 write so it might not be enough to grant the users using
192 git-cvsserver write access to the database file without granting
0f76a54 @flichtenheld cvsserver: Reword documentation on necessity of write access
flichtenheld authored
193 them write access to the directory, too.
febe7dc @flichtenheld cvsserver: Add asciidoc documentation for new database backend config…
flichtenheld authored
194
195 You can configure the database backend with the following
196 configuration variables:
197
198 Configuring database backend
199 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
200
201 git-cvsserver uses the Perl DBI module. Please also read
202 its documentation if changing these variables, especially
203 about `DBI->connect()`.
204
205 gitcvs.dbname::
206 Database name. The exact meaning depends on the
a5d86f7 @meyering fix doc typos
meyering authored
207 selected database driver, for SQLite this is a filename.
febe7dc @flichtenheld cvsserver: Add asciidoc documentation for new database backend config…
flichtenheld authored
208 Supports variable substitution (see below). May
209 not contain semicolons (`;`).
210 Default: '%Ggitcvs.%m.sqlite'
211
212 gitcvs.dbdriver::
213 Used DBI driver. You can specify any available driver
214 for this here, but it might not work. cvsserver is tested
215 with 'DBD::SQLite', reported to work with
216 'DBD::Pg', and reported *not* to work with 'DBD::mysql'.
217 Please regard this as an experimental feature. May not
a5d86f7 @meyering fix doc typos
meyering authored
218 contain colons (`:`).
febe7dc @flichtenheld cvsserver: Add asciidoc documentation for new database backend config…
flichtenheld authored
219 Default: 'SQLite'
220
221 gitcvs.dbuser::
222 Database user. Only useful if setting `dbdriver`, since
223 SQLite has no concept of database users. Supports variable
224 substitution (see below).
225
226 gitcvs.dbpass::
227 Database password. Only useful if setting `dbdriver`, since
228 SQLite has no concept of database passwords.
229
6aeeffd @jre Allow git-cvsserver database table name prefix to be specified.
jre authored
230 gitcvs.dbTableNamePrefix::
231 Database table name prefix. Supports variable substitution
232 (see below). Any non-alphabetic characters will be replaced
233 with underscores.
234
febe7dc @flichtenheld cvsserver: Add asciidoc documentation for new database backend config…
flichtenheld authored
235 All variables can also be set per access method, see <<configaccessmethod,above>>.
236
237 Variable substitution
238 ^^^^^^^^^^^^^^^^^^^^^
239 In `dbdriver` and `dbuser` you can use the following variables:
240
241 %G::
242 git directory name
243 %g::
244 git directory name, where all characters except for
245 alpha-numeric ones, `.`, and `-` are replaced with
246 `_` (this should make it easier to use the directory
247 name in a filename if wanted)
248 %m::
249 CVS module/git head name
250 %a::
251 access method (one of "ext" or "pserver")
252 %u::
253 Name of the user running git-cvsserver.
254 If no name can be determined, the
255 numeric uid is used.
256
ee75d4c cvsserver: add notes on how to get a checkout under Eclipse
Martin Langhoff authored
257 Eclipse CVS Client Notes
258 ------------------------
259
260 To get a checkout with the Eclipse CVS client:
261
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
262 1. Select "Create a new project -> From CVS checkout"
263 2. Create a new location. See the notes below for details on how to choose the
264 right protocol.
265 3. Browse the 'modules' available. It will give you a list of the heads in
266 the repository. You will not be able to browse the tree from there. Only
267 the heads.
268 4. Pick 'HEAD' when it asks what branch/tag to check out. Untick the
269 "launch commit wizard" to avoid committing the .project file.
270
abda1ef @vonbrand Documentation: Spelling fixes
vonbrand authored
271 Protocol notes: If you are using anonymous access via pserver, just select that.
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
272 Those using SSH access should choose the 'ext' protocol, and configure 'ext'
273 access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to
e94a4f6 @flichtenheld cvsserver: small corrections to asciidoc documentation
flichtenheld authored
274 'git-cvsserver'. Note that password support is not good when using 'ext',
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
275 you will definitely want to have SSH keys setup.
276
277 Alternatively, you can just use the non-standard extssh protocol that Eclipse
278 offer. In that case CVS_SERVER is ignored, and you will have to replace
e94a4f6 @flichtenheld cvsserver: small corrections to asciidoc documentation
flichtenheld authored
279 the cvs utility on the server with git-cvsserver or manipulate your `.bashrc`
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
280 so that calling 'cvs' effectively calls git-cvsserver.
ee75d4c cvsserver: add notes on how to get a checkout under Eclipse
Martin Langhoff authored
281
282 Clients known to work
283 ---------------------
284
ad0f8c9 @flichtenheld cvsserver: asciidoc formatting changes
flichtenheld authored
285 - CVS 1.12.9 on Debian
286 - CVS 1.11.17 on MacOSX (from Fink package)
287 - Eclipse 3.0, 3.1.2 on MacOSX (see Eclipse CVS Client Notes)
288 - TortoiseCVS
ee75d4c cvsserver: add notes on how to get a checkout under Eclipse
Martin Langhoff authored
289
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
290 Operations supported
291 --------------------
292
293 All the operations required for normal use are supported, including
294 checkout, diff, status, update, log, add, remove, commit.
295 Legacy monitoring operations are not supported (edit, watch and related).
296 Exports and tagging (tags and branches) are not supported at this stage.
297
e94a4f6 @flichtenheld cvsserver: small corrections to asciidoc documentation
flichtenheld authored
298 The server should set the '-k' mode to binary when relevant, however,
d8b6a1a @flichtenheld cvsserver: Don't lie about binary mode in asciidoc documentation
flichtenheld authored
299 this is not really implemented yet. For now, you can force the server
e94a4f6 @flichtenheld cvsserver: small corrections to asciidoc documentation
flichtenheld authored
300 to set '-kb' for all files by setting the `gitcvs.allbinary` config
d8b6a1a @flichtenheld cvsserver: Don't lie about binary mode in asciidoc documentation
flichtenheld authored
301 variable. In proper GIT tradition, the contents of the files are
302 always respected. No keyword expansion or newline munging is supported.
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
303
304 Dependencies
305 ------------
306
307 git-cvsserver depends on DBD::SQLite.
308
309 Copyright and Authors
310 ---------------------
311
312 This program is copyright The Open University UK - 2006.
313
ad0f8c9 @flichtenheld cvsserver: asciidoc formatting changes
flichtenheld authored
314 Authors:
315
316 - Martyn Smith <martyn@catalyst.net.nz>
317 - Martin Langhoff <martin@catalyst.net.nz>
318
319 with ideas and patches from participants of the git-list <git@vger.kernel.org>.
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
320
321 Documentation
322 --------------
ad0f8c9 @flichtenheld cvsserver: asciidoc formatting changes
flichtenheld authored
323 Documentation by Martyn Smith <martyn@catalyst.net.nz>, Martin Langhoff <martin@catalyst.net.nz>, and Matthias Urlichs <smurf@smurf.noris.de>.
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
324
325 GIT
326 ---
5162e69 @toofishes Documentation: rename gitlink macro to linkgit
toofishes authored
327 Part of the linkgit:git[7] suite
Something went wrong with that request. Please try again.