@matheusbsbs / matheus-bagliano / commits / b30cc0daaf
Fork 0

cvsserver: updated documentation

... and stripped trailing whitespace to appease the Gods... Signed-off-by: Martin Langhoff <martin@catalyst.net.nz> Signed-off-by: Junio C Hamano <junkio@cox.net>

Martin Langhoff committed Mar 5, 2006 at 23:11 UTC b30cc0daaf8e5c179356e0d9ec9e081464956c7e
1 file changed +60 -25
Documentation/git-cvsserver.txt
+60 -25
@@ -5,14 +5,12 @@ NAME
5 ----
6 git-cvsserver - A CVS server emulator for git
7
8 -
8 SYNOPSIS
9 --------
10 [verse]
11 export CVS_SERVER=git-cvsserver
12 'cvs' -d :ext:user@server/path/repo.git co <HEAD_name>
13
15 -
14 DESCRIPTION
15 -----------
16
@@ -27,48 +25,85 @@ plugin. Most functionality works fine with both of these clients.
25
26 LIMITATIONS
27 -----------
30 -Currently gitcvs only works over ssh connections.
28
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.
33
34 INSTALLATION
35 ------------
35 -1. Put server.pl somewhere useful on the same machine that is hosting your git repos
36 +
37 +1. If you are going to offer anonymous CVS access via pserver, add a line in
38 + /etc/inetd.conf like
39 +
40 + cvspserver stream tcp nowait nobody git-cvsserver pserver
41 +
42 + Note: In some cases, you need to pass the 'pserver' argument twice for
43 + git-cvsserver to see it. So the line would look like
44 +
45 + cvspserver stream tcp nowait nobody git-cvsserver pserver pserver
46 +
47 + No special setup is needed for SSH access, other than having GIT tools
48 + in the PATH. If you have clients that do not accept the CVS_SERVER
49 + env variable, you can rename git-cvsserver to cvs.
50
51 2. For each repo that you want accessible from CVS you need to edit config in
52 the repo and add the following section.
53
54 [gitcvs]
55 enabled=1
56 + # optional for debugging
57 logfile=/path/to/logfile
58
44 - n.b. you need to ensure each user that is going to invoke server.pl has
45 - write access to the log file.
59 + Note: you need to ensure each user that is going to invoke git-cvsserver has
60 + write access to the log file and to the git repository. When offering anon
61 + access via pserver, this means that the nobody user should have write access
62 + to at least the sqlite database at the root of the repository.
63 +
64 +3. On the client machine you need to set the following variables.
65 + CVSROOT should be set as per normal, but the directory should point at the
66 + appropriate git repo. For example:
67 +
68 + For SSH access, CVS_SERVER should be set to git-cvsserver
69 +
70 + Example:
71
47 -5. On each client machine you need to set the following variables.
48 - CVSROOT should be set as per normal, but the directory should point at the
49 - appropriate git repo.
50 - CVS_SERVER should be set to the server.pl script that has been put on the
51 - remote machine.
72 + export CVSROOT=:ext:user@server:/var/git/project.git
73 + export CVS_SERVER=git-cvsserver
74
53 -6. Clients should now be able to check out modules (where modules are the names
54 - of branches in git).
55 - $ cvs co -d mylocaldir master
75 +4. For SSH clients that will make commits, make sure their .bashrc file
76 + sets the GIT_AUTHOR and GIT_COMMITTER variables.
77 +
78 +5. Clients should now be able to check out the project. Use the CVS 'module'
79 + name to indicate what GIT 'head' you want to check out. Example:
80 +
81 + cvs co -d project-master master
82
83 Eclipse CVS Client Notes
84 ------------------------
85
86 To get a checkout with the Eclipse CVS client:
87
62 -1. Create a new project from CVS checkout, giving it repository and module
63 -2. Context Menu->Team->Share Project...
64 -3. Enter the repository and module information again and click Finish
65 -4. The Synchronize view appears. Untick "launch commit wizard" to avoid
66 -committing the .project file, and select HEAD as the tag to synchronize to.
67 -Update all incoming changes.
68 -
69 -Note that most versions of Eclipse ignore CVS_SERVER (which you can set in
70 -the Preferences->Team->CVS->ExtConnection pane), so you may have to
71 -rename, alias or symlink git-cvsserver to 'cvs' on the server.
88 +1. Select "Create a new project -> From CVS checkout"
89 +2. Create a new location. See the notes below for details on how to choose the
90 + right protocol.
91 +3. Browse the 'modules' available. It will give you a list of the heads in
92 + the repository. You will not be able to browse the tree from there. Only
93 + the heads.
94 +4. Pick 'HEAD' when it asks what branch/tag to check out. Untick the
95 + "launch commit wizard" to avoid committing the .project file.
96 +
97 +Protocol notes: If you are using anonymous acces via pserver, just select that.
98 +Those using SSH access should choose the 'ext' protocol, and configure 'ext'
99 +access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to
100 +'git-cvsserver'. Not that password support is not good when using 'ext',
101 +you will definitely want to have SSH keys setup.
102 +
103 +Alternatively, you can just use the non-standard extssh protocol that Eclipse
104 +offer. In that case CVS_SERVER is ignored, and you will have to replace
105 +the cvs utility on the server with git-cvsserver or manipulate your .bashrc
106 +so that calling 'cvs' effectively calls git-cvsserver.
107
108 Clients known to work
109 ---------------------
@@ -106,7 +141,7 @@ Authors: Martyn Smith <martyn@catalyst.net.nz>
141
142 Documentation
143 --------------
109 -Documentation by Martyn Smith <martyn@catalyst.net.nz> and Martin Langhoff <martin@catalyst.net.nz>Matthias Urlichs <smurf@smurf.noris.de>.
144 +Documentation by Martyn Smith <martyn@catalyst.net.nz> and Martin Langhoff <martin@catalyst.net.nz> Matthias Urlichs <smurf@smurf.noris.de>.
145
146 GIT
147 ---