Autogenerated HTML docs for v1.7.7-290-gc9e7aa
[git/jnareb-git.git] / gitcvs-migration.html
blob3735b24670dbdb1ce33a365ab11a16874074c0e7
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.5.2" />
7 <title>gitcvs-migration(7)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.0em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
131 div.content { /* Block element content. */
132 padding: 0;
135 /* Block element titles. */
136 div.title, caption.title {
137 color: #527bbd;
138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
144 div.title + * {
145 margin-top: 0;
148 td div.title:first-child {
149 margin-top: 0.0em;
151 div.content div.title:first-child {
152 margin-top: 0.0em;
154 div.content + div.title {
155 margin-top: 0.0em;
158 div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
164 div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
170 div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
173 margin-right: 10%;
174 border-left: 5px solid #dddddd;
175 color: #777777;
178 div.quoteblock > div.attribution {
179 padding-top: 0.5em;
180 text-align: right;
183 div.verseblock > div.content {
184 white-space: pre;
186 div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div.verseblock + div.attribution {
192 text-align: left;
195 div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
203 div.admonitionblock td.content {
204 padding-left: 0.5em;
205 border-left: 3px solid #dddddd;
208 div.exampleblock > div.content {
209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
213 div.imageblock div.content { padding-left: 0; }
214 span.image img { border-style: none; }
215 a.image:visited { color: white; }
217 dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
221 dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
224 font-style: normal;
225 color: navy;
227 dd > *:first-child {
228 margin-top: 0.1em;
231 ul, ol {
232 list-style-position: outside;
234 ol.arabic {
235 list-style-type: decimal;
237 ol.loweralpha {
238 list-style-type: lower-alpha;
240 ol.upperalpha {
241 list-style-type: upper-alpha;
243 ol.lowerroman {
244 list-style-type: lower-roman;
246 ol.upperroman {
247 list-style-type: upper-roman;
250 div.compact ul, div.compact ol,
251 div.compact p, div.compact p,
252 div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
257 div.tableblock > table {
258 border: 3px solid #527bbd;
260 thead, p.table.header {
261 font-family: sans-serif;
262 font-weight: bold;
264 tfoot {
265 font-weight: bold;
267 td > div.verse {
268 white-space: pre;
270 p.table {
271 margin-top: 0;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div.tableblock > table[frame="void"] {
275 border-style: none;
277 div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
281 div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
287 div.hdlist {
288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
291 div.hdlist tr {
292 padding-bottom: 15px;
294 dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
297 td.hdlist1 {
298 vertical-align: top;
299 font-style: normal;
300 padding-right: 0.8em;
301 color: navy;
303 td.hdlist2 {
304 vertical-align: top;
306 div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
311 .comment {
312 background: yellow;
315 .footnote, .footnoteref {
316 font-size: 0.8em;
319 span.footnote, span.footnoteref {
320 vertical-align: super;
323 #footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
328 #footnotes div.footnote {
329 margin: 0 0 5px 0;
332 #footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
343 @media print {
344 div#footer-badges { display: none; }
347 div#toc {
348 margin-bottom: 2.5em;
351 div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
364 div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
368 div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
372 div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
376 /* Overrides for manpage documents */
377 h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
383 h2 {
384 border-style: none;
386 div.sectionbody {
387 margin-left: 5%;
390 @media print {
391 div#toc { display: none; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
401 div.sidebar-title, div.image-title {
402 color: #527bbd;
403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
409 div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
415 div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
420 div.verseblock-content {
421 white-space: pre;
423 div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
428 div.exampleblock-content {
429 border-left: 3px solid #dddddd;
430 padding-left: 0.5em;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc a:visited { color: blue; }
435 </style>
436 <script type="text/javascript">
437 /*<![CDATA[*/
438 window.onload = function(){asciidoc.footnotes();}
439 var asciidoc = { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
449 * Version: 0.4
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
459 toc: function (toclevels) {
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
469 return text;
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
491 iterate(i);
495 iterate(el);
496 return result;
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
567 /*]]>*/
568 </script>
569 </head>
570 <body>
571 <div id="header">
572 <h1>
573 gitcvs-migration(7) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>gitcvs-migration -
578 git for CVS users
579 </p>
580 </div>
581 </div>
582 <div id="content">
583 <h2 id="_synopsis">SYNOPSIS</h2>
584 <div class="sectionbody">
585 <div class="verseblock">
586 <div class="verseblock-content"><em>git cvsimport</em> *</div>
587 <div class="verseblock-attribution">
588 </div></div>
589 </div>
590 <h2 id="_description">DESCRIPTION</h2>
591 <div class="sectionbody">
592 <div class="paragraph"><p>Git differs from CVS in that every working tree contains a repository with
593 a full copy of the project history, and no repository is inherently more
594 important than any other. However, you can emulate the CVS model by
595 designating a single shared repository which people can synchronize with;
596 this document explains how to do that.</p></div>
597 <div class="paragraph"><p>Some basic familiarity with git is required. Having gone through
598 <a href="gittutorial.html">gittutorial(7)</a> and
599 <a href="gitglossary.html">gitglossary(7)</a> should be sufficient.</p></div>
600 </div>
601 <h2 id="_developing_against_a_shared_repository">Developing against a shared repository</h2>
602 <div class="sectionbody">
603 <div class="paragraph"><p>Suppose a shared repository is set up in /pub/repo.git on the host
604 foo.com. Then as an individual committer you can clone the shared
605 repository over ssh with:</p></div>
606 <div class="listingblock">
607 <div class="content">
608 <pre><tt>$ git clone foo.com:/pub/repo.git/ my-project
609 $ cd my-project</tt></pre>
610 </div></div>
611 <div class="paragraph"><p>and hack away. The equivalent of <em>cvs update</em> is</p></div>
612 <div class="listingblock">
613 <div class="content">
614 <pre><tt>$ git pull origin</tt></pre>
615 </div></div>
616 <div class="paragraph"><p>which merges in any work that others might have done since the clone
617 operation. If there are uncommitted changes in your working tree, commit
618 them first before running git pull.</p></div>
619 <div class="admonitionblock">
620 <table><tr>
621 <td class="icon">
622 <div class="title">Note</div>
623 </td>
624 <td class="content">
625 <div class="paragraph"><p>The <em>pull</em> command knows where to get updates from because of certain
626 configuration variables that were set by the first <em>git clone</em>
627 command; see <tt>git config -l</tt> and the <a href="git-config.html">git-config(1)</a> man
628 page for details.</p></div>
629 </td>
630 </tr></table>
631 </div>
632 <div class="paragraph"><p>You can update the shared repository with your changes by first committing
633 your changes, and then using the <em>git push</em> command:</p></div>
634 <div class="listingblock">
635 <div class="content">
636 <pre><tt>$ git push origin master</tt></pre>
637 </div></div>
638 <div class="paragraph"><p>to "push" those commits to the shared repository. If someone else has
639 updated the repository more recently, <em>git push</em>, like <em>cvs commit</em>, will
640 complain, in which case you must pull any changes before attempting the
641 push again.</p></div>
642 <div class="paragraph"><p>In the <em>git push</em> command above we specify the name of the remote branch
643 to update (<tt>master</tt>). If we leave that out, <em>git push</em> tries to update
644 any branches in the remote repository that have the same name as a branch
645 in the local repository. So the last <em>push</em> can be done with either of:</p></div>
646 <div class="listingblock">
647 <div class="content">
648 <pre><tt>$ git push origin
649 $ git push foo.com:/pub/project.git/</tt></pre>
650 </div></div>
651 <div class="paragraph"><p>as long as the shared repository does not have any branches
652 other than <tt>master</tt>.</p></div>
653 </div>
654 <h2 id="_setting_up_a_shared_repository">Setting Up a Shared Repository</h2>
655 <div class="sectionbody">
656 <div class="paragraph"><p>We assume you have already created a git repository for your project,
657 possibly created from scratch or from a tarball (see
658 <a href="gittutorial.html">gittutorial(7)</a>), or imported from an already existing CVS
659 repository (see the next section).</p></div>
660 <div class="paragraph"><p>Assume your existing repo is at /home/alice/myproject. Create a new "bare"
661 repository (a repository without a working tree) and fetch your project into
662 it:</p></div>
663 <div class="listingblock">
664 <div class="content">
665 <pre><tt>$ mkdir /pub/my-repo.git
666 $ cd /pub/my-repo.git
667 $ git --bare init --shared
668 $ git --bare fetch /home/alice/myproject master:master</tt></pre>
669 </div></div>
670 <div class="paragraph"><p>Next, give every team member read/write access to this repository. One
671 easy way to do this is to give all the team members ssh access to the
672 machine where the repository is hosted. If you don&#8217;t want to give them a
673 full shell on the machine, there is a restricted shell which only allows
674 users to do git pushes and pulls; see <a href="git-shell.html">git-shell(1)</a>.</p></div>
675 <div class="paragraph"><p>Put all the committers in the same group, and make the repository
676 writable by that group:</p></div>
677 <div class="listingblock">
678 <div class="content">
679 <pre><tt>$ chgrp -R $group /pub/my-repo.git</tt></pre>
680 </div></div>
681 <div class="paragraph"><p>Make sure committers have a umask of at most 027, so that the directories
682 they create are writable and searchable by other group members.</p></div>
683 </div>
684 <h2 id="_importing_a_cvs_archive">Importing a CVS archive</h2>
685 <div class="sectionbody">
686 <div class="paragraph"><p>First, install version 2.1 or higher of cvsps from
687 <a href="http://www.cobite.com/cvsps/">http://www.cobite.com/cvsps/</a> and make
688 sure it is in your path. Then cd to a checked out CVS working directory
689 of the project you are interested in and run <a href="git-cvsimport.html">git-cvsimport(1)</a>:</p></div>
690 <div class="listingblock">
691 <div class="content">
692 <pre><tt>$ git cvsimport -C &lt;destination&gt; &lt;module&gt;</tt></pre>
693 </div></div>
694 <div class="paragraph"><p>This puts a git archive of the named CVS module in the directory
695 &lt;destination&gt;, which will be created if necessary.</p></div>
696 <div class="paragraph"><p>The import checks out from CVS every revision of every file. Reportedly
697 cvsimport can average some twenty revisions per second, so for a
698 medium-sized project this should not take more than a couple of minutes.
699 Larger projects or remote repositories may take longer.</p></div>
700 <div class="paragraph"><p>The main trunk is stored in the git branch named <tt>origin</tt>, and additional
701 CVS branches are stored in git branches with the same names. The most
702 recent version of the main trunk is also left checked out on the <tt>master</tt>
703 branch, so you can start adding your own changes right away.</p></div>
704 <div class="paragraph"><p>The import is incremental, so if you call it again next month it will
705 fetch any CVS updates that have been made in the meantime. For this to
706 work, you must not modify the imported branches; instead, create new
707 branches for your own changes, and merge in the imported branches as
708 necessary.</p></div>
709 <div class="paragraph"><p>If you want a shared repository, you will need to make a bare clone
710 of the imported directory, as described above. Then treat the imported
711 directory as another development clone for purposes of merging
712 incremental imports.</p></div>
713 </div>
714 <h2 id="_advanced_shared_repository_management">Advanced Shared Repository Management</h2>
715 <div class="sectionbody">
716 <div class="paragraph"><p>Git allows you to specify scripts called "hooks" to be run at certain
717 points. You can use these, for example, to send all commits to the shared
718 repository to a mailing list. See <a href="githooks.html">githooks(5)</a>.</p></div>
719 <div class="paragraph"><p>You can enforce finer grained permissions using update hooks. See
720 <a href="howto/update-hook-example.txt">Controlling access to branches using
721 update hooks</a>.</p></div>
722 </div>
723 <h2 id="_providing_cvs_access_to_a_git_repository">Providing CVS Access to a git Repository</h2>
724 <div class="sectionbody">
725 <div class="paragraph"><p>It is also possible to provide true CVS access to a git repository, so
726 that developers can still use CVS; see <a href="git-cvsserver.html">git-cvsserver(1)</a> for
727 details.</p></div>
728 </div>
729 <h2 id="_alternative_development_models">Alternative Development Models</h2>
730 <div class="sectionbody">
731 <div class="paragraph"><p>CVS users are accustomed to giving a group of developers commit access to
732 a common repository. As we&#8217;ve seen, this is also possible with git.
733 However, the distributed nature of git allows other development models,
734 and you may want to first consider whether one of them might be a better
735 fit for your project.</p></div>
736 <div class="paragraph"><p>For example, you can choose a single person to maintain the project&#8217;s
737 primary public repository. Other developers then clone this repository
738 and each work in their own clone. When they have a series of changes that
739 they&#8217;re happy with, they ask the maintainer to pull from the branch
740 containing the changes. The maintainer reviews their changes and pulls
741 them into the primary repository, which other developers pull from as
742 necessary to stay coordinated. The Linux kernel and other projects use
743 variants of this model.</p></div>
744 <div class="paragraph"><p>With a small group, developers may just pull changes from each other&#8217;s
745 repositories without the need for a central maintainer.</p></div>
746 </div>
747 <h2 id="_see_also">SEE ALSO</h2>
748 <div class="sectionbody">
749 <div class="paragraph"><p><a href="gittutorial.html">gittutorial(7)</a>,
750 <a href="gittutorial-2.html">gittutorial-2(7)</a>,
751 <a href="gitcore-tutorial.html">gitcore-tutorial(7)</a>,
752 <a href="gitglossary.html">gitglossary(7)</a>,
753 <a href="everyday.html">Everyday Git</a>,
754 <a href="user-manual.html">The Git User&#8217;s Manual</a></p></div>
755 </div>
756 <h2 id="_git">GIT</h2>
757 <div class="sectionbody">
758 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite.</p></div>
759 </div>
760 </div>
761 <div id="footnotes"><hr /></div>
762 <div id="footer">
763 <div id="footer-text">
764 Last updated 2011-09-21 23:01:14 PDT
765 </div>
766 </div>
767 </body>
768 </html>