Autogenerated HTML docs for v1.2.4-g9201
[git.git] / git-cvsserver.html
index 06ac3e7..500cd5e 100644 (file)
@@ -287,15 +287,37 @@ plugin. Most functionality works fine with both of these clients.</p>
 </div>\r
 <h2>LIMITATIONS</h2>\r
 <div class="sectionbody">\r
-<p>Currently gitcvs only works over ssh connections.</p>\r
+<p>Currently cvsserver works over SSH connections for read/write clients, and\r
+over pserver for anonymous CVS access.</p>\r
+<p>CVS clients cannot tag, branch or perform GIT merges.</p>\r
 </div>\r
 <h2>INSTALLATION</h2>\r
 <div class="sectionbody">\r
 <ol>\r
 <li>\r
 <p>\r
-Put server.pl somewhere useful on the same machine that is hosting your git repos\r
+If you are going to offer anonymous CVS access via pserver, add a line in\r
+   /etc/inetd.conf like\r
 </p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>cvspserver stream tcp nowait nobody git-cvsserver pserver</tt></pre>\r
+</div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>Note: In some cases, you need to pass the 'pserver' argument twice for\r
+git-cvsserver to see it. So the line would look like</tt></pre>\r
+</div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>cvspserver stream tcp nowait nobody git-cvsserver pserver pserver</tt></pre>\r
+</div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>No special setup is needed for SSH access, other than having GIT tools\r
+in the PATH. If you have clients that do not accept the CVS_SERVER\r
+env variable, you can rename git-cvsserver to cvs.</tt></pre>\r
+</div></div>\r
 </li>\r
 <li>\r
 <p>\r
@@ -306,29 +328,52 @@ For each repo that you want accessible from CVS you need to edit config in
 <div class="content">\r
 <pre><tt>[gitcvs]\r
      enabled=1\r
+     # optional for debugging\r
      logfile=/path/to/logfile</tt></pre>\r
 </div></div>\r
 <div class="literalblock">\r
 <div class="content">\r
-<pre><tt>n.b. you need to ensure each user that is going to invoke server.pl has\r
-write access to the log file.</tt></pre>\r
+<pre><tt>Note: you need to ensure each user that is going to invoke git-cvsserver has\r
+write access to the log file and to the git repository. When offering anon\r
+access via pserver, this means that the nobody user should have write access\r
+to at least the sqlite database at the root of the repository.</tt></pre>\r
+</div></div>\r
+</li>\r
+<li>\r
+<p>\r
+On the client machine you need to set the following variables.\r
+   CVSROOT should be set as per normal, but the directory should point at the\r
+   appropriate git repo. For example:\r
+</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>For SSH access, CVS_SERVER should be set to git-cvsserver</tt></pre>\r
+</div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>Example:</tt></pre>\r
+</div></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>export CVSROOT=:ext:user@server:/var/git/project.git\r
+export CVS_SERVER=git-cvsserver</tt></pre>\r
 </div></div>\r
 </li>\r
 <li>\r
 <p>\r
-On each client machine you need to set the following variables.\r
-     CVSROOT should be set as per normal, but the directory should point at the\r
-             appropriate git repo.\r
-     CVS_SERVER should be set to the server.pl script that has been put on the\r
-                remote machine.\r
+For SSH clients that will make commits, make sure their .bashrc file\r
+   sets the GIT_AUTHOR and GIT_COMMITTER variables.\r
 </p>\r
 </li>\r
 <li>\r
 <p>\r
-Clients should now be able to check out modules (where modules are the names\r
-   of branches in git).\r
-     $ cvs co -d mylocaldir master\r
+Clients should now be able to check out the project. Use the CVS <em>module</em>\r
+   name to indicate what GIT <em>head</em> you want to check out. Example:\r
 </p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>cvs co -d project-master master</tt></pre>\r
+</div></div>\r
 </li>\r
 </ol>\r
 </div>\r
@@ -338,30 +383,38 @@ Clients should now be able to check out modules (where modules are the names
 <ol>\r
 <li>\r
 <p>\r
-Create a new project from CVS checkout, giving it repository and module\r
+Select "Create a new project -&gt; From CVS checkout"\r
 </p>\r
 </li>\r
 <li>\r
 <p>\r
-Context Menu-&gt;Team-&gt;Share Project&#8230;\r
+Create a new location. See the notes below for details on how to choose the\r
+   right protocol.\r
 </p>\r
 </li>\r
 <li>\r
 <p>\r
-Enter the repository and module information again and click Finish\r
+Browse the <em>modules</em> available. It will give you a list of the heads in\r
+   the repository. You will not be able to browse the tree from there. Only\r
+   the heads.\r
 </p>\r
 </li>\r
 <li>\r
 <p>\r
-The Synchronize view appears. Untick  "launch commit wizard" to avoid\r
-committing the .project file, and select HEAD as the tag to synchronize to.\r
-Update all incoming changes.\r
+Pick <em>HEAD</em> when it asks what branch/tag to check out. Untick the\r
+   "launch commit wizard" to avoid committing the .project file.\r
 </p>\r
 </li>\r
 </ol>\r
-<p>Note that most versions of Eclipse ignore CVS_SERVER (which you can set in\r
-the Preferences-&gt;Team-&gt;CVS-&gt;ExtConnection pane), so you may have to\r
-rename, alias or symlink git-cvsserver to <em>cvs</em> on the server.</p>\r
+<p>Protocol notes: If you are using anonymous acces via pserver, just select that.\r
+Those using SSH access should choose the <em>ext</em> protocol, and configure <em>ext</em>\r
+access on the Preferences-&gt;Team-&gt;CVS-&gt;ExtConnection pane. Set CVS_SERVER to\r
+<em>git-cvsserver</em>. Not that password support is not good when using <em>ext</em>,\r
+you will definitely want to have SSH keys setup.</p>\r
+<p>Alternatively, you can just use the non-standard extssh protocol that Eclipse\r
+offer. In that case CVS_SERVER is ignored, and you will have to replace\r
+the cvs utility on the server with git-cvsserver or manipulate your .bashrc\r
+so that calling <em>cvs</em> effectively calls git-cvsserver.</p>\r
 </div>\r
 <h2>Clients known to work</h2>\r
 <div class="sectionbody">\r
@@ -393,7 +446,7 @@ No keyword expansion or newline munging is supported.</p>
 </div>\r
 <h2>Documentation</h2>\r
 <div class="sectionbody">\r
-<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
+<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
 </div>\r
 <h2>GIT</h2>\r
 <div class="sectionbody">\r
@@ -401,7 +454,7 @@ No keyword expansion or newline munging is supported.</p>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 01-Mar-2006 12:05:10 UTC\r
+Last updated 05-Mar-2006 10:51:09 UTC\r
 </div>\r
 </div>\r
 </body>\r