Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 177 lines (137 sloc) 5.37 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 --------
10 [verse]
11 export CVS_SERVER=git-cvsserver
12 'cvs' -d :ext:user@server/path/repo.git co <HEAD_name>
13
14 DESCRIPTION
15 -----------
16
17 This application is a CVS emulation layer for git.
18
19 It is highly functional. However, not all methods are implemented,
20 and for those methods that are implemented,
21 not all switches are implemented.
22
23 Testing has been done using both the CLI CVS client, and the Eclipse CVS
24 plugin. Most functionality works fine with both of these clients.
25
26 LIMITATIONS
27 -----------
28
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
29 Currently cvsserver works over SSH connections for read/write clients, and
30 over pserver for anonymous CVS access.
31
32 CVS clients cannot tag, branch or perform GIT merges.
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
33
34 INSTALLATION
35 ------------
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
36
37 1. If you are going to offer anonymous CVS access via pserver, add a line in
38 /etc/inetd.conf like
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
39 +
40 --
41 ------
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
42 cvspserver stream tcp nowait nobody git-cvsserver pserver
43
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
44 ------
45 Note: In some cases, you need to pass the 'pserver' argument twice for
46 git-cvsserver to see it. So the line would look like
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
47
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
48 ------
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
49 cvspserver stream tcp nowait nobody git-cvsserver pserver pserver
50
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
51 ------
52 No special setup is needed for SSH access, other than having GIT tools
53 in the PATH. If you have clients that do not accept the CVS_SERVER
54 env variable, you can rename git-cvsserver to cvs.
55 --
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
56 2. For each repo that you want accessible from CVS you need to edit config in
57 the repo and add the following section.
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
58 +
59 --
60 ------
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
61 [gitcvs]
62 enabled=1
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
63 # optional for debugging
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
64 logfile=/path/to/logfile
65
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
66 ------
67 Note: you need to ensure each user that is going to invoke git-cvsserver has
68 write access to the log file and to the git repository. When offering anon
69 access via pserver, this means that the nobody user should have write access
70 to at least the sqlite database at the root of the repository.
d55820c @flichtenheld cvsserver: Allow to override the configuration per access method
flichtenheld authored
71
72 Both configuration variables can also be overriden for a specific method of
73 access. Valid method names are "ext" (for SSH access) and "pserver". The
74 following example configuration would disable pserver access while still
75 allowing access over SSH.
76 ------
77 [gitcvs]
78 enabled=0
79
80 [gitcvs "ext"]
81 enabled=1
82 ------
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
83 --
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
84 3. On the client machine you need to set the following variables.
85 CVSROOT should be set as per normal, but the directory should point at the
86 appropriate git repo. For example:
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
87 +
88 --
89 For SSH access, CVS_SERVER should be set to git-cvsserver
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
90
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
91 Example:
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
92
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
93 ------
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
94 export CVSROOT=:ext:user@server:/var/git/project.git
95 export CVS_SERVER=git-cvsserver
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
96 ------
97 --
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
98 4. For SSH clients that will make commits, make sure their .bashrc file
99 sets the GIT_AUTHOR and GIT_COMMITTER variables.
100
101 5. Clients should now be able to check out the project. Use the CVS 'module'
102 name to indicate what GIT 'head' you want to check out. Example:
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
103 +
104 ------
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
105 cvs co -d project-master master
0fc8573 git-cvsserver asciidoc formatting tweaks
Francis Daly authored
106 ------
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
107
ee75d4c cvsserver: add notes on how to get a checkout under Eclipse
Martin Langhoff authored
108 Eclipse CVS Client Notes
109 ------------------------
110
111 To get a checkout with the Eclipse CVS client:
112
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
113 1. Select "Create a new project -> From CVS checkout"
114 2. Create a new location. See the notes below for details on how to choose the
115 right protocol.
116 3. Browse the 'modules' available. It will give you a list of the heads in
117 the repository. You will not be able to browse the tree from there. Only
118 the heads.
119 4. Pick 'HEAD' when it asks what branch/tag to check out. Untick the
120 "launch commit wizard" to avoid committing the .project file.
121
abda1ef @vonbrand Documentation: Spelling fixes
vonbrand authored
122 Protocol notes: If you are using anonymous access via pserver, just select that.
b30cc0d cvsserver: updated documentation
Martin Langhoff authored
123 Those using SSH access should choose the 'ext' protocol, and configure 'ext'
124 access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to
125 'git-cvsserver'. Not that password support is not good when using 'ext',
126 you will definitely want to have SSH keys setup.
127
128 Alternatively, you can just use the non-standard extssh protocol that Eclipse
129 offer. In that case CVS_SERVER is ignored, and you will have to replace
130 the cvs utility on the server with git-cvsserver or manipulate your .bashrc
131 so that calling 'cvs' effectively calls git-cvsserver.
ee75d4c cvsserver: add notes on how to get a checkout under Eclipse
Martin Langhoff authored
132
133 Clients known to work
134 ---------------------
135
ad0f8c9 @flichtenheld cvsserver: asciidoc formatting changes
flichtenheld authored
136 - CVS 1.12.9 on Debian
137 - CVS 1.11.17 on MacOSX (from Fink package)
138 - Eclipse 3.0, 3.1.2 on MacOSX (see Eclipse CVS Client Notes)
139 - TortoiseCVS
ee75d4c cvsserver: add notes on how to get a checkout under Eclipse
Martin Langhoff authored
140
3fda8c4 Introducing git-cvsserver -- a CVS emulator for git.
Martin Langhoff authored
141 Operations supported
142 --------------------
143
144 All the operations required for normal use are supported, including
145 checkout, diff, status, update, log, add, remove, commit.
146 Legacy monitoring operations are not supported (edit, watch and related).
147 Exports and tagging (tags and branches) are not supported at this stage.
148
149 The server will set the -k mode to binary when relevant. In proper GIT
150 tradition, the contents of the files are always respected.
151 No keyword expansion or newline munging is supported.
152
153 Dependencies
154 ------------
155
156 git-cvsserver depends on DBD::SQLite.
157
158 Copyright and Authors
159 ---------------------
160
161 This program is copyright The Open University UK - 2006.
162
ad0f8c9 @flichtenheld cvsserver: asciidoc formatting changes
flichtenheld authored
163 Authors:
164
165 - Martyn Smith <martyn@catalyst.net.nz>
166 - Martin Langhoff <martin@catalyst.net.nz>
167
168 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
169
170 Documentation
171 --------------
ad0f8c9 @flichtenheld cvsserver: asciidoc formatting changes
flichtenheld authored
172 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
173
174 GIT
175 ---
176 Part of the gitlink:git[7] suite
Something went wrong with that request. Please try again.