Autogenerated HTML docs for v1.7.6-rc1
[git/jnareb-git.git] / gitcvs-migration.html
blob3778aac05fa8642d1bf825855b035ef5929177cc
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.4.5" />
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.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 gitcvs-migration(7) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>gitcvs-migration -
411 git for CVS users
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="paragraph"><p>git cvsimport *</p></div>
418 </div>
419 <h2 id="_description">DESCRIPTION</h2>
420 <div class="sectionbody">
421 <div class="paragraph"><p>Git differs from CVS in that every working tree contains a repository with
422 a full copy of the project history, and no repository is inherently more
423 important than any other. However, you can emulate the CVS model by
424 designating a single shared repository which people can synchronize with;
425 this document explains how to do that.</p></div>
426 <div class="paragraph"><p>Some basic familiarity with git is required. Having gone through
427 <a href="gittutorial.html">gittutorial(7)</a> and
428 <a href="gitglossary.html">gitglossary(7)</a> should be sufficient.</p></div>
429 </div>
430 <h2 id="_developing_against_a_shared_repository">Developing against a shared repository</h2>
431 <div class="sectionbody">
432 <div class="paragraph"><p>Suppose a shared repository is set up in /pub/repo.git on the host
433 foo.com. Then as an individual committer you can clone the shared
434 repository over ssh with:</p></div>
435 <div class="listingblock">
436 <div class="content">
437 <pre><tt>$ git clone foo.com:/pub/repo.git/ my-project
438 $ cd my-project</tt></pre>
439 </div></div>
440 <div class="paragraph"><p>and hack away. The equivalent of <em>cvs update</em> is</p></div>
441 <div class="listingblock">
442 <div class="content">
443 <pre><tt>$ git pull origin</tt></pre>
444 </div></div>
445 <div class="paragraph"><p>which merges in any work that others might have done since the clone
446 operation. If there are uncommitted changes in your working tree, commit
447 them first before running git pull.</p></div>
448 <div class="admonitionblock">
449 <table><tr>
450 <td class="icon">
451 <div class="title">Note</div>
452 </td>
453 <td class="content">
454 <div class="paragraph"><p>The <em>pull</em> command knows where to get updates from because of certain
455 configuration variables that were set by the first <em>git clone</em>
456 command; see <tt>git config -l</tt> and the <a href="git-config.html">git-config(1)</a> man
457 page for details.</p></div>
458 </td>
459 </tr></table>
460 </div>
461 <div class="paragraph"><p>You can update the shared repository with your changes by first committing
462 your changes, and then using the <em>git push</em> command:</p></div>
463 <div class="listingblock">
464 <div class="content">
465 <pre><tt>$ git push origin master</tt></pre>
466 </div></div>
467 <div class="paragraph"><p>to "push" those commits to the shared repository. If someone else has
468 updated the repository more recently, <em>git push</em>, like <em>cvs commit</em>, will
469 complain, in which case you must pull any changes before attempting the
470 push again.</p></div>
471 <div class="paragraph"><p>In the <em>git push</em> command above we specify the name of the remote branch
472 to update (<tt>master</tt>). If we leave that out, <em>git push</em> tries to update
473 any branches in the remote repository that have the same name as a branch
474 in the local repository. So the last <em>push</em> can be done with either of:</p></div>
475 <div class="listingblock">
476 <div class="content">
477 <pre><tt>$ git push origin
478 $ git push foo.com:/pub/project.git/</tt></pre>
479 </div></div>
480 <div class="paragraph"><p>as long as the shared repository does not have any branches
481 other than <tt>master</tt>.</p></div>
482 </div>
483 <h2 id="_setting_up_a_shared_repository">Setting Up a Shared Repository</h2>
484 <div class="sectionbody">
485 <div class="paragraph"><p>We assume you have already created a git repository for your project,
486 possibly created from scratch or from a tarball (see
487 <a href="gittutorial.html">gittutorial(7)</a>), or imported from an already existing CVS
488 repository (see the next section).</p></div>
489 <div class="paragraph"><p>Assume your existing repo is at /home/alice/myproject. Create a new "bare"
490 repository (a repository without a working tree) and fetch your project into
491 it:</p></div>
492 <div class="listingblock">
493 <div class="content">
494 <pre><tt>$ mkdir /pub/my-repo.git
495 $ cd /pub/my-repo.git
496 $ git --bare init --shared
497 $ git --bare fetch /home/alice/myproject master:master</tt></pre>
498 </div></div>
499 <div class="paragraph"><p>Next, give every team member read/write access to this repository. One
500 easy way to do this is to give all the team members ssh access to the
501 machine where the repository is hosted. If you don&#8217;t want to give them a
502 full shell on the machine, there is a restricted shell which only allows
503 users to do git pushes and pulls; see <a href="git-shell.html">git-shell(1)</a>.</p></div>
504 <div class="paragraph"><p>Put all the committers in the same group, and make the repository
505 writable by that group:</p></div>
506 <div class="listingblock">
507 <div class="content">
508 <pre><tt>$ chgrp -R $group /pub/my-repo.git</tt></pre>
509 </div></div>
510 <div class="paragraph"><p>Make sure committers have a umask of at most 027, so that the directories
511 they create are writable and searchable by other group members.</p></div>
512 </div>
513 <h2 id="_importing_a_cvs_archive">Importing a CVS archive</h2>
514 <div class="sectionbody">
515 <div class="paragraph"><p>First, install version 2.1 or higher of cvsps from
516 <a href="http://www.cobite.com/cvsps/">http://www.cobite.com/cvsps/</a> and make
517 sure it is in your path. Then cd to a checked out CVS working directory
518 of the project you are interested in and run <a href="git-cvsimport.html">git-cvsimport(1)</a>:</p></div>
519 <div class="listingblock">
520 <div class="content">
521 <pre><tt>$ git cvsimport -C &lt;destination&gt; &lt;module&gt;</tt></pre>
522 </div></div>
523 <div class="paragraph"><p>This puts a git archive of the named CVS module in the directory
524 &lt;destination&gt;, which will be created if necessary.</p></div>
525 <div class="paragraph"><p>The import checks out from CVS every revision of every file. Reportedly
526 cvsimport can average some twenty revisions per second, so for a
527 medium-sized project this should not take more than a couple of minutes.
528 Larger projects or remote repositories may take longer.</p></div>
529 <div class="paragraph"><p>The main trunk is stored in the git branch named <tt>origin</tt>, and additional
530 CVS branches are stored in git branches with the same names. The most
531 recent version of the main trunk is also left checked out on the <tt>master</tt>
532 branch, so you can start adding your own changes right away.</p></div>
533 <div class="paragraph"><p>The import is incremental, so if you call it again next month it will
534 fetch any CVS updates that have been made in the meantime. For this to
535 work, you must not modify the imported branches; instead, create new
536 branches for your own changes, and merge in the imported branches as
537 necessary.</p></div>
538 <div class="paragraph"><p>If you want a shared repository, you will need to make a bare clone
539 of the imported directory, as described above. Then treat the imported
540 directory as another development clone for purposes of merging
541 incremental imports.</p></div>
542 </div>
543 <h2 id="_advanced_shared_repository_management">Advanced Shared Repository Management</h2>
544 <div class="sectionbody">
545 <div class="paragraph"><p>Git allows you to specify scripts called "hooks" to be run at certain
546 points. You can use these, for example, to send all commits to the shared
547 repository to a mailing list. See <a href="githooks.html">githooks(5)</a>.</p></div>
548 <div class="paragraph"><p>You can enforce finer grained permissions using update hooks. See
549 <a href="howto/update-hook-example.txt">Controlling access to branches using
550 update hooks</a>.</p></div>
551 </div>
552 <h2 id="_providing_cvs_access_to_a_git_repository">Providing CVS Access to a git Repository</h2>
553 <div class="sectionbody">
554 <div class="paragraph"><p>It is also possible to provide true CVS access to a git repository, so
555 that developers can still use CVS; see <a href="git-cvsserver.html">git-cvsserver(1)</a> for
556 details.</p></div>
557 </div>
558 <h2 id="_alternative_development_models">Alternative Development Models</h2>
559 <div class="sectionbody">
560 <div class="paragraph"><p>CVS users are accustomed to giving a group of developers commit access to
561 a common repository. As we&#8217;ve seen, this is also possible with git.
562 However, the distributed nature of git allows other development models,
563 and you may want to first consider whether one of them might be a better
564 fit for your project.</p></div>
565 <div class="paragraph"><p>For example, you can choose a single person to maintain the project&#8217;s
566 primary public repository. Other developers then clone this repository
567 and each work in their own clone. When they have a series of changes that
568 they&#8217;re happy with, they ask the maintainer to pull from the branch
569 containing the changes. The maintainer reviews their changes and pulls
570 them into the primary repository, which other developers pull from as
571 necessary to stay coordinated. The Linux kernel and other projects use
572 variants of this model.</p></div>
573 <div class="paragraph"><p>With a small group, developers may just pull changes from each other&#8217;s
574 repositories without the need for a central maintainer.</p></div>
575 </div>
576 <h2 id="_see_also">SEE ALSO</h2>
577 <div class="sectionbody">
578 <div class="paragraph"><p><a href="gittutorial.html">gittutorial(7)</a>,
579 <a href="gittutorial-2.html">gittutorial-2(7)</a>,
580 <a href="gitcore-tutorial.html">gitcore-tutorial(7)</a>,
581 <a href="gitglossary.html">gitglossary(7)</a>,
582 <a href="everyday.html">Everyday Git</a>,
583 <a href="user-manual.html">The Git User&#8217;s Manual</a></p></div>
584 </div>
585 <h2 id="_git">GIT</h2>
586 <div class="sectionbody">
587 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite.</p></div>
588 </div>
589 <div id="footer">
590 <div id="footer-text">
591 Last updated 2010-01-21 17:44:19 UTC
592 </div>
593 </div>
594 </body>
595 </html>