git-cvsserver.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
   6 <meta name="generator" content="AsciiDoc 7.0.2" />\r
   7 <style type="text/css">\r
   8 /* Debug borders */\r
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
  10 /*\r
  11   border: 1px solid red;\r
  12 */\r
  13 }\r
  14 \r
  15 body {\r
  16   margin: 1em 5% 1em 5%;\r
  17 }\r
  18 \r
  19 a { color: blue; }\r
  20 a:visited { color: fuchsia; }\r
  21 \r
  22 em {\r
  23   font-style: italic;\r
  24 }\r
  25 \r
  26 strong {\r
  27   font-weight: bold;\r
  28 }\r
  29 \r
  30 tt {\r
  31   color: navy;\r
  32 }\r
  33 \r
  34 h1, h2, h3, h4, h5, h6 {\r
  35   color: #527bbd;\r
  36   font-family: sans-serif;\r
  37   margin-top: 1.2em;\r
  38   margin-bottom: 0.5em;\r
  39   line-height: 1.3;\r
  40 }\r
  41 \r
  42 h1 {\r
  43   border-bottom: 2px solid silver;\r
  44 }\r
  45 h2 {\r
  46   border-bottom: 2px solid silver;\r
  47   padding-top: 0.5em;\r
  48 }\r
  49 \r
  50 div.sectionbody {\r
  51   font-family: serif;\r
  52   margin-left: 0;\r
  53 }\r
  54 \r
  55 hr {\r
  56   border: 1px solid silver;\r
  57 }\r
  58 \r
  59 p {\r
  60   margin-top: 0.5em;\r
  61   margin-bottom: 0.5em;\r
  62 }\r
  63 \r
  64 pre {\r
  65   padding: 0;\r
  66   margin: 0;\r
  67 }\r
  68 \r
  69 span#author {\r
  70   color: #527bbd;\r
  71   font-family: sans-serif;\r
  72   font-weight: bold;\r
  73   font-size: 1.2em;\r
  74 }\r
  75 span#email {\r
  76 }\r
  77 span#revision {\r
  78   font-family: sans-serif;\r
  79 }\r
  80 \r
  81 div#footer {\r
  82   font-family: sans-serif;\r
  83   font-size: small;\r
  84   border-top: 2px solid silver;\r
  85   padding-top: 0.5em;\r
  86   margin-top: 4.0em;\r
  87 }\r
  88 div#footer-text {\r
  89   float: left;\r
  90   padding-bottom: 0.5em;\r
  91 }\r
  92 div#footer-badges {\r
  93   float: right;\r
  94   padding-bottom: 0.5em;\r
  95 }\r
  96 \r
  97 div#preamble,\r
  98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
  99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
 100 div.admonitionblock {\r
 101   margin-right: 10%;\r
 102   margin-top: 1.5em;\r
 103   margin-bottom: 1.5em;\r
 104 }\r
 105 div.admonitionblock {\r
 106   margin-top: 2.5em;\r
 107   margin-bottom: 2.5em;\r
 108 }\r
 109 \r
 110 div.content { /* Block element content. */\r
 111   padding: 0;\r
 112 }\r
 113 \r
 114 /* Block element titles. */\r
 115 div.title, caption.title {\r
 116   font-family: sans-serif;\r
 117   font-weight: bold;\r
 118   text-align: left;\r
 119   margin-top: 1.0em;\r
 120   margin-bottom: 0.5em;\r
 121 }\r
 122 div.title + * {\r
 123   margin-top: 0;\r
 124 }\r
 125 \r
 126 td div.title:first-child {\r
 127   margin-top: 0.0em;\r
 128 }\r
 129 div.content div.title:first-child {\r
 130   margin-top: 0.0em;\r
 131 }\r
 132 div.content + div.title {\r
 133   margin-top: 0.0em;\r
 134 }\r
 135 \r
 136 div.sidebarblock > div.content {\r
 137   background: #ffffee;\r
 138   border: 1px solid silver;\r
 139   padding: 0.5em;\r
 140 }\r
 141 \r
 142 div.listingblock > div.content {\r
 143   border: 1px solid silver;\r
 144   background: #f4f4f4;\r
 145   padding: 0.5em;\r
 146 }\r
 147 \r
 148 div.quoteblock > div.content {\r
 149   padding-left: 2.0em;\r
 150 }\r
 151 div.quoteblock .attribution {\r
 152   text-align: right;\r
 153 }\r
 154 \r
 155 div.admonitionblock .icon {\r
 156   vertical-align: top;\r
 157   font-size: 1.1em;\r
 158   font-weight: bold;\r
 159   text-decoration: underline;\r
 160   color: #527bbd;\r
 161   padding-right: 0.5em;\r
 162 }\r
 163 div.admonitionblock td.content {\r
 164   padding-left: 0.5em;\r
 165   border-left: 2px solid silver;\r
 166 }\r
 167 \r
 168 div.exampleblock > div.content {\r
 169   border-left: 2px solid silver;\r
 170   padding: 0.5em;\r
 171 }\r
 172 \r
 173 div.verseblock div.content {\r
 174   white-space: pre;\r
 175 }\r
 176 \r
 177 div.imageblock div.content { padding-left: 0; }\r
 178 div.imageblock img { border: 1px solid silver; }\r
 179 span.image img { border-style: none; }\r
 180 \r
 181 dl {\r
 182   margin-top: 0.8em;\r
 183   margin-bottom: 0.8em;\r
 184 }\r
 185 dt {\r
 186   margin-top: 0.5em;\r
 187   margin-bottom: 0;\r
 188   font-style: italic;\r
 189 }\r
 190 dd > *:first-child {\r
 191   margin-top: 0;\r
 192 }\r
 193 \r
 194 ul, ol {\r
 195     list-style-position: outside;\r
 196 }\r
 197 ol.olist2 {\r
 198   list-style-type: lower-alpha;\r
 199 }\r
 200 \r
 201 div.tableblock > table {\r
 202   border-color: #527bbd;\r
 203   border-width: 3px;\r
 204 }\r
 205 thead {\r
 206   font-family: sans-serif;\r
 207   font-weight: bold;\r
 208 }\r
 209 tfoot {\r
 210   font-weight: bold;\r
 211 }\r
 212 \r
 213 div.hlist {\r
 214   margin-top: 0.8em;\r
 215   margin-bottom: 0.8em;\r
 216 }\r
 217 td.hlist1 {\r
 218   vertical-align: top;\r
 219   font-style: italic;\r
 220   padding-right: 0.8em;\r
 221 }\r
 222 td.hlist2 {\r
 223   vertical-align: top;\r
 224 }\r
 225 \r
 226 @media print {\r
 227   div#footer-badges { display: none; }\r
 228 }\r
 229 include::./stylesheets/xhtml11-manpage.css[]\r
 230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
 231 \r
 232 div.sidebar-content {\r
 233   background: #ffffee;\r
 234   border: 1px solid silver;\r
 235   padding: 0.5em;\r
 236 }\r
 237 div.sidebar-title, div.image-title {\r
 238   font-family: sans-serif;\r
 239   font-weight: bold;\r
 240   margin-top: 0.0em;\r
 241   margin-bottom: 0.5em;\r
 242 }\r
 243 \r
 244 div.listingblock div.content {\r
 245   border: 1px solid silver;\r
 246   background: #f4f4f4;\r
 247   padding: 0.5em;\r
 248 }\r
 249 \r
 250 div.quoteblock-content {\r
 251   padding-left: 2.0em;\r
 252 }\r
 253 \r
 254 div.exampleblock-content {\r
 255   border-left: 2px solid silver;\r
 256   padding-left: 0.5em;\r
 257 }\r
 258 </style>\r
 259 <title>git-cvsserver(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-cvsserver(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-cvsserver -\r
 269    A CVS server emulator for git\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <div class="verseblock">\r
 276 <div class="content">export CVS_SERVER=git-cvsserver\r
 277 <em>cvs</em> -d :ext:user@server/path/repo.git co &lt;HEAD_name&gt;</div></div>\r
 278 </div>\r
 279 <h2>DESCRIPTION</h2>\r
 280 <div class="sectionbody">\r
 281 <p>This application is a CVS emulation layer for git.</p>\r
 282 <p>It is highly functional. However, not all methods are implemented,\r
 283 and for those methods that are implemented,\r
 284 not all switches are implemented.</p>\r
 285 <p>Testing has been done using both the CLI CVS client, and the Eclipse CVS\r
 286 plugin. Most functionality works fine with both of these clients.</p>\r
 287 </div>\r
 288 <h2>LIMITATIONS</h2>\r
 289 <div class="sectionbody">\r
 290 <p>Currently cvsserver works over SSH connections for read/write clients, and\r
 291 over pserver for anonymous CVS access.</p>\r
 292 <p>CVS clients cannot tag, branch or perform GIT merges.</p>\r
 293 </div>\r
 294 <h2>INSTALLATION</h2>\r
 295 <div class="sectionbody">\r
 296 <ol>\r
 297 <li>\r
 298 <p>\r
 299 If you are going to offer anonymous CVS access via pserver, add a line in\r
 300    /etc/inetd.conf like\r
 301 </p>\r
 302 <div class="listingblock">\r
 303 <div class="content">\r
 304 <pre><tt>   cvspserver stream tcp nowait nobody git-cvsserver pserver\r
 305 </tt></pre>\r
 306 </div></div>\r
 307 <p>Note: In some cases, you need to pass the <em>pserver</em> argument twice for\r
 308 git-cvsserver to see it. So the line would look like</p>\r
 309 <div class="listingblock">\r
 310 <div class="content">\r
 311 <pre><tt>   cvspserver stream tcp nowait nobody git-cvsserver pserver pserver\r
 312 </tt></pre>\r
 313 </div></div>\r
 314 <p>No special setup is needed for SSH access, other than having GIT tools\r
 315 in the PATH. If you have clients that do not accept the CVS_SERVER\r
 316 env variable, you can rename git-cvsserver to cvs.</p>\r
 317 </li>\r
 318 <li>\r
 319 <p>\r
 320 For each repo that you want accessible from CVS you need to edit config in\r
 321    the repo and add the following section.\r
 322 </p>\r
 323 <div class="listingblock">\r
 324 <div class="content">\r
 325 <pre><tt>   [gitcvs]\r
 326         enabled=1\r
 327         # optional for debugging\r
 328         logfile=/path/to/logfile\r
 329 </tt></pre>\r
 330 </div></div>\r
 331 <p>Note: you need to ensure each user that is going to invoke git-cvsserver has\r
 332 write access to the log file and to the git repository. When offering anon\r
 333 access via pserver, this means that the nobody user should have write access\r
 334 to at least the sqlite database at the root of the repository.</p>\r
 335 </li>\r
 336 <li>\r
 337 <p>\r
 338 On the client machine you need to set the following variables.\r
 339    CVSROOT should be set as per normal, but the directory should point at the\r
 340    appropriate git repo. For example:\r
 341 </p>\r
 342 <p>For SSH access, CVS_SERVER should be set to git-cvsserver</p>\r
 343 <p>Example:</p>\r
 344 <div class="listingblock">\r
 345 <div class="content">\r
 346 <pre><tt>     export CVSROOT=:ext:user@server:/var/git/project.git\r
 347      export CVS_SERVER=git-cvsserver</tt></pre>\r
 348 </div></div>\r
 349 </li>\r
 350 <li>\r
 351 <p>\r
 352 For SSH clients that will make commits, make sure their .bashrc file\r
 353    sets the GIT_AUTHOR and GIT_COMMITTER variables.\r
 354 </p>\r
 355 </li>\r
 356 <li>\r
 357 <p>\r
 358 Clients should now be able to check out the project. Use the CVS <em>module</em>\r
 359    name to indicate what GIT <em>head</em> you want to check out. Example:\r
 360 </p>\r
 361 <div class="listingblock">\r
 362 <div class="content">\r
 363 <pre><tt>     cvs co -d project-master master</tt></pre>\r
 364 </div></div>\r
 365 </li>\r
 366 </ol>\r
 367 </div>\r
 368 <h2>Eclipse CVS Client Notes</h2>\r
 369 <div class="sectionbody">\r
 370 <p>To get a checkout with the Eclipse CVS client:</p>\r
 371 <ol>\r
 372 <li>\r
 373 <p>\r
 374 Select "Create a new project -&gt; From CVS checkout"\r
 375 </p>\r
 376 </li>\r
 377 <li>\r
 378 <p>\r
 379 Create a new location. See the notes below for details on how to choose the\r
 380    right protocol.\r
 381 </p>\r
 382 </li>\r
 383 <li>\r
 384 <p>\r
 385 Browse the <em>modules</em> available. It will give you a list of the heads in\r
 386    the repository. You will not be able to browse the tree from there. Only\r
 387    the heads.\r
 388 </p>\r
 389 </li>\r
 390 <li>\r
 391 <p>\r
 392 Pick <em>HEAD</em> when it asks what branch/tag to check out. Untick the\r
 393    "launch commit wizard" to avoid committing the .project file.\r
 394 </p>\r
 395 </li>\r
 396 </ol>\r
 397 <p>Protocol notes: If you are using anonymous access via pserver, just select that.\r
 398 Those using SSH access should choose the <em>ext</em> protocol, and configure <em>ext</em>\r
 399 access on the Preferences-&gt;Team-&gt;CVS-&gt;ExtConnection pane. Set CVS_SERVER to\r
 400 <em>git-cvsserver</em>. Not that password support is not good when using <em>ext</em>,\r
 401 you will definitely want to have SSH keys setup.</p>\r
 402 <p>Alternatively, you can just use the non-standard extssh protocol that Eclipse\r
 403 offer. In that case CVS_SERVER is ignored, and you will have to replace\r
 404 the cvs utility on the server with git-cvsserver or manipulate your .bashrc\r
 405 so that calling <em>cvs</em> effectively calls git-cvsserver.</p>\r
 406 </div>\r
 407 <h2>Clients known to work</h2>\r
 408 <div class="sectionbody">\r
 409 <p>CVS 1.12.9 on Debian\r
 410 CVS 1.11.17 on MacOSX (from Fink package)\r
 411 Eclipse 3.0, 3.1.2 on MacOSX (see Eclipse CVS Client Notes)\r
 412 TortoiseCVS</p>\r
 413 </div>\r
 414 <h2>Operations supported</h2>\r
 415 <div class="sectionbody">\r
 416 <p>All the operations required for normal use are supported, including\r
 417 checkout, diff, status, update, log, add, remove, commit.\r
 418 Legacy monitoring operations are not supported (edit, watch and related).\r
 419 Exports and tagging (tags and branches) are not supported at this stage.</p>\r
 420 <p>The server will set the -k mode to binary when relevant. In proper GIT\r
 421 tradition, the contents of the files are always respected.\r
 422 No keyword expansion or newline munging is supported.</p>\r
 423 </div>\r
 424 <h2>Dependencies</h2>\r
 425 <div class="sectionbody">\r
 426 <p>git-cvsserver depends on DBD::SQLite.</p>\r
 427 </div>\r
 428 <h2>Copyright and Authors</h2>\r
 429 <div class="sectionbody">\r
 430 <p>This program is copyright The Open University UK - 2006.</p>\r
 431 <p>Authors: Martyn Smith    &lt;martyn@catalyst.net.nz&gt;\r
 432          Martin Langhoff &lt;martin@catalyst.net.nz&gt;\r
 433          with ideas and patches from participants of the git-list &lt;git@vger.kernel.org&gt;.</p>\r
 434 </div>\r
 435 <h2>Documentation</h2>\r
 436 <div class="sectionbody">\r
 437 <p>Documentation by Martyn Smith &lt;martyn@catalyst.net.nz&gt; and Martin Langhoff &lt;martin@catalyst.net.nz&gt; Matthias Urlichs &lt;smurf@smurf.noris.de&gt;.</p>\r
 438 </div>\r
 439 <h2>GIT</h2>\r
 440 <div class="sectionbody">\r
 441 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 442 </div>\r
 443 <div id="footer">\r
 444 <div id="footer-text">\r
 445 Last updated 08-Jun-2006 00:48:14 UTC\r
 446 </div>\r
 447 </div>\r
 448 </body>\r
 449 </html>\r