OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / gitcvs-migration.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="gitcvs-migration(7)">\r
5 <articleinfo>\r
6     <title>gitcvs-migration(7)</title>\r
7         <indexterm>\r
8                 <primary>gitcvs-migration(7)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>gitcvs-migration - git for CVS users</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <simpara>git cvsimport *</simpara>\r
18 </simplesect>\r
19 <simplesect id="_description">\r
20 <title>DESCRIPTION</title>\r
21 <simpara>Git differs from CVS in that every working tree contains a repository with\r
22 a full copy of the project history, and no repository is inherently more\r
23 important than any other.  However, you can emulate the CVS model by\r
24 designating a single shared repository which people can synchronize with;\r
25 this document explains how to do that.</simpara>\r
26 <simpara>Some basic familiarity with git is required. Having gone through\r
27 <xref linkend="gittutorial(7)"/> and\r
28 <xref linkend="gitglossary(7)"/> should be sufficient.</simpara>\r
29 </simplesect>\r
30 <simplesect id="_developing_against_a_shared_repository">\r
31 <title>Developing against a shared repository</title>\r
32 <simpara>Suppose a shared repository is set up in /pub/repo.git on the host\r
33 foo.com.  Then as an individual committer you can clone the shared\r
34 repository over ssh with:</simpara>\r
35 <literallayout>$ git clone foo.com:/pub/repo.git/ my-project\r
36 $ cd my-project</literallayout>\r
37 <simpara>and hack away.  The equivalent of <emphasis>cvs update</emphasis> is</simpara>\r
38 <literallayout>$ git pull origin</literallayout>\r
39 <simpara>which merges in any work that others might have done since the clone\r
40 operation.  If there are uncommitted changes in your working tree, commit\r
41 them first before running git pull.</simpara>\r
42 <note>\r
43 <simpara>The <emphasis>pull</emphasis> command knows where to get updates from because of certain\r
44 configuration variables that were set by the first <emphasis>git-clone</emphasis>\r
45 command; see <literal>git config -l</literal> and the <xref linkend="git-config(1)"/> man\r
46 page for details.</simpara>\r
47 </note>\r
48 <simpara>You can update the shared repository with your changes by first committing\r
49 your changes, and then using the <emphasis>git-push</emphasis> command:</simpara>\r
50 <literallayout>$ git push origin master</literallayout>\r
51 <simpara>to "push" those commits to the shared repository.  If someone else has\r
52 updated the repository more recently, <emphasis>git-push</emphasis>, like <emphasis>cvs commit</emphasis>, will\r
53 complain, in which case you must pull any changes before attempting the\r
54 push again.</simpara>\r
55 <simpara>In the <emphasis>git-push</emphasis> command above we specify the name of the remote branch\r
56 to update (<literal>master</literal>).  If we leave that out, <emphasis>git-push</emphasis> tries to update\r
57 any branches in the remote repository that have the same name as a branch\r
58 in the local repository.  So the last <emphasis>push</emphasis> can be done with either of:</simpara>\r
59 <literallayout>$ git push origin\r
60 $ git push foo.com:/pub/project.git/</literallayout>\r
61 <simpara>as long as the shared repository does not have any branches\r
62 other than <literal>master</literal>.</simpara>\r
63 </simplesect>\r
64 <simplesect id="_setting_up_a_shared_repository">\r
65 <title>Setting Up a Shared Repository</title>\r
66 <simpara>We assume you have already created a git repository for your project,\r
67 possibly created from scratch or from a tarball (see\r
68 <xref linkend="gittutorial(7)"/>), or imported from an already existing CVS\r
69 repository (see the next section).</simpara>\r
70 <simpara>Assume your existing repo is at /home/alice/myproject.  Create a new "bare"\r
71 repository (a repository without a working tree) and fetch your project into\r
72 it:</simpara>\r
73 <literallayout>$ mkdir /pub/my-repo.git\r
74 $ cd /pub/my-repo.git\r
75 $ git --bare init --shared\r
76 $ git --bare fetch /home/alice/myproject master:master</literallayout>\r
77 <simpara>Next, give every team member read/write access to this repository.  One\r
78 easy way to do this is to give all the team members ssh access to the\r
79 machine where the repository is hosted.  If you don&#8217;t want to give them a\r
80 full shell on the machine, there is a restricted shell which only allows\r
81 users to do git pushes and pulls; see <xref linkend="git-shell(1)"/>.</simpara>\r
82 <simpara>Put all the committers in the same group, and make the repository\r
83 writable by that group:</simpara>\r
84 <literallayout>$ chgrp -R $group /pub/my-repo.git</literallayout>\r
85 <simpara>Make sure committers have a umask of at most 027, so that the directories\r
86 they create are writable and searchable by other group members.</simpara>\r
87 </simplesect>\r
88 <simplesect id="_importing_a_cvs_archive">\r
89 <title>Importing a CVS archive</title>\r
90 <simpara>First, install version 2.1 or higher of cvsps from\r
91 <ulink url="http://www.cobite.com/cvsps/">http://www.cobite.com/cvsps/</ulink> and make\r
92 sure it is in your path.  Then cd to a checked out CVS working directory\r
93 of the project you are interested in and run <emphasis>git-cvsimport</emphasis>:</simpara>\r
94 <literallayout>$ git cvsimport -C &lt;destination&gt; &lt;module&gt;</literallayout>\r
95 <simpara>This puts a git archive of the named CVS module in the directory\r
96 &lt;destination&gt;, which will be created if necessary.</simpara>\r
97 <simpara>The import checks out from CVS every revision of every file.  Reportedly\r
98 cvsimport can average some twenty revisions per second, so for a\r
99 medium-sized project this should not take more than a couple of minutes.\r
100 Larger projects or remote repositories may take longer.</simpara>\r
101 <simpara>The main trunk is stored in the git branch named <literal>origin</literal>, and additional\r
102 CVS branches are stored in git branches with the same names.  The most\r
103 recent version of the main trunk is also left checked out on the <literal>master</literal>\r
104 branch, so you can start adding your own changes right away.</simpara>\r
105 <simpara>The import is incremental, so if you call it again next month it will\r
106 fetch any CVS updates that have been made in the meantime.  For this to\r
107 work, you must not modify the imported branches; instead, create new\r
108 branches for your own changes, and merge in the imported branches as\r
109 necessary.</simpara>\r
110 <simpara>If you want a shared repository, you will need to make a bare clone\r
111 of the imported directory, as described above. Then treat the imported\r
112 directory as another development clone for purposes of merging\r
113 incremental imports.</simpara>\r
114 </simplesect>\r
115 <simplesect id="_advanced_shared_repository_management">\r
116 <title>Advanced Shared Repository Management</title>\r
117 <simpara>Git allows you to specify scripts called "hooks" to be run at certain\r
118 points.  You can use these, for example, to send all commits to the shared\r
119 repository to a mailing list.  See <xref linkend="githooks(5)"/>.</simpara>\r
120 <simpara>You can enforce finer grained permissions using update hooks.  See\r
121 <ulink url="howto/update-hook-example.txt">Controlling access to branches using\r
122 update hooks</ulink>.</simpara>\r
123 </simplesect>\r
124 <simplesect id="_providing_cvs_access_to_a_git_repository">\r
125 <title>Providing CVS Access to a git Repository</title>\r
126 <simpara>It is also possible to provide true CVS access to a git repository, so\r
127 that developers can still use CVS; see <xref linkend="git-cvsserver(1)"/> for\r
128 details.</simpara>\r
129 </simplesect>\r
130 <simplesect id="_alternative_development_models">\r
131 <title>Alternative Development Models</title>\r
132 <simpara>CVS users are accustomed to giving a group of developers commit access to\r
133 a common repository.  As we&#8217;ve seen, this is also possible with git.\r
134 However, the distributed nature of git allows other development models,\r
135 and you may want to first consider whether one of them might be a better\r
136 fit for your project.</simpara>\r
137 <simpara>For example, you can choose a single person to maintain the project&#8217;s\r
138 primary public repository.  Other developers then clone this repository\r
139 and each work in their own clone.  When they have a series of changes that\r
140 they&#8217;re happy with, they ask the maintainer to pull from the branch\r
141 containing the changes.  The maintainer reviews their changes and pulls\r
142 them into the primary repository, which other developers pull from as\r
143 necessary to stay coordinated.  The Linux kernel and other projects use\r
144 variants of this model.</simpara>\r
145 <simpara>With a small group, developers may just pull changes from each other&#8217;s\r
146 repositories without the need for a central maintainer.</simpara>\r
147 </simplesect>\r
148 <simplesect id="_see_also">\r
149 <title>SEE ALSO</title>\r
150 <simpara><xref linkend="gittutorial(7)"/>,\r
151 <xref linkend="gittutorial-2(7)"/>,\r
152 <xref linkend="gitcore-tutorial(7)"/>,\r
153 <xref linkend="gitglossary(7)"/>,\r
154 <ulink url="everyday.html">Everyday Git</ulink>,\r
155 <ulink url="user-manual.html">The Git User&#8217;s Manual</ulink></simpara>\r
156 </simplesect>\r
157 <simplesect id="_git">\r
158 <title>GIT</title>\r
159 <simpara>Part of the <xref linkend="git(1)"/> suite.</simpara>\r
160 </simplesect>\r
161 </article>\r