Documentation/everyday.txt

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