man1/git-cvsserver.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "GIT-CVSSERVER" 1 "" "" ""
  21 .SH NAME
  22 git-cvsserver \- A CVS server emulator for git
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 export CVS_SERVER=git\-cvsserver
  27 \fIcvs\fR \-d :ext:user@server/path/repo\&.git co <HEAD_name>
  28 .fi
  29
  30 .SH "DESCRIPTION"
  31
  32
  33 This application is a CVS emulation layer for git\&.
  34
  35
  36 It is highly functional\&. However, not all methods are implemented, and for those methods that are implemented, not all switches are implemented\&.
  37
  38
  39 Testing has been done using both the CLI CVS client, and the Eclipse CVS plugin\&. Most functionality works fine with both of these clients\&.
  40
  41 .SH "LIMITATIONS"
  42
  43
  44 Currently cvsserver works over SSH connections for read/write clients, and over pserver for anonymous CVS access\&.
  45
  46
  47 CVS clients cannot tag, branch or perform GIT merges\&.
  48
  49 .SH "INSTALLATION"
  50
  51 .TP 3
  52 1.
  53 If you are going to offer anonymous CVS access via pserver, add a line in /etc/inetd\&.conf like
  54
  55 .nf
  56 cvspserver stream tcp nowait nobody git\-cvsserver pserver
  57 .fi
  58
  59 .nf
  60 Note: In some cases, you need to pass the 'pserver' argument twice for
  61 git\-cvsserver to see it\&. So the line would look like
  62 .fi
  63
  64 .nf
  65 cvspserver stream tcp nowait nobody git\-cvsserver pserver pserver
  66 .fi
  67
  68 .nf
  69 No special setup is needed for SSH access, other than having GIT tools
  70 in the PATH\&. If you have clients that do not accept the CVS_SERVER
  71 env variable, you can rename git\-cvsserver to cvs\&.
  72 .fi
  73 .TP
  74 2.
  75 For each repo that you want accessible from CVS you need to edit config in the repo and add the following section\&.
  76
  77 .nf
  78 [gitcvs]
  79      enabled=1
  80      # optional for debugging
  81      logfile=/path/to/logfile
  82 .fi
  83
  84 .nf
  85 Note: you need to ensure each user that is going to invoke git\-cvsserver has
  86 write access to the log file and to the git repository\&. When offering anon
  87 access via pserver, this means that the nobody user should have write access
  88 to at least the sqlite database at the root of the repository\&.
  89 .fi
  90 .TP
  91 3.
  92 On the client machine you need to set the following variables\&. CVSROOT should be set as per normal, but the directory should point at the appropriate git repo\&. For example:
  93
  94 .nf
  95 For SSH access, CVS_SERVER should be set to git\-cvsserver
  96 .fi
  97
  98 .nf
  99 Example:
 100 .fi
 101
 102 .nf
 103 export CVSROOT=:ext:user@server:/var/git/project\&.git
 104 export CVS_SERVER=git\-cvsserver
 105 .fi
 106 .TP
 107 4.
 108 For SSH clients that will make commits, make sure their \&.bashrc file sets the GIT_AUTHOR and GIT_COMMITTER variables\&.
 109 .TP
 110 5.
 111 Clients should now be able to check out the project\&. Use the CVS \fImodule\fR name to indicate what GIT \fIhead\fR you want to check out\&. Example:
 112
 113 .nf
 114 cvs co \-d project\-master master
 115 .fi
 116 .LP
 117
 118 .SH "ECLIPSE CVS CLIENT NOTES"
 119
 120
 121 To get a checkout with the Eclipse CVS client:
 122
 123 .TP 3
 124 1.
 125 Select "Create a new project \-> From CVS checkout"
 126 .TP
 127 2.
 128 Create a new location\&. See the notes below for details on how to choose the right protocol\&.
 129 .TP
 130 3.
 131 Browse the \fImodules\fR available\&. It will give you a list of the heads in the repository\&. You will not be able to browse the tree from there\&. Only the heads\&.
 132 .TP
 133 4.
 134 Pick \fIHEAD\fR when it asks what branch/tag to check out\&. Untick the "launch commit wizard" to avoid committing the \&.project file\&.
 135 .LP
 136
 137
 138 Protocol notes: If you are using anonymous acces via pserver, just select that\&. Those using SSH access should choose the \fIext\fR protocol, and configure \fIext\fR access on the Preferences\->Team\->CVS\->ExtConnection pane\&. Set CVS_SERVER to \fIgit\-cvsserver\fR\&. Not that password support is not good when using \fIext\fR, you will definitely want to have SSH keys setup\&.
 139
 140
 141 Alternatively, you can just use the non\-standard extssh protocol that Eclipse offer\&. In that case CVS_SERVER is ignored, and you will have to replace the cvs utility on the server with git\-cvsserver or manipulate your \&.bashrc so that calling \fIcvs\fR effectively calls git\-cvsserver\&.
 142
 143 .SH "CLIENTS KNOWN TO WORK"
 144
 145
 146 CVS 1\&.12\&.9 on Debian CVS 1\&.11\&.17 on MacOSX (from Fink package) Eclipse 3\&.0, 3\&.1\&.2 on MacOSX (see Eclipse CVS Client Notes) TortoiseCVS
 147
 148 .SH "OPERATIONS SUPPORTED"
 149
 150
 151 All the operations required for normal use are supported, including checkout, diff, status, update, log, add, remove, commit\&. Legacy monitoring operations are not supported (edit, watch and related)\&. Exports and tagging (tags and branches) are not supported at this stage\&.
 152
 153
 154 The server will set the \-k mode to binary when relevant\&. In proper GIT tradition, the contents of the files are always respected\&. No keyword expansion or newline munging is supported\&.
 155
 156 .SH "DEPENDENCIES"
 157
 158
 159 git\-cvsserver depends on DBD::SQLite\&.
 160
 161 .SH "COPYRIGHT AND AUTHORS"
 162
 163
 164 This program is copyright The Open University UK \- 2006\&.
 165
 166
 167 Authors: Martyn Smith <martyn@catalyst\&.net\&.nz> Martin Langhoff <martin@catalyst\&.net\&.nz> with ideas and patches from participants of the git\-list <git@vger\&.kernel\&.org>\&.
 168
 169 .SH "DOCUMENTATION"
 170
 171
 172 Documentation by Martyn Smith <martyn@catalyst\&.net\&.nz> and Martin Langhoff <martin@catalyst\&.net\&.nz> Matthias Urlichs <smurf@smurf\&.noris\&.de>\&.
 173
 174 .SH "GIT"
 175
 176
 177 Part of the \fBgit\fR(7) suite
 178