Documentation/everyday.txt

   1 Everyday GIT With 20 Commands Or So
   2 ===================================
   3
   4 GIT suite has over 100 commands, and the manual page for each of
   5 them discusses what the command does and how it is used in
   6 detail, but until you know what command should be used in order
   7 to achieve what you want to do, you cannot tell which manual
   8 page to look at, and if you know that already you do not need
   9 the manual.
  10
  11 Does that mean you need to know all of them before you can use
  12 git?  Not at all.  Depending on the role you play, the set of
  13 commands you need to know is slightly different, but in any case
  14 what you need to learn is far smaller than the full set of
  15 commands to carry out your day-to-day work.  This document is to
  16 serve as a cheat-sheet and a set of pointers for people playing
  17 various roles.
  18
  19 <<Basic Repository>> commands are needed by people who has a
  20 repository --- that is everybody, because every working tree of
  21 git is a repository.
  22
  23 In addition, <<Individual Developer (Standalone)>> commands are
  24 essential for anybody who makes a commit, even for somebody who
  25 works alone.
  26
  27 If you work with other people, you will need commands listed in
  28 <<Individual Developer (Participant)>> section as well.
  29
  30 People who play <<Integrator>> role need to learn some more
  31 commands in addition to the above.
  32
  33 <<Repository Administration>> commands are for system
  34 administrators who are responsible to care and feed git
  35 repositories to support developers.
  36
  37
  38 Basic Repository[[Basic Repository]]
  39 ------------------------------------
  40
  41 Everybody uses these commands to feed and care git repositories.
  42
  43   * gitlink:git-init-db[1] or gitlink:git-clone[1] to create a
  44     new repository.
  45
  46   * gitlink:git-fsck-objects[1] to validate the repository.
  47
  48   * gitlink:git-prune[1] to garbage collect cruft in the
  49     repository.
  50
  51   * gitlink:git-repack[1] to pack loose objects for efficiency.
  52
  53 Examples
  54 ~~~~~~~~
  55
  56 Check health and remove cruft.::
  57 +
  58 ------------
  59 $ git fsck-objects <1>
  60 $ git prune
  61 $ git count-objects <2>
  62 $ git repack <3>
  63 $ git prune <4>
  64 ------------
  65 +
  66 <1> running without "--full" is usually cheap and assures the
  67 repository health reasonably well.
  68 <2> check how many loose objects there are and how much
  69 disk space is wasted by not repacking.
  70 <3> without "-a" repacks incrementally.  repacking every 4-5MB
  71 of loose objects accumulation may be a good rule of thumb.
  72 <4> after repack, prune removes the duplicate loose objects.
  73
  74 Repack a small project into single pack.::
  75 +
  76 ------------
  77 $ git repack -a -d <1>
  78 $ git prune
  79 ------------
  80 +
  81 <1> pack all the objects reachable from the refs into one pack
  82 and remove unneeded other packs
  83
  84
  85 Individual Developer (Standalone)[[Individual Developer (Standalone)]]
  86 ----------------------------------------------------------------------
  87
  88 A standalone individual developer does not exchange patches with
  89 other people, and works alone in a single repository, using the
  90 following commands.
  91
  92   * gitlink:git-show-branch[1] to see where you are.
  93
  94   * gitlink:git-log[1] to see what happened.
  95
  96   * gitlink:git-whatchanged[1] to find out where things have
  97     come from.
  98
  99   * gitlink:git-checkout[1] and gitlink:git-branch[1] to switch
 100     branches.
 101
 102   * gitlink:git-add[1] and gitlink:git-update-index[1] to manage
 103     the index file.
 104
 105   * gitlink:git-diff[1] and gitlink:git-status[1] to see what
 106     you are in the middle of doing.
 107
 108   * gitlink:git-commit[1] to advance the current branch.
 109
 110   * gitlink:git-reset[1] and gitlink:git-checkout[1] (with
 111     pathname parameters) to undo changes.
 112
 113   * gitlink:git-pull[1] with "." as the remote to merge between
 114     local branches.
 115
 116   * gitlink:git-rebase[1] to maintain topic branches.
 117
 118   * gitlink:git-tag[1] to mark known point.
 119
 120 Examples
 121 ~~~~~~~~
 122
 123 Extract a tarball and create a working tree and a new repository to keep track of it.::
 124 +
 125 ------------
 126 $ tar zxf frotz.tar.gz
 127 $ cd frotz
 128 $ git-init-db
 129 $ git add . <1>
 130 $ git commit -m 'import of frotz source tree.'
 131 $ git tag v2.43 <2>
 132 ------------
 133 +
 134 <1> add everything under the current directory.
 135 <2> make a lightweight, unannotated tag.
 136
 137 Create a topic branch and develop.::
 138 +
 139 ------------
 140 $ git checkout -b alsa-audio <1>
 141 $ edit/compile/test
 142 $ git checkout -- curses/ux_audio_oss.c <2>
 143 $ git add curses/ux_audio_alsa.c <3>
 144 $ edit/compile/test
 145 $ git diff <4>
 146 $ git commit -a -s <5>
 147 $ edit/compile/test
 148 $ git reset --soft HEAD^ <6>
 149 $ edit/compile/test
 150 $ git diff ORIG_HEAD <7>
 151 $ git commit -a -c ORIG_HEAD <8>
 152 $ git checkout master <9>
 153 $ git pull . alsa-audio <10>
 154 $ git log --since='3 days ago' <11>
 155 $ git log v2.43.. curses/ <12>
 156 ------------
 157 +
 158 <1> create a new topic branch.
 159 <2> revert your botched changes in "curses/ux_audio_oss.c".
 160 <3> you need to tell git if you added a new file; removal and
 161 modification will be caught if you do "commit -a" later.
 162 <4> to see what changes you are committing.
 163 <5> commit everything as you have tested, with your sign-off.
 164 <6> take the last commit back, keeping what is in the working tree.
 165 <7> look at the changes since the premature commit we took back.
 166 <8> redo the commit undone in the previous step, using the message
 167 you originally wrote.
 168 <9> switch to the master branch.
 169 <10> merge a topic branch into your master branch
 170 <11> review commit logs; other forms to limit output can be
 171 combined and include --max-count=10 (show 10 commits), --until='2005-12-10'.
 172 <12> view only the changes that touch what's in curses/
 173 directory, since v2.43 tag.
 174
 175
 176 Individual Developer (Participant)[[Individual Developer (Participant)]]
 177 ------------------------------------------------------------------------
 178
 179 A developer working as a participant in a group project needs to
 180 learn how to communicate with others, and uses these commands in
 181 addition to the ones needed by a standalone developer.
 182
 183   * gitlink:git-clone[1] from the upstream to prime your local
 184     repository.
 185
 186   * gitlink:git-pull[1] and gitlink:git-fetch[1] from "origin"
 187     to keep up-to-date with the upstream.
 188
 189   * gitlink:git-push[1] to shared repository, if you adopt CVS
 190     style shared repository workflow.
 191
 192   * gitlink:git-format-patch[1] to prepare e-mail submission, if
 193     you adopt Linux kernel-style public forum workflow.
 194
 195 Examples
 196 ~~~~~~~~
 197
 198 Clone the upstream and work on it.  Feed changes to upstream.::
 199 +
 200 ------------
 201 $ git clone git://git.kernel.org/pub/scm/.../torvalds/linux-2.6 my2.6
 202 $ cd my2.6
 203 $ edit/compile/test; git commit -a -s <1>
 204 $ git format-patch origin <2>
 205 $ git pull <3>
 206 $ git whatchanged -p ORIG_HEAD.. arch/i386 include/asm-i386 <4>
 207 $ git pull git://git.kernel.org/pub/.../jgarzik/libata-dev.git ALL <5>
 208 $ git reset --hard ORIG_HEAD <6>
 209 $ git prune <7>
 210 $ git fetch --tags <8>
 211 ------------
 212 +
 213 <1> repeat as needed.
 214 <2> extract patches from your branch for e-mail submission.
 215 <3> "pull" fetches from "origin" by default and merges into the
 216 current branch.
 217 <4> immediately after pulling, look at the changes done upstream
 218 since last time we checked, only in the
 219 area we are interested in.
 220 <5> fetch from a specific branch from a specific repository and merge.
 221 <6> revert the pull.
 222 <7> garbage collect leftover objects from reverted pull.
 223 <8> from time to time, obtain official tags from the "origin"
 224 and store them under .git/refs/tags/.
 225
 226
 227 Push into another repository.::
 228 +
 229 ------------
 230 satellite$ git clone mothership:frotz/.git frotz <1>
 231 satellite$ cd frotz
 232 satellite$ cat .git/remotes/origin <2>
 233 URL: mothership:frotz/.git
 234 Pull: master:origin
 235 satellite$ echo 'Push: master:satellite' >>.git/remotes/origin <3>
 236 satellite$ edit/compile/test/commit
 237 satellite$ git push origin <4>
 238
 239 mothership$ cd frotz
 240 mothership$ git checkout master
 241 mothership$ git pull . satellite <5>
 242 ------------
 243 +
 244 <1> mothership machine has a frotz repository under your home
 245 directory; clone from it to start a repository on the satellite
 246 machine.
 247 <2> clone creates this file by default.  It arranges "git pull"
 248 to fetch and store the master branch head of mothership machine
 249 to local "origin" branch.
 250 <3> arrange "git push" to push local "master" branch to
 251 "satellite" branch of the mothership machine.
 252 <4> push will stash our work away on "satellite" branch on the
 253 mothership machine.  You could use this as a back-up method.
 254 <5> on mothership machine, merge the work done on the satellite
 255 machine into the master branch.
 256
 257 Branch off of a specific tag.::
 258 +
 259 ------------
 260 $ git checkout -b private2.6.14 v2.6.14 <1>
 261 $ edit/compile/test; git commit -a
 262 $ git checkout master
 263 $ git format-patch -k -m --stdout v2.6.14..private2.6.14 |
 264   git am -3 -k <2>
 265 ------------
 266 +
 267 <1> create a private branch based on a well known (but somewhat behind)
 268 tag.
 269 <2> forward port all changes in private2.6.14 branch to master branch
 270 without a formal "merging".
 271
 272
 273 Integrator[[Integrator]]
 274 ------------------------
 275
 276 A fairly central person acting as the integrator in a group
 277 project receives changes made by others, reviews and integrates
 278 them and publishes the result for others to use, using these
 279 commands in addition to the ones needed by participants.
 280
 281   * gitlink:git-am[1] to apply patches e-mailed in from your
 282     contributors.
 283
 284   * gitlink:git-pull[1] to merge from your trusted lieutenants.
 285
 286   * gitlink:git-format-patch[1] to prepare and send suggested
 287     alternative to contributors.
 288
 289   * gitlink:git-revert[1] to undo botched commits.
 290
 291   * gitlink:git-push[1] to publish the bleeding edge.
 292
 293
 294 Examples
 295 ~~~~~~~~
 296
 297 My typical GIT day.::
 298 +
 299 ------------
 300 $ git status <1>
 301 $ git show-branch <2>
 302 $ mailx <3>
 303 & s 2 3 4 5 ./+to-apply
 304 & s 7 8 ./+hold-linus
 305 & q
 306 $ git checkout master
 307 $ git am -3 -i -s -u ./+to-apply <4>
 308 $ compile/test
 309 $ git checkout -b hold/linus && git am -3 -i -s -u ./+hold-linus <5>
 310 $ git checkout topic/one && git rebase master <6>
 311 $ git checkout pu && git reset --hard master <7>
 312 $ git pull . topic/one topic/two && git pull . hold/linus <8>
 313 $ git checkout maint
 314 $ git cherry-pick master~4 <9>
 315 $ compile/test
 316 $ git tag -s -m 'GIT 0.99.9x' v0.99.9x <10>
 317 $ git fetch ko && git show-branch master maint 'tags/ko-*' <11>
 318 $ git push ko <12>
 319 $ git push ko v0.99.9x <13>
 320 ------------
 321 +
 322 <1> see what I was in the middle of doing, if any.
 323 <2> see what topic branches I have and think about how ready
 324 they are.
 325 <3> read mails, save ones that are applicable, and save others
 326 that are not quite ready.
 327 <4> apply them, interactively, with my sign-offs.
 328 <5> create topic branch as needed and apply, again with my
 329 sign-offs.
 330 <6> rebase internal topic branch that has not been merged to the
 331 master, nor exposed as a part of a stable branch.
 332 <7> restart "pu" every time from the master.
 333 <8> and bundle topic branches still cooking.
 334 <9> backport a critical fix.
 335 <10> create a signed tag.
 336 <11> make sure I did not accidentally rewind master beyond what I
 337 already pushed out.  "ko" shorthand points at the repository I have
 338 at kernel.org, and looks like this:
 339 +
 340 ------------
 341 $ cat .git/remotes/ko
 342 URL: kernel.org:/pub/scm/git/git.git
 343 Pull: master:refs/tags/ko-master
 344 Pull: maint:refs/tags/ko-maint
 345 Push: master
 346 Push: +pu
 347 Push: maint
 348 ------------
 349 +
 350 In the output from "git show-branch", "master" should have
 351 everything "ko-master" has.
 352
 353 <12> push out the bleeding edge.
 354 <13> push the tag out, too.
 355
 356
 357 Repository Administration[[Repository Administration]]
 358 ------------------------------------------------------
 359
 360 A repository administrator uses the following tools to set up
 361 and maintain access to the repository by developers.
 362
 363   * gitlink:git-daemon[1] to allow anonymous download from
 364     repository.
 365
 366   * gitlink:git-shell[1] can be used as a 'restricted login shell'
 367     for shared central repository users.
 368
 369 link:howto/update-hook-example.txt[update hook howto] has a good
 370 example of managing a shared central repository.
 371
 372
 373 Examples
 374 ~~~~~~~~
 375 Run git-daemon to serve /pub/scm from inetd.::
 376 +
 377 ------------
 378 $ grep git /etc/inetd.conf
 379 git     stream  tcp     nowait  nobody \
 380   /usr/bin/git-daemon git-daemon --inetd --syslog --export-all /pub/scm
 381 ------------
 382 +
 383 The actual configuration line should be on one line.
 384
 385 Run git-daemon to serve /pub/scm from xinetd.::
 386 +
 387 ------------
 388 $ cat /etc/xinetd.d/git-daemon
 389 # default: off
 390 # description: The git server offers access to git repositories
 391 service git
 392 {
 393         disable = no
 394         type            = UNLISTED
 395         port            = 9418
 396         socket_type     = stream
 397         wait            = no
 398         user            = nobody
 399         server          = /usr/bin/git-daemon
 400         server_args     = --inetd --syslog --export-all --base-path=/pub/scm
 401         log_on_failure  += USERID
 402 }
 403 ------------
 404 +
 405 Check your xinetd(8) documentation and setup, this is from a Fedora system.
 406 Others might be different.
 407
 408 Give push/pull only access to developers.::
 409 +
 410 ------------
 411 $ grep git /etc/passwd <1>
 412 alice:x:1000:1000::/home/alice:/usr/bin/git-shell
 413 bob:x:1001:1001::/home/bob:/usr/bin/git-shell
 414 cindy:x:1002:1002::/home/cindy:/usr/bin/git-shell
 415 david:x:1003:1003::/home/david:/usr/bin/git-shell
 416 $ grep git /etc/shells <2>
 417 /usr/bin/git-shell
 418 ------------
 419 +
 420 <1> log-in shell is set to /usr/bin/git-shell, which does not
 421 allow anything but "git push" and "git pull".  The users should
 422 get an ssh access to the machine.
 423 <2> in many distributions /etc/shells needs to list what is used
 424 as the login shell.
 425
 426 CVS-style shared repository.::
 427 +
 428 ------------
 429 $ grep git /etc/group <1>
 430 git:x:9418:alice,bob,cindy,david
 431 $ cd /home/devo.git
 432 $ ls -l <2>
 433   lrwxrwxrwx   1 david git    17 Dec  4 22:40 HEAD -> refs/heads/master
 434   drwxrwsr-x   2 david git  4096 Dec  4 22:40 branches
 435   -rw-rw-r--   1 david git    84 Dec  4 22:40 config
 436   -rw-rw-r--   1 david git    58 Dec  4 22:40 description
 437   drwxrwsr-x   2 david git  4096 Dec  4 22:40 hooks
 438   -rw-rw-r--   1 david git 37504 Dec  4 22:40 index
 439   drwxrwsr-x   2 david git  4096 Dec  4 22:40 info
 440   drwxrwsr-x   4 david git  4096 Dec  4 22:40 objects
 441   drwxrwsr-x   4 david git  4096 Nov  7 14:58 refs
 442   drwxrwsr-x   2 david git  4096 Dec  4 22:40 remotes
 443 $ ls -l hooks/update <3>
 444   -r-xr-xr-x   1 david git  3536 Dec  4 22:40 update
 445 $ cat info/allowed-users <4>
 446 refs/heads/master       alice\|cindy
 447 refs/heads/doc-update   bob
 448 refs/tags/v[0-9]*       david
 449 ------------
 450 +
 451 <1> place the developers into the same git group.
 452 <2> and make the shared repository writable by the group.
 453 <3> use update-hook example by Carl from Documentation/howto/
 454 for branch policy control.
 455 <4> alice and cindy can push into master, only bob can push into doc-update.
 456 david is the release manager and is the only person who can
 457 create and push version tags.
 458
 459 HTTP server to support dumb protocol transfer.::
 460 +
 461 ------------
 462 dev$ git update-server-info <1>
 463 dev$ ftp user@isp.example.com <2>
 464 ftp> cp -r .git /home/user/myproject.git
 465 ------------
 466 +
 467 <1> make sure your info/refs and objects/info/packs are up-to-date
 468 <2> upload to public HTTP server hosted by your ISP.