Documentation/gitcvs-migration.txt

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