Documentation / gitcore-tutorial.txton commit Merge branch 'ag/rewrite_one' into maint (1e040c0)
   1gitcore-tutorial(7)
   2===================
   3
   4NAME
   5----
   6gitcore-tutorial - A git core tutorial for developers
   7
   8SYNOPSIS
   9--------
  10git *
  11
  12DESCRIPTION
  13-----------
  14
  15This tutorial explains how to use the "core" git programs to set up and
  16work with a git repository.
  17
  18If you just need to use git as a revision control system you may prefer
  19to start with linkgit:gittutorial[7][a tutorial introduction to git] or
  20link:user-manual.html[the git user manual].
  21
  22However, an understanding of these low-level tools can be helpful if
  23you want to understand git's internals.
  24
  25The core git is often called "plumbing", with the prettier user
  26interfaces on top of it called "porcelain". You may not want to use the
  27plumbing directly very often, but it can be good to know what the
  28plumbing does for when the porcelain isn't flushing.
  29
  30[NOTE]
  31Deeper technical details are often marked as Notes, which you can
  32skip on your first reading.
  33
  34
  35Creating a git repository
  36-------------------------
  37
  38Creating a new git repository couldn't be easier: all git repositories start
  39out empty, and the only thing you need to do is find yourself a
  40subdirectory that you want to use as a working tree - either an empty
  41one for a totally new project, or an existing working tree that you want
  42to import into git.
  43
  44For our first example, we're going to start a totally new repository from
  45scratch, with no pre-existing files, and we'll call it `git-tutorial`.
  46To start up, create a subdirectory for it, change into that
  47subdirectory, and initialize the git infrastructure with `git-init`:
  48
  49------------------------------------------------
  50$ mkdir git-tutorial
  51$ cd git-tutorial
  52$ git-init
  53------------------------------------------------
  54
  55to which git will reply
  56
  57----------------
  58Initialized empty Git repository in .git/
  59----------------
  60
  61which is just git's way of saying that you haven't been doing anything
  62strange, and that it will have created a local `.git` directory setup for
  63your new project. You will now have a `.git` directory, and you can
  64inspect that with `ls`. For your new empty project, it should show you
  65three entries, among other things:
  66
  67 - a file called `HEAD`, that has `ref: refs/heads/master` in it.
  68   This is similar to a symbolic link and points at
  69   `refs/heads/master` relative to the `HEAD` file.
  70+
  71Don't worry about the fact that the file that the `HEAD` link points to
  72doesn't even exist yet -- you haven't created the commit that will
  73start your `HEAD` development branch yet.
  74
  75 - a subdirectory called `objects`, which will contain all the
  76   objects of your project. You should never have any real reason to
  77   look at the objects directly, but you might want to know that these
  78   objects are what contains all the real 'data' in your repository.
  79
  80 - a subdirectory called `refs`, which contains references to objects.
  81
  82In particular, the `refs` subdirectory will contain two other
  83subdirectories, named `heads` and `tags` respectively. They do
  84exactly what their names imply: they contain references to any number
  85of different 'heads' of development (aka 'branches'), and to any
  86'tags' that you have created to name specific versions in your
  87repository.
  88
  89One note: the special `master` head is the default branch, which is
  90why the `.git/HEAD` file was created points to it even if it
  91doesn't yet exist. Basically, the `HEAD` link is supposed to always
  92point to the branch you are working on right now, and you always
  93start out expecting to work on the `master` branch.
  94
  95However, this is only a convention, and you can name your branches
  96anything you want, and don't have to ever even 'have' a `master`
  97branch. A number of the git tools will assume that `.git/HEAD` is
  98valid, though.
  99
 100[NOTE]
 101An 'object' is identified by its 160-bit SHA1 hash, aka 'object name',
 102and a reference to an object is always the 40-byte hex
 103representation of that SHA1 name. The files in the `refs`
 104subdirectory are expected to contain these hex references
 105(usually with a final `\'\n\'` at the end), and you should thus
 106expect to see a number of 41-byte files containing these
 107references in these `refs` subdirectories when you actually start
 108populating your tree.
 109
 110[NOTE]
 111An advanced user may want to take a look at the
 112linkgit:gitrepository-layout[5][repository layout] document
 113after finishing this tutorial.
 114
 115You have now created your first git repository. Of course, since it's
 116empty, that's not very useful, so let's start populating it with data.
 117
 118
 119Populating a git repository
 120---------------------------
 121
 122We'll keep this simple and stupid, so we'll start off with populating a
 123few trivial files just to get a feel for it.
 124
 125Start off with just creating any random files that you want to maintain
 126in your git repository. We'll start off with a few bad examples, just to
 127get a feel for how this works:
 128
 129------------------------------------------------
 130$ echo "Hello World" >hello
 131$ echo "Silly example" >example
 132------------------------------------------------
 133
 134you have now created two files in your working tree (aka 'working directory'),
 135but to actually check in your hard work, you will have to go through two steps:
 136
 137 - fill in the 'index' file (aka 'cache') with the information about your
 138   working tree state.
 139
 140 - commit that index file as an object.
 141
 142The first step is trivial: when you want to tell git about any changes
 143to your working tree, you use the `git-update-index` program. That
 144program normally just takes a list of filenames you want to update, but
 145to avoid trivial mistakes, it refuses to add new entries to the index
 146(or remove existing ones) unless you explicitly tell it that you're
 147adding a new entry with the `\--add` flag (or removing an entry with the
 148`\--remove`) flag.
 149
 150So to populate the index with the two files you just created, you can do
 151
 152------------------------------------------------
 153$ git-update-index --add hello example
 154------------------------------------------------
 155
 156and you have now told git to track those two files.
 157
 158In fact, as you did that, if you now look into your object directory,
 159you'll notice that git will have added two new objects to the object
 160database. If you did exactly the steps above, you should now be able to do
 161
 162
 163----------------
 164$ ls .git/objects/??/*
 165----------------
 166
 167and see two files:
 168
 169----------------
 170.git/objects/55/7db03de997c86a4a028e1ebd3a1ceb225be238
 171.git/objects/f2/4c74a2e500f5ee1332c86b94199f52b1d1d962
 172----------------
 173
 174which correspond with the objects with names of `557db...` and
 175`f24c7...` respectively.
 176
 177If you want to, you can use `git-cat-file` to look at those objects, but
 178you'll have to use the object name, not the filename of the object:
 179
 180----------------
 181$ git-cat-file -t 557db03de997c86a4a028e1ebd3a1ceb225be238
 182----------------
 183
 184where the `-t` tells `git-cat-file` to tell you what the "type" of the
 185object is. git will tell you that you have a "blob" object (i.e., just a
 186regular file), and you can see the contents with
 187
 188----------------
 189$ git-cat-file "blob" 557db03
 190----------------
 191
 192which will print out "Hello World". The object `557db03` is nothing
 193more than the contents of your file `hello`.
 194
 195[NOTE]
 196Don't confuse that object with the file `hello` itself. The
 197object is literally just those specific *contents* of the file, and
 198however much you later change the contents in file `hello`, the object
 199we just looked at will never change. Objects are immutable.
 200
 201[NOTE]
 202The second example demonstrates that you can
 203abbreviate the object name to only the first several
 204hexadecimal digits in most places.
 205
 206Anyway, as we mentioned previously, you normally never actually take a
 207look at the objects themselves, and typing long 40-character hex
 208names is not something you'd normally want to do. The above digression
 209was just to show that `git-update-index` did something magical, and
 210actually saved away the contents of your files into the git object
 211database.
 212
 213Updating the index did something else too: it created a `.git/index`
 214file. This is the index that describes your current working tree, and
 215something you should be very aware of. Again, you normally never worry
 216about the index file itself, but you should be aware of the fact that
 217you have not actually really "checked in" your files into git so far,
 218you've only *told* git about them.
 219
 220However, since git knows about them, you can now start using some of the
 221most basic git commands to manipulate the files or look at their status.
 222
 223In particular, let's not even check in the two files into git yet, we'll
 224start off by adding another line to `hello` first:
 225
 226------------------------------------------------
 227$ echo "It's a new day for git" >>hello
 228------------------------------------------------
 229
 230and you can now, since you told git about the previous state of `hello`, ask
 231git what has changed in the tree compared to your old index, using the
 232`git-diff-files` command:
 233
 234------------
 235$ git-diff-files
 236------------
 237
 238Oops. That wasn't very readable. It just spit out its own internal
 239version of a `diff`, but that internal version really just tells you
 240that it has noticed that "hello" has been modified, and that the old object
 241contents it had have been replaced with something else.
 242
 243To make it readable, we can tell git-diff-files to output the
 244differences as a patch, using the `-p` flag:
 245
 246------------
 247$ git-diff-files -p
 248diff --git a/hello b/hello
 249index 557db03..263414f 100644
 250--- a/hello
 251+++ b/hello
 252@@ -1 +1,2 @@
 253 Hello World
 254+It's a new day for git
 255----
 256
 257i.e. the diff of the change we caused by adding another line to `hello`.
 258
 259In other words, `git-diff-files` always shows us the difference between
 260what is recorded in the index, and what is currently in the working
 261tree. That's very useful.
 262
 263A common shorthand for `git-diff-files -p` is to just write `git
 264diff`, which will do the same thing.
 265
 266------------
 267$ git diff
 268diff --git a/hello b/hello
 269index 557db03..263414f 100644
 270--- a/hello
 271+++ b/hello
 272@@ -1 +1,2 @@
 273 Hello World
 274+It's a new day for git
 275------------
 276
 277
 278Committing git state
 279--------------------
 280
 281Now, we want to go to the next stage in git, which is to take the files
 282that git knows about in the index, and commit them as a real tree. We do
 283that in two phases: creating a 'tree' object, and committing that 'tree'
 284object as a 'commit' object together with an explanation of what the
 285tree was all about, along with information of how we came to that state.
 286
 287Creating a tree object is trivial, and is done with `git-write-tree`.
 288There are no options or other input: git-write-tree will take the
 289current index state, and write an object that describes that whole
 290index. In other words, we're now tying together all the different
 291filenames with their contents (and their permissions), and we're
 292creating the equivalent of a git "directory" object:
 293
 294------------------------------------------------
 295$ git-write-tree
 296------------------------------------------------
 297
 298and this will just output the name of the resulting tree, in this case
 299(if you have done exactly as I've described) it should be
 300
 301----------------
 3028988da15d077d4829fc51d8544c097def6644dbb
 303----------------
 304
 305which is another incomprehensible object name. Again, if you want to,
 306you can use `git-cat-file -t 8988d\...` to see that this time the object
 307is not a "blob" object, but a "tree" object (you can also use
 308`git-cat-file` to actually output the raw object contents, but you'll see
 309mainly a binary mess, so that's less interesting).
 310
 311However -- normally you'd never use `git-write-tree` on its own, because
 312normally you always commit a tree into a commit object using the
 313`git-commit-tree` command. In fact, it's easier to not actually use
 314`git-write-tree` on its own at all, but to just pass its result in as an
 315argument to `git-commit-tree`.
 316
 317`git-commit-tree` normally takes several arguments -- it wants to know
 318what the 'parent' of a commit was, but since this is the first commit
 319ever in this new repository, and it has no parents, we only need to pass in
 320the object name of the tree. However, `git-commit-tree` also wants to get a
 321commit message on its standard input, and it will write out the resulting
 322object name for the commit to its standard output.
 323
 324And this is where we create the `.git/refs/heads/master` file
 325which is pointed at by `HEAD`. This file is supposed to contain
 326the reference to the top-of-tree of the master branch, and since
 327that's exactly what `git-commit-tree` spits out, we can do this
 328all with a sequence of simple shell commands:
 329
 330------------------------------------------------
 331$ tree=$(git-write-tree)
 332$ commit=$(echo 'Initial commit' | git-commit-tree $tree)
 333$ git-update-ref HEAD $commit
 334------------------------------------------------
 335
 336In this case this creates a totally new commit that is not related to
 337anything else. Normally you do this only *once* for a project ever, and
 338all later commits will be parented on top of an earlier commit.
 339
 340Again, normally you'd never actually do this by hand. There is a
 341helpful script called `git commit` that will do all of this for you. So
 342you could have just written `git commit`
 343instead, and it would have done the above magic scripting for you.
 344
 345
 346Making a change
 347---------------
 348
 349Remember how we did the `git-update-index` on file `hello` and then we
 350changed `hello` afterward, and could compare the new state of `hello` with the
 351state we saved in the index file?
 352
 353Further, remember how I said that `git-write-tree` writes the contents
 354of the *index* file to the tree, and thus what we just committed was in
 355fact the *original* contents of the file `hello`, not the new ones. We did
 356that on purpose, to show the difference between the index state, and the
 357state in the working tree, and how they don't have to match, even
 358when we commit things.
 359
 360As before, if we do `git-diff-files -p` in our git-tutorial project,
 361we'll still see the same difference we saw last time: the index file
 362hasn't changed by the act of committing anything. However, now that we
 363have committed something, we can also learn to use a new command:
 364`git-diff-index`.
 365
 366Unlike `git-diff-files`, which showed the difference between the index
 367file and the working tree, `git-diff-index` shows the differences
 368between a committed *tree* and either the index file or the working
 369tree. In other words, `git-diff-index` wants a tree to be diffed
 370against, and before we did the commit, we couldn't do that, because we
 371didn't have anything to diff against.
 372
 373But now we can do
 374
 375----------------
 376$ git-diff-index -p HEAD
 377----------------
 378
 379(where `-p` has the same meaning as it did in `git-diff-files`), and it
 380will show us the same difference, but for a totally different reason.
 381Now we're comparing the working tree not against the index file,
 382but against the tree we just wrote. It just so happens that those two
 383are obviously the same, so we get the same result.
 384
 385Again, because this is a common operation, you can also just shorthand
 386it with
 387
 388----------------
 389$ git diff HEAD
 390----------------
 391
 392which ends up doing the above for you.
 393
 394In other words, `git-diff-index` normally compares a tree against the
 395working tree, but when given the `\--cached` flag, it is told to
 396instead compare against just the index cache contents, and ignore the
 397current working tree state entirely. Since we just wrote the index
 398file to HEAD, doing `git-diff-index \--cached -p HEAD` should thus return
 399an empty set of differences, and that's exactly what it does.
 400
 401[NOTE]
 402================
 403`git-diff-index` really always uses the index for its
 404comparisons, and saying that it compares a tree against the working
 405tree is thus not strictly accurate. In particular, the list of
 406files to compare (the "meta-data") *always* comes from the index file,
 407regardless of whether the `\--cached` flag is used or not. The `\--cached`
 408flag really only determines whether the file *contents* to be compared
 409come from the working tree or not.
 410
 411This is not hard to understand, as soon as you realize that git simply
 412never knows (or cares) about files that it is not told about
 413explicitly. git will never go *looking* for files to compare, it
 414expects you to tell it what the files are, and that's what the index
 415is there for.
 416================
 417
 418However, our next step is to commit the *change* we did, and again, to
 419understand what's going on, keep in mind the difference between "working
 420tree contents", "index file" and "committed tree". We have changes
 421in the working tree that we want to commit, and we always have to
 422work through the index file, so the first thing we need to do is to
 423update the index cache:
 424
 425------------------------------------------------
 426$ git-update-index hello
 427------------------------------------------------
 428
 429(note how we didn't need the `\--add` flag this time, since git knew
 430about the file already).
 431
 432Note what happens to the different `git-diff-\*` versions here. After
 433we've updated `hello` in the index, `git-diff-files -p` now shows no
 434differences, but `git-diff-index -p HEAD` still *does* show that the
 435current state is different from the state we committed. In fact, now
 436`git-diff-index` shows the same difference whether we use the `--cached`
 437flag or not, since now the index is coherent with the working tree.
 438
 439Now, since we've updated `hello` in the index, we can commit the new
 440version. We could do it by writing the tree by hand again, and
 441committing the tree (this time we'd have to use the `-p HEAD` flag to
 442tell commit that the HEAD was the *parent* of the new commit, and that
 443this wasn't an initial commit any more), but you've done that once
 444already, so let's just use the helpful script this time:
 445
 446------------------------------------------------
 447$ git commit
 448------------------------------------------------
 449
 450which starts an editor for you to write the commit message and tells you
 451a bit about what you have done.
 452
 453Write whatever message you want, and all the lines that start with '#'
 454will be pruned out, and the rest will be used as the commit message for
 455the change. If you decide you don't want to commit anything after all at
 456this point (you can continue to edit things and update the index), you
 457can just leave an empty message. Otherwise `git commit` will commit
 458the change for you.
 459
 460You've now made your first real git commit. And if you're interested in
 461looking at what `git commit` really does, feel free to investigate:
 462it's a few very simple shell scripts to generate the helpful (?) commit
 463message headers, and a few one-liners that actually do the
 464commit itself (`git-commit`).
 465
 466
 467Inspecting Changes
 468------------------
 469
 470While creating changes is useful, it's even more useful if you can tell
 471later what changed. The most useful command for this is another of the
 472`diff` family, namely `git-diff-tree`.
 473
 474`git-diff-tree` can be given two arbitrary trees, and it will tell you the
 475differences between them. Perhaps even more commonly, though, you can
 476give it just a single commit object, and it will figure out the parent
 477of that commit itself, and show the difference directly. Thus, to get
 478the same diff that we've already seen several times, we can now do
 479
 480----------------
 481$ git-diff-tree -p HEAD
 482----------------
 483
 484(again, `-p` means to show the difference as a human-readable patch),
 485and it will show what the last commit (in `HEAD`) actually changed.
 486
 487[NOTE]
 488============
 489Here is an ASCII art by Jon Loeliger that illustrates how
 490various diff-\* commands compare things.
 491
 492                      diff-tree
 493                       +----+
 494                       |    |
 495                       |    |
 496                       V    V
 497                    +-----------+
 498                    | Object DB |
 499                    |  Backing  |
 500                    |   Store   |
 501                    +-----------+
 502                      ^    ^
 503                      |    |
 504                      |    |  diff-index --cached
 505                      |    |
 506          diff-index  |    V
 507                      |  +-----------+
 508                      |  |   Index   |
 509                      |  |  "cache"  |
 510                      |  +-----------+
 511                      |    ^
 512                      |    |
 513                      |    |  diff-files
 514                      |    |
 515                      V    V
 516                    +-----------+
 517                    |  Working  |
 518                    | Directory |
 519                    +-----------+
 520============
 521
 522More interestingly, you can also give `git-diff-tree` the `--pretty` flag,
 523which tells it to also show the commit message and author and date of the
 524commit, and you can tell it to show a whole series of diffs.
 525Alternatively, you can tell it to be "silent", and not show the diffs at
 526all, but just show the actual commit message.
 527
 528In fact, together with the `git-rev-list` program (which generates a
 529list of revisions), `git-diff-tree` ends up being a veritable fount of
 530changes. A trivial (but very useful) script called `git-whatchanged` is
 531included with git which does exactly this, and shows a log of recent
 532activities.
 533
 534To see the whole history of our pitiful little git-tutorial project, you
 535can do
 536
 537----------------
 538$ git log
 539----------------
 540
 541which shows just the log messages, or if we want to see the log together
 542with the associated patches use the more complex (and much more
 543powerful)
 544
 545----------------
 546$ git-whatchanged -p
 547----------------
 548
 549and you will see exactly what has changed in the repository over its
 550short history.
 551
 552[NOTE]
 553When using the above two commands, the initial commit will be shown.
 554If this is a problem because it is huge, you can hide it by setting
 555the log.showroot configuration variable to false. Having this, you
 556can still show it for each command just adding the `\--root` option,
 557which is a flag for `git-diff-tree` accepted by both commands.
 558
 559With that, you should now be having some inkling of what git does, and
 560can explore on your own.
 561
 562[NOTE]
 563Most likely, you are not directly using the core
 564git Plumbing commands, but using Porcelain such as `git-add`, `git-rm'
 565and `git-commit'.
 566
 567
 568Tagging a version
 569-----------------
 570
 571In git, there are two kinds of tags, a "light" one, and an "annotated tag".
 572
 573A "light" tag is technically nothing more than a branch, except we put
 574it in the `.git/refs/tags/` subdirectory instead of calling it a `head`.
 575So the simplest form of tag involves nothing more than
 576
 577------------------------------------------------
 578$ git tag my-first-tag
 579------------------------------------------------
 580
 581which just writes the current `HEAD` into the `.git/refs/tags/my-first-tag`
 582file, after which point you can then use this symbolic name for that
 583particular state. You can, for example, do
 584
 585----------------
 586$ git diff my-first-tag
 587----------------
 588
 589to diff your current state against that tag which at this point will
 590obviously be an empty diff, but if you continue to develop and commit
 591stuff, you can use your tag as an "anchor-point" to see what has changed
 592since you tagged it.
 593
 594An "annotated tag" is actually a real git object, and contains not only a
 595pointer to the state you want to tag, but also a small tag name and
 596message, along with optionally a PGP signature that says that yes,
 597you really did
 598that tag. You create these annotated tags with either the `-a` or
 599`-s` flag to `git tag`:
 600
 601----------------
 602$ git tag -s <tagname>
 603----------------
 604
 605which will sign the current `HEAD` (but you can also give it another
 606argument that specifies the thing to tag, i.e., you could have tagged the
 607current `mybranch` point by using `git tag <tagname> mybranch`).
 608
 609You normally only do signed tags for major releases or things
 610like that, while the light-weight tags are useful for any marking you
 611want to do -- any time you decide that you want to remember a certain
 612point, just create a private tag for it, and you have a nice symbolic
 613name for the state at that point.
 614
 615
 616Copying repositories
 617--------------------
 618
 619git repositories are normally totally self-sufficient and relocatable.
 620Unlike CVS, for example, there is no separate notion of
 621"repository" and "working tree". A git repository normally *is* the
 622working tree, with the local git information hidden in the `.git`
 623subdirectory. There is nothing else. What you see is what you got.
 624
 625[NOTE]
 626You can tell git to split the git internal information from
 627the directory that it tracks, but we'll ignore that for now: it's not
 628how normal projects work, and it's really only meant for special uses.
 629So the mental model of "the git information is always tied directly to
 630the working tree that it describes" may not be technically 100%
 631accurate, but it's a good model for all normal use.
 632
 633This has two implications:
 634
 635 - if you grow bored with the tutorial repository you created (or you've
 636   made a mistake and want to start all over), you can just do simple
 637+
 638----------------
 639$ rm -rf git-tutorial
 640----------------
 641+
 642and it will be gone. There's no external repository, and there's no
 643history outside the project you created.
 644
 645 - if you want to move or duplicate a git repository, you can do so. There
 646   is `git clone` command, but if all you want to do is just to
 647   create a copy of your repository (with all the full history that
 648   went along with it), you can do so with a regular
 649   `cp -a git-tutorial new-git-tutorial`.
 650+
 651Note that when you've moved or copied a git repository, your git index
 652file (which caches various information, notably some of the "stat"
 653information for the files involved) will likely need to be refreshed.
 654So after you do a `cp -a` to create a new copy, you'll want to do
 655+
 656----------------
 657$ git-update-index --refresh
 658----------------
 659+
 660in the new repository to make sure that the index file is up-to-date.
 661
 662Note that the second point is true even across machines. You can
 663duplicate a remote git repository with *any* regular copy mechanism, be it
 664`scp`, `rsync` or `wget`.
 665
 666When copying a remote repository, you'll want to at a minimum update the
 667index cache when you do this, and especially with other peoples'
 668repositories you often want to make sure that the index cache is in some
 669known state (you don't know *what* they've done and not yet checked in),
 670so usually you'll precede the `git-update-index` with a
 671
 672----------------
 673$ git-read-tree --reset HEAD
 674$ git-update-index --refresh
 675----------------
 676
 677which will force a total index re-build from the tree pointed to by `HEAD`.
 678It resets the index contents to `HEAD`, and then the `git-update-index`
 679makes sure to match up all index entries with the checked-out files.
 680If the original repository had uncommitted changes in its
 681working tree, `git-update-index --refresh` notices them and
 682tells you they need to be updated.
 683
 684The above can also be written as simply
 685
 686----------------
 687$ git reset
 688----------------
 689
 690and in fact a lot of the common git command combinations can be scripted
 691with the `git xyz` interfaces.  You can learn things by just looking
 692at what the various git scripts do.  For example, `git reset` used to be
 693the above two lines implemented in `git-reset`, but some things like
 694`git status` and `git commit` are slightly more complex scripts around
 695the basic git commands.
 696
 697Many (most?) public remote repositories will not contain any of
 698the checked out files or even an index file, and will *only* contain the
 699actual core git files. Such a repository usually doesn't even have the
 700`.git` subdirectory, but has all the git files directly in the
 701repository.
 702
 703To create your own local live copy of such a "raw" git repository, you'd
 704first create your own subdirectory for the project, and then copy the
 705raw repository contents into the `.git` directory. For example, to
 706create your own copy of the git repository, you'd do the following
 707
 708----------------
 709$ mkdir my-git
 710$ cd my-git
 711$ rsync -rL rsync://rsync.kernel.org/pub/scm/git/git.git/ .git
 712----------------
 713
 714followed by
 715
 716----------------
 717$ git-read-tree HEAD
 718----------------
 719
 720to populate the index. However, now you have populated the index, and
 721you have all the git internal files, but you will notice that you don't
 722actually have any of the working tree files to work on. To get
 723those, you'd check them out with
 724
 725----------------
 726$ git-checkout-index -u -a
 727----------------
 728
 729where the `-u` flag means that you want the checkout to keep the index
 730up-to-date (so that you don't have to refresh it afterward), and the
 731`-a` flag means "check out all files" (if you have a stale copy or an
 732older version of a checked out tree you may also need to add the `-f`
 733flag first, to tell git-checkout-index to *force* overwriting of any old
 734files).
 735
 736Again, this can all be simplified with
 737
 738----------------
 739$ git clone rsync://rsync.kernel.org/pub/scm/git/git.git/ my-git
 740$ cd my-git
 741$ git checkout
 742----------------
 743
 744which will end up doing all of the above for you.
 745
 746You have now successfully copied somebody else's (mine) remote
 747repository, and checked it out.
 748
 749
 750Creating a new branch
 751---------------------
 752
 753Branches in git are really nothing more than pointers into the git
 754object database from within the `.git/refs/` subdirectory, and as we
 755already discussed, the `HEAD` branch is nothing but a symlink to one of
 756these object pointers.
 757
 758You can at any time create a new branch by just picking an arbitrary
 759point in the project history, and just writing the SHA1 name of that
 760object into a file under `.git/refs/heads/`. You can use any filename you
 761want (and indeed, subdirectories), but the convention is that the
 762"normal" branch is called `master`. That's just a convention, though,
 763and nothing enforces it.
 764
 765To show that as an example, let's go back to the git-tutorial repository we
 766used earlier, and create a branch in it. You do that by simply just
 767saying that you want to check out a new branch:
 768
 769------------
 770$ git checkout -b mybranch
 771------------
 772
 773will create a new branch based at the current `HEAD` position, and switch
 774to it.
 775
 776[NOTE]
 777================================================
 778If you make the decision to start your new branch at some
 779other point in the history than the current `HEAD`, you can do so by
 780just telling `git checkout` what the base of the checkout would be.
 781In other words, if you have an earlier tag or branch, you'd just do
 782
 783------------
 784$ git checkout -b mybranch earlier-commit
 785------------
 786
 787and it would create the new branch `mybranch` at the earlier commit,
 788and check out the state at that time.
 789================================================
 790
 791You can always just jump back to your original `master` branch by doing
 792
 793------------
 794$ git checkout master
 795------------
 796
 797(or any other branch-name, for that matter) and if you forget which
 798branch you happen to be on, a simple
 799
 800------------
 801$ cat .git/HEAD
 802------------
 803
 804will tell you where it's pointing.  To get the list of branches
 805you have, you can say
 806
 807------------
 808$ git branch
 809------------
 810
 811which used to be nothing more than a simple script around `ls .git/refs/heads`.
 812There will be an asterisk in front of the branch you are currently on.
 813
 814Sometimes you may wish to create a new branch _without_ actually
 815checking it out and switching to it. If so, just use the command
 816
 817------------
 818$ git branch <branchname> [startingpoint]
 819------------
 820
 821which will simply _create_ the branch, but will not do anything further.
 822You can then later -- once you decide that you want to actually develop
 823on that branch -- switch to that branch with a regular `git checkout`
 824with the branchname as the argument.
 825
 826
 827Merging two branches
 828--------------------
 829
 830One of the ideas of having a branch is that you do some (possibly
 831experimental) work in it, and eventually merge it back to the main
 832branch. So assuming you created the above `mybranch` that started out
 833being the same as the original `master` branch, let's make sure we're in
 834that branch, and do some work there.
 835
 836------------------------------------------------
 837$ git checkout mybranch
 838$ echo "Work, work, work" >>hello
 839$ git commit -m "Some work." -i hello
 840------------------------------------------------
 841
 842Here, we just added another line to `hello`, and we used a shorthand for
 843doing both `git-update-index hello` and `git commit` by just giving the
 844filename directly to `git commit`, with an `-i` flag (it tells
 845git to 'include' that file in addition to what you have done to
 846the index file so far when making the commit).  The `-m` flag is to give the
 847commit log message from the command line.
 848
 849Now, to make it a bit more interesting, let's assume that somebody else
 850does some work in the original branch, and simulate that by going back
 851to the master branch, and editing the same file differently there:
 852
 853------------
 854$ git checkout master
 855------------
 856
 857Here, take a moment to look at the contents of `hello`, and notice how they
 858don't contain the work we just did in `mybranch` -- because that work
 859hasn't happened in the `master` branch at all. Then do
 860
 861------------
 862$ echo "Play, play, play" >>hello
 863$ echo "Lots of fun" >>example
 864$ git commit -m "Some fun." -i hello example
 865------------
 866
 867since the master branch is obviously in a much better mood.
 868
 869Now, you've got two branches, and you decide that you want to merge the
 870work done. Before we do that, let's introduce a cool graphical tool that
 871helps you view what's going on:
 872
 873----------------
 874$ gitk --all
 875----------------
 876
 877will show you graphically both of your branches (that's what the `\--all`
 878means: normally it will just show you your current `HEAD`) and their
 879histories. You can also see exactly how they came to be from a common
 880source.
 881
 882Anyway, let's exit `gitk` (`^Q` or the File menu), and decide that we want
 883to merge the work we did on the `mybranch` branch into the `master`
 884branch (which is currently our `HEAD` too). To do that, there's a nice
 885script called `git merge`, which wants to know which branches you want
 886to resolve and what the merge is all about:
 887
 888------------
 889$ git merge -m "Merge work in mybranch" mybranch
 890------------
 891
 892where the first argument is going to be used as the commit message if
 893the merge can be resolved automatically.
 894
 895Now, in this case we've intentionally created a situation where the
 896merge will need to be fixed up by hand, though, so git will do as much
 897of it as it can automatically (which in this case is just merge the `example`
 898file, which had no differences in the `mybranch` branch), and say:
 899
 900----------------
 901        Auto-merging hello
 902        CONFLICT (content): Merge conflict in hello
 903        Automatic merge failed; fix up by hand
 904----------------
 905
 906It tells you that it did an "Automatic merge", which
 907failed due to conflicts in `hello`.
 908
 909Not to worry. It left the (trivial) conflict in `hello` in the same form you
 910should already be well used to if you've ever used CVS, so let's just
 911open `hello` in our editor (whatever that may be), and fix it up somehow.
 912I'd suggest just making it so that `hello` contains all four lines:
 913
 914------------
 915Hello World
 916It's a new day for git
 917Play, play, play
 918Work, work, work
 919------------
 920
 921and once you're happy with your manual merge, just do a
 922
 923------------
 924$ git commit -i hello
 925------------
 926
 927which will very loudly warn you that you're now committing a merge
 928(which is correct, so never mind), and you can write a small merge
 929message about your adventures in git-merge-land.
 930
 931After you're done, start up `gitk \--all` to see graphically what the
 932history looks like. Notice that `mybranch` still exists, and you can
 933switch to it, and continue to work with it if you want to. The
 934`mybranch` branch will not contain the merge, but next time you merge it
 935from the `master` branch, git will know how you merged it, so you'll not
 936have to do _that_ merge again.
 937
 938Another useful tool, especially if you do not always work in X-Window
 939environment, is `git show-branch`.
 940
 941------------------------------------------------
 942$ git-show-branch --topo-order --more=1 master mybranch
 943* [master] Merge work in mybranch
 944 ! [mybranch] Some work.
 945--
 946-  [master] Merge work in mybranch
 947*+ [mybranch] Some work.
 948*  [master^] Some fun.
 949------------------------------------------------
 950
 951The first two lines indicate that it is showing the two branches
 952and the first line of the commit log message from their
 953top-of-the-tree commits, you are currently on `master` branch
 954(notice the asterisk `\*` character), and the first column for
 955the later output lines is used to show commits contained in the
 956`master` branch, and the second column for the `mybranch`
 957branch. Three commits are shown along with their log messages.
 958All of them have non blank characters in the first column (`*`
 959shows an ordinary commit on the current branch, `-` is a merge commit), which
 960means they are now part of the `master` branch. Only the "Some
 961work" commit has the plus `+` character in the second column,
 962because `mybranch` has not been merged to incorporate these
 963commits from the master branch.  The string inside brackets
 964before the commit log message is a short name you can use to
 965name the commit.  In the above example, 'master' and 'mybranch'
 966are branch heads.  'master^' is the first parent of 'master'
 967branch head.  Please see 'git-rev-parse' documentation if you
 968see more complex cases.
 969
 970[NOTE]
 971Without the '--more=1' option, 'git-show-branch' would not output the
 972'[master^]' commit, as '[mybranch]' commit is a common ancestor of
 973both 'master' and 'mybranch' tips.  Please see 'git-show-branch'
 974documentation for details.
 975
 976[NOTE]
 977If there were more commits on the 'master' branch after the merge, the
 978merge commit itself would not be shown by 'git-show-branch' by
 979default.  You would need to provide '--sparse' option to make the
 980merge commit visible in this case.
 981
 982Now, let's pretend you are the one who did all the work in
 983`mybranch`, and the fruit of your hard work has finally been merged
 984to the `master` branch. Let's go back to `mybranch`, and run
 985`git merge` to get the "upstream changes" back to your branch.
 986
 987------------
 988$ git checkout mybranch
 989$ git merge -m "Merge upstream changes." master
 990------------
 991
 992This outputs something like this (the actual commit object names
 993would be different)
 994
 995----------------
 996Updating from ae3a2da... to a80b4aa....
 997Fast forward
 998 example |    1 +
 999 hello   |    1 +
1000 2 files changed, 2 insertions(+), 0 deletions(-)
1001----------------
1002
1003Because your branch did not contain anything more than what are
1004already merged into the `master` branch, the merge operation did
1005not actually do a merge. Instead, it just updated the top of
1006the tree of your branch to that of the `master` branch. This is
1007often called 'fast forward' merge.
1008
1009You can run `gitk \--all` again to see how the commit ancestry
1010looks like, or run `show-branch`, which tells you this.
1011
1012------------------------------------------------
1013$ git show-branch master mybranch
1014! [master] Merge work in mybranch
1015 * [mybranch] Merge work in mybranch
1016--
1017-- [master] Merge work in mybranch
1018------------------------------------------------
1019
1020
1021Merging external work
1022---------------------
1023
1024It's usually much more common that you merge with somebody else than
1025merging with your own branches, so it's worth pointing out that git
1026makes that very easy too, and in fact, it's not that different from
1027doing a `git merge`. In fact, a remote merge ends up being nothing
1028more than "fetch the work from a remote repository into a temporary tag"
1029followed by a `git merge`.
1030
1031Fetching from a remote repository is done by, unsurprisingly,
1032`git fetch`:
1033
1034----------------
1035$ git fetch <remote-repository>
1036----------------
1037
1038One of the following transports can be used to name the
1039repository to download from:
1040
1041Rsync::
1042        `rsync://remote.machine/path/to/repo.git/`
1043+
1044Rsync transport is usable for both uploading and downloading,
1045but is completely unaware of what git does, and can produce
1046unexpected results when you download from the public repository
1047while the repository owner is uploading into it via `rsync`
1048transport.  Most notably, it could update the files under
1049`refs/` which holds the object name of the topmost commits
1050before uploading the files in `objects/` -- the downloader would
1051obtain head commit object name while that object itself is still
1052not available in the repository.  For this reason, it is
1053considered deprecated.
1054
1055SSH::
1056        `remote.machine:/path/to/repo.git/` or
1057+
1058`ssh://remote.machine/path/to/repo.git/`
1059+
1060This transport can be used for both uploading and downloading,
1061and requires you to have a log-in privilege over `ssh` to the
1062remote machine.  It finds out the set of objects the other side
1063lacks by exchanging the head commits both ends have and
1064transfers (close to) minimum set of objects.  It is by far the
1065most efficient way to exchange git objects between repositories.
1066
1067Local directory::
1068        `/path/to/repo.git/`
1069+
1070This transport is the same as SSH transport but uses `sh` to run
1071both ends on the local machine instead of running other end on
1072the remote machine via `ssh`.
1073
1074git Native::
1075        `git://remote.machine/path/to/repo.git/`
1076+
1077This transport was designed for anonymous downloading.  Like SSH
1078transport, it finds out the set of objects the downstream side
1079lacks and transfers (close to) minimum set of objects.
1080
1081HTTP(S)::
1082        `http://remote.machine/path/to/repo.git/`
1083+
1084Downloader from http and https URL
1085first obtains the topmost commit object name from the remote site
1086by looking at the specified refname under `repo.git/refs/` directory,
1087and then tries to obtain the
1088commit object by downloading from `repo.git/objects/xx/xxx\...`
1089using the object name of that commit object.  Then it reads the
1090commit object to find out its parent commits and the associate
1091tree object; it repeats this process until it gets all the
1092necessary objects.  Because of this behavior, they are
1093sometimes also called 'commit walkers'.
1094+
1095The 'commit walkers' are sometimes also called 'dumb
1096transports', because they do not require any git aware smart
1097server like git Native transport does.  Any stock HTTP server
1098that does not even support directory index would suffice.  But
1099you must prepare your repository with `git-update-server-info`
1100to help dumb transport downloaders.
1101
1102Once you fetch from the remote repository, you `merge` that
1103with your current branch.
1104
1105However -- it's such a common thing to `fetch` and then
1106immediately `merge`, that it's called `git pull`, and you can
1107simply do
1108
1109----------------
1110$ git pull <remote-repository>
1111----------------
1112
1113and optionally give a branch-name for the remote end as a second
1114argument.
1115
1116[NOTE]
1117You could do without using any branches at all, by
1118keeping as many local repositories as you would like to have
1119branches, and merging between them with `git pull`, just like
1120you merge between branches. The advantage of this approach is
1121that it lets you keep a set of files for each `branch` checked
1122out and you may find it easier to switch back and forth if you
1123juggle multiple lines of development simultaneously. Of
1124course, you will pay the price of more disk usage to hold
1125multiple working trees, but disk space is cheap these days.
1126
1127It is likely that you will be pulling from the same remote
1128repository from time to time. As a short hand, you can store
1129the remote repository URL in the local repository's config file
1130like this:
1131
1132------------------------------------------------
1133$ git config remote.linus.url http://www.kernel.org/pub/scm/git/git.git/
1134------------------------------------------------
1135
1136and use the "linus" keyword with `git pull` instead of the full URL.
1137
1138Examples.
1139
1140. `git pull linus`
1141. `git pull linus tag v0.99.1`
1142
1143the above are equivalent to:
1144
1145. `git pull http://www.kernel.org/pub/scm/git/git.git/ HEAD`
1146. `git pull http://www.kernel.org/pub/scm/git/git.git/ tag v0.99.1`
1147
1148
1149How does the merge work?
1150------------------------
1151
1152We said this tutorial shows what plumbing does to help you cope
1153with the porcelain that isn't flushing, but we so far did not
1154talk about how the merge really works.  If you are following
1155this tutorial the first time, I'd suggest to skip to "Publishing
1156your work" section and come back here later.
1157
1158OK, still with me?  To give us an example to look at, let's go
1159back to the earlier repository with "hello" and "example" file,
1160and bring ourselves back to the pre-merge state:
1161
1162------------
1163$ git show-branch --more=2 master mybranch
1164! [master] Merge work in mybranch
1165 * [mybranch] Merge work in mybranch
1166--
1167-- [master] Merge work in mybranch
1168+* [master^2] Some work.
1169+* [master^] Some fun.
1170------------
1171
1172Remember, before running `git merge`, our `master` head was at
1173"Some fun." commit, while our `mybranch` head was at "Some
1174work." commit.
1175
1176------------
1177$ git checkout mybranch
1178$ git reset --hard master^2
1179$ git checkout master
1180$ git reset --hard master^
1181------------
1182
1183After rewinding, the commit structure should look like this:
1184
1185------------
1186$ git show-branch
1187* [master] Some fun.
1188 ! [mybranch] Some work.
1189--
1190 + [mybranch] Some work.
1191*  [master] Some fun.
1192*+ [mybranch^] New day.
1193------------
1194
1195Now we are ready to experiment with the merge by hand.
1196
1197`git merge` command, when merging two branches, uses 3-way merge
1198algorithm.  First, it finds the common ancestor between them.
1199The command it uses is `git-merge-base`:
1200
1201------------
1202$ mb=$(git-merge-base HEAD mybranch)
1203------------
1204
1205The command writes the commit object name of the common ancestor
1206to the standard output, so we captured its output to a variable,
1207because we will be using it in the next step.  By the way, the common
1208ancestor commit is the "New day." commit in this case.  You can
1209tell it by:
1210
1211------------
1212$ git-name-rev $mb
1213my-first-tag
1214------------
1215
1216After finding out a common ancestor commit, the second step is
1217this:
1218
1219------------
1220$ git-read-tree -m -u $mb HEAD mybranch
1221------------
1222
1223This is the same `git-read-tree` command we have already seen,
1224but it takes three trees, unlike previous examples.  This reads
1225the contents of each tree into different 'stage' in the index
1226file (the first tree goes to stage 1, the second to stage 2,
1227etc.).  After reading three trees into three stages, the paths
1228that are the same in all three stages are 'collapsed' into stage
12290.  Also paths that are the same in two of three stages are
1230collapsed into stage 0, taking the SHA1 from either stage 2 or
1231stage 3, whichever is different from stage 1 (i.e. only one side
1232changed from the common ancestor).
1233
1234After 'collapsing' operation, paths that are different in three
1235trees are left in non-zero stages.  At this point, you can
1236inspect the index file with this command:
1237
1238------------
1239$ git-ls-files --stage
1240100644 7f8b141b65fdcee47321e399a2598a235a032422 0       example
1241100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1       hello
1242100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2       hello
1243100644 cc44c73eb783565da5831b4d820c962954019b69 3       hello
1244------------
1245
1246In our example of only two files, we did not have unchanged
1247files so only 'example' resulted in collapsing, but in real-life
1248large projects, only small number of files change in one commit,
1249and this 'collapsing' tends to trivially merge most of the paths
1250fairly quickly, leaving only a handful the real changes in non-zero
1251stages.
1252
1253To look at only non-zero stages, use `\--unmerged` flag:
1254
1255------------
1256$ git-ls-files --unmerged
1257100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1       hello
1258100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2       hello
1259100644 cc44c73eb783565da5831b4d820c962954019b69 3       hello
1260------------
1261
1262The next step of merging is to merge these three versions of the
1263file, using 3-way merge.  This is done by giving
1264`git-merge-one-file` command as one of the arguments to
1265`git-merge-index` command:
1266
1267------------
1268$ git-merge-index git-merge-one-file hello
1269Auto-merging hello.
1270merge: warning: conflicts during merge
1271ERROR: Merge conflict in hello.
1272fatal: merge program failed
1273------------
1274
1275`git-merge-one-file` script is called with parameters to
1276describe those three versions, and is responsible to leave the
1277merge results in the working tree.
1278It is a fairly straightforward shell script, and
1279eventually calls `merge` program from RCS suite to perform a
1280file-level 3-way merge.  In this case, `merge` detects
1281conflicts, and the merge result with conflict marks is left in
1282the working tree..  This can be seen if you run `ls-files
1283--stage` again at this point:
1284
1285------------
1286$ git-ls-files --stage
1287100644 7f8b141b65fdcee47321e399a2598a235a032422 0       example
1288100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1       hello
1289100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2       hello
1290100644 cc44c73eb783565da5831b4d820c962954019b69 3       hello
1291------------
1292
1293This is the state of the index file and the working file after
1294`git merge` returns control back to you, leaving the conflicting
1295merge for you to resolve.  Notice that the path `hello` is still
1296unmerged, and what you see with `git diff` at this point is
1297differences since stage 2 (i.e. your version).
1298
1299
1300Publishing your work
1301--------------------
1302
1303So, we can use somebody else's work from a remote repository, but
1304how can *you* prepare a repository to let other people pull from
1305it?
1306
1307You do your real work in your working tree that has your
1308primary repository hanging under it as its `.git` subdirectory.
1309You *could* make that repository accessible remotely and ask
1310people to pull from it, but in practice that is not the way
1311things are usually done. A recommended way is to have a public
1312repository, make it reachable by other people, and when the
1313changes you made in your primary working tree are in good shape,
1314update the public repository from it. This is often called
1315'pushing'.
1316
1317[NOTE]
1318This public repository could further be mirrored, and that is
1319how git repositories at `kernel.org` are managed.
1320
1321Publishing the changes from your local (private) repository to
1322your remote (public) repository requires a write privilege on
1323the remote machine. You need to have an SSH account there to
1324run a single command, `git-receive-pack`.
1325
1326First, you need to create an empty repository on the remote
1327machine that will house your public repository. This empty
1328repository will be populated and be kept up-to-date by pushing
1329into it later. Obviously, this repository creation needs to be
1330done only once.
1331
1332[NOTE]
1333`git push` uses a pair of programs,
1334`git-send-pack` on your local machine, and `git-receive-pack`
1335on the remote machine. The communication between the two over
1336the network internally uses an SSH connection.
1337
1338Your private repository's git directory is usually `.git`, but
1339your public repository is often named after the project name,
1340i.e. `<project>.git`. Let's create such a public repository for
1341project `my-git`. After logging into the remote machine, create
1342an empty directory:
1343
1344------------
1345$ mkdir my-git.git
1346------------
1347
1348Then, make that directory into a git repository by running
1349`git init`, but this time, since its name is not the usual
1350`.git`, we do things slightly differently:
1351
1352------------
1353$ GIT_DIR=my-git.git git-init
1354------------
1355
1356Make sure this directory is available for others you want your
1357changes to be pulled by via the transport of your choice. Also
1358you need to make sure that you have the `git-receive-pack`
1359program on the `$PATH`.
1360
1361[NOTE]
1362Many installations of sshd do not invoke your shell as the login
1363shell when you directly run programs; what this means is that if
1364your login shell is `bash`, only `.bashrc` is read and not
1365`.bash_profile`. As a workaround, make sure `.bashrc` sets up
1366`$PATH` so that you can run `git-receive-pack` program.
1367
1368[NOTE]
1369If you plan to publish this repository to be accessed over http,
1370you should do `chmod +x my-git.git/hooks/post-update` at this
1371point.  This makes sure that every time you push into this
1372repository, `git-update-server-info` is run.
1373
1374Your "public repository" is now ready to accept your changes.
1375Come back to the machine you have your private repository. From
1376there, run this command:
1377
1378------------
1379$ git push <public-host>:/path/to/my-git.git master
1380------------
1381
1382This synchronizes your public repository to match the named
1383branch head (i.e. `master` in this case) and objects reachable
1384from them in your current repository.
1385
1386As a real example, this is how I update my public git
1387repository. Kernel.org mirror network takes care of the
1388propagation to other publicly visible machines:
1389
1390------------
1391$ git push master.kernel.org:/pub/scm/git/git.git/
1392------------
1393
1394
1395Packing your repository
1396-----------------------
1397
1398Earlier, we saw that one file under `.git/objects/??/` directory
1399is stored for each git object you create. This representation
1400is efficient to create atomically and safely, but
1401not so convenient to transport over the network. Since git objects are
1402immutable once they are created, there is a way to optimize the
1403storage by "packing them together". The command
1404
1405------------
1406$ git repack
1407------------
1408
1409will do it for you. If you followed the tutorial examples, you
1410would have accumulated about 17 objects in `.git/objects/??/`
1411directories by now. `git repack` tells you how many objects it
1412packed, and stores the packed file in `.git/objects/pack`
1413directory.
1414
1415[NOTE]
1416You will see two files, `pack-\*.pack` and `pack-\*.idx`,
1417in `.git/objects/pack` directory. They are closely related to
1418each other, and if you ever copy them by hand to a different
1419repository for whatever reason, you should make sure you copy
1420them together. The former holds all the data from the objects
1421in the pack, and the latter holds the index for random
1422access.
1423
1424If you are paranoid, running `git-verify-pack` command would
1425detect if you have a corrupt pack, but do not worry too much.
1426Our programs are always perfect ;-).
1427
1428Once you have packed objects, you do not need to leave the
1429unpacked objects that are contained in the pack file anymore.
1430
1431------------
1432$ git prune-packed
1433------------
1434
1435would remove them for you.
1436
1437You can try running `find .git/objects -type f` before and after
1438you run `git prune-packed` if you are curious.  Also `git
1439count-objects` would tell you how many unpacked objects are in
1440your repository and how much space they are consuming.
1441
1442[NOTE]
1443`git pull` is slightly cumbersome for HTTP transport, as a
1444packed repository may contain relatively few objects in a
1445relatively large pack. If you expect many HTTP pulls from your
1446public repository you might want to repack & prune often, or
1447never.
1448
1449If you run `git repack` again at this point, it will say
1450"Nothing to pack". Once you continue your development and
1451accumulate the changes, running `git repack` again will create a
1452new pack, that contains objects created since you packed your
1453repository the last time. We recommend that you pack your project
1454soon after the initial import (unless you are starting your
1455project from scratch), and then run `git repack` every once in a
1456while, depending on how active your project is.
1457
1458When a repository is synchronized via `git push` and `git pull`
1459objects packed in the source repository are usually stored
1460unpacked in the destination, unless rsync transport is used.
1461While this allows you to use different packing strategies on
1462both ends, it also means you may need to repack both
1463repositories every once in a while.
1464
1465
1466Working with Others
1467-------------------
1468
1469Although git is a truly distributed system, it is often
1470convenient to organize your project with an informal hierarchy
1471of developers. Linux kernel development is run this way. There
1472is a nice illustration (page 17, "Merges to Mainline") in
1473link:http://www.xenotime.net/linux/mentor/linux-mentoring-2006.pdf[Randy Dunlap's presentation].
1474
1475It should be stressed that this hierarchy is purely *informal*.
1476There is nothing fundamental in git that enforces the "chain of
1477patch flow" this hierarchy implies. You do not have to pull
1478from only one remote repository.
1479
1480A recommended workflow for a "project lead" goes like this:
1481
14821. Prepare your primary repository on your local machine. Your
1483   work is done there.
1484
14852. Prepare a public repository accessible to others.
1486+
1487If other people are pulling from your repository over dumb
1488transport protocols (HTTP), you need to keep this repository
1489'dumb transport friendly'.  After `git init`,
1490`$GIT_DIR/hooks/post-update` copied from the standard templates
1491would contain a call to `git-update-server-info` but the
1492`post-update` hook itself is disabled by default -- enable it
1493with `chmod +x post-update`.  This makes sure `git-update-server-info`
1494keeps the necessary files up-to-date.
1495
14963. Push into the public repository from your primary
1497   repository.
1498
14994. `git repack` the public repository. This establishes a big
1500   pack that contains the initial set of objects as the
1501   baseline, and possibly `git prune` if the transport
1502   used for pulling from your repository supports packed
1503   repositories.
1504
15055. Keep working in your primary repository. Your changes
1506   include modifications of your own, patches you receive via
1507   e-mails, and merges resulting from pulling the "public"
1508   repositories of your "subsystem maintainers".
1509+
1510You can repack this private repository whenever you feel like.
1511
15126. Push your changes to the public repository, and announce it
1513   to the public.
1514
15157. Every once in a while, "git repack" the public repository.
1516   Go back to step 5. and continue working.
1517
1518
1519A recommended work cycle for a "subsystem maintainer" who works
1520on that project and has an own "public repository" goes like this:
1521
15221. Prepare your work repository, by `git clone` the public
1523   repository of the "project lead". The URL used for the
1524   initial cloning is stored in the remote.origin.url
1525   configuration variable.
1526
15272. Prepare a public repository accessible to others, just like
1528   the "project lead" person does.
1529
15303. Copy over the packed files from "project lead" public
1531   repository to your public repository, unless the "project
1532   lead" repository lives on the same machine as yours.  In the
1533   latter case, you can use `objects/info/alternates` file to
1534   point at the repository you are borrowing from.
1535
15364. Push into the public repository from your primary
1537   repository. Run `git repack`, and possibly `git prune` if the
1538   transport used for pulling from your repository supports
1539   packed repositories.
1540
15415. Keep working in your primary repository. Your changes
1542   include modifications of your own, patches you receive via
1543   e-mails, and merges resulting from pulling the "public"
1544   repositories of your "project lead" and possibly your
1545   "sub-subsystem maintainers".
1546+
1547You can repack this private repository whenever you feel
1548like.
1549
15506. Push your changes to your public repository, and ask your
1551   "project lead" and possibly your "sub-subsystem
1552   maintainers" to pull from it.
1553
15547. Every once in a while, `git repack` the public repository.
1555   Go back to step 5. and continue working.
1556
1557
1558A recommended work cycle for an "individual developer" who does
1559not have a "public" repository is somewhat different. It goes
1560like this:
1561
15621. Prepare your work repository, by `git clone` the public
1563   repository of the "project lead" (or a "subsystem
1564   maintainer", if you work on a subsystem). The URL used for
1565   the initial cloning is stored in the remote.origin.url
1566   configuration variable.
1567
15682. Do your work in your repository on 'master' branch.
1569
15703. Run `git fetch origin` from the public repository of your
1571   upstream every once in a while. This does only the first
1572   half of `git pull` but does not merge. The head of the
1573   public repository is stored in `.git/refs/remotes/origin/master`.
1574
15754. Use `git cherry origin` to see which ones of your patches
1576   were accepted, and/or use `git rebase origin` to port your
1577   unmerged changes forward to the updated upstream.
1578
15795. Use `git format-patch origin` to prepare patches for e-mail
1580   submission to your upstream and send it out. Go back to
1581   step 2. and continue.
1582
1583
1584Working with Others, Shared Repository Style
1585--------------------------------------------
1586
1587If you are coming from CVS background, the style of cooperation
1588suggested in the previous section may be new to you. You do not
1589have to worry. git supports "shared public repository" style of
1590cooperation you are probably more familiar with as well.
1591
1592See linkgit:gitcvs-migration[7][git for CVS users] for the details.
1593
1594Bundling your work together
1595---------------------------
1596
1597It is likely that you will be working on more than one thing at
1598a time.  It is easy to manage those more-or-less independent tasks
1599using branches with git.
1600
1601We have already seen how branches work previously,
1602with "fun and work" example using two branches.  The idea is the
1603same if there are more than two branches.  Let's say you started
1604out from "master" head, and have some new code in the "master"
1605branch, and two independent fixes in the "commit-fix" and
1606"diff-fix" branches:
1607
1608------------
1609$ git show-branch
1610! [commit-fix] Fix commit message normalization.
1611 ! [diff-fix] Fix rename detection.
1612  * [master] Release candidate #1
1613---
1614 +  [diff-fix] Fix rename detection.
1615 +  [diff-fix~1] Better common substring algorithm.
1616+   [commit-fix] Fix commit message normalization.
1617  * [master] Release candidate #1
1618++* [diff-fix~2] Pretty-print messages.
1619------------
1620
1621Both fixes are tested well, and at this point, you want to merge
1622in both of them.  You could merge in 'diff-fix' first and then
1623'commit-fix' next, like this:
1624
1625------------
1626$ git merge -m "Merge fix in diff-fix" diff-fix
1627$ git merge -m "Merge fix in commit-fix" commit-fix
1628------------
1629
1630Which would result in:
1631
1632------------
1633$ git show-branch
1634! [commit-fix] Fix commit message normalization.
1635 ! [diff-fix] Fix rename detection.
1636  * [master] Merge fix in commit-fix
1637---
1638  - [master] Merge fix in commit-fix
1639+ * [commit-fix] Fix commit message normalization.
1640  - [master~1] Merge fix in diff-fix
1641 +* [diff-fix] Fix rename detection.
1642 +* [diff-fix~1] Better common substring algorithm.
1643  * [master~2] Release candidate #1
1644++* [master~3] Pretty-print messages.
1645------------
1646
1647However, there is no particular reason to merge in one branch
1648first and the other next, when what you have are a set of truly
1649independent changes (if the order mattered, then they are not
1650independent by definition).  You could instead merge those two
1651branches into the current branch at once.  First let's undo what
1652we just did and start over.  We would want to get the master
1653branch before these two merges by resetting it to 'master~2':
1654
1655------------
1656$ git reset --hard master~2
1657------------
1658
1659You can make sure 'git show-branch' matches the state before
1660those two 'git merge' you just did.  Then, instead of running
1661two 'git merge' commands in a row, you would merge these two
1662branch heads (this is known as 'making an Octopus'):
1663
1664------------
1665$ git merge commit-fix diff-fix
1666$ git show-branch
1667! [commit-fix] Fix commit message normalization.
1668 ! [diff-fix] Fix rename detection.
1669  * [master] Octopus merge of branches 'diff-fix' and 'commit-fix'
1670---
1671  - [master] Octopus merge of branches 'diff-fix' and 'commit-fix'
1672+ * [commit-fix] Fix commit message normalization.
1673 +* [diff-fix] Fix rename detection.
1674 +* [diff-fix~1] Better common substring algorithm.
1675  * [master~1] Release candidate #1
1676++* [master~2] Pretty-print messages.
1677------------
1678
1679Note that you should not do Octopus because you can.  An octopus
1680is a valid thing to do and often makes it easier to view the
1681commit history if you are merging more than two independent
1682changes at the same time.  However, if you have merge conflicts
1683with any of the branches you are merging in and need to hand
1684resolve, that is an indication that the development happened in
1685those branches were not independent after all, and you should
1686merge two at a time, documenting how you resolved the conflicts,
1687and the reason why you preferred changes made in one side over
1688the other.  Otherwise it would make the project history harder
1689to follow, not easier.
1690
1691SEE ALSO
1692--------
1693linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1694linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1695link:user-manual.html[The Git User's Manual]
1696
1697GIT
1698---
1699Part of the linkgit:git[1] suite.