1A git core tutorial for developers 2================================== 3 4Introduction 5------------ 6 7This tutorial explains how to use the "core" git programs to set up and 8work with a git repository. 9 10If you just need to use git as a revision control system you may prefer 11to start with link:tutorial.html[a tutorial introduction to git] or 12link:user-manual.html[the git user manual]. 13 14However, an understanding of these low-level tools can be helpful if 15you want to understand git's internals. 16 17The core git is often called "plumbing", with the prettier user 18interfaces on top of it called "porcelain". You may not want to use the 19plumbing directly very often, but it can be good to know what the 20plumbing does for when the porcelain isn't flushing. 21 22[NOTE] 23Deeper technical details are often marked as Notes, which you can 24skip on your first reading. 25 26 27Creating a git repository 28------------------------- 29 30Creating a new git repository couldn't be easier: all git repositories start 31out empty, and the only thing you need to do is find yourself a 32subdirectory that you want to use as a working tree - either an empty 33one for a totally new project, or an existing working tree that you want 34to import into git. 35 36For our first example, we're going to start a totally new repository from 37scratch, with no pre-existing files, and we'll call it `git-tutorial`. 38To start up, create a subdirectory for it, change into that 39subdirectory, and initialize the git infrastructure with `git-init`: 40 41------------------------------------------------ 42$ mkdir git-tutorial 43$ cd git-tutorial 44$ git-init 45------------------------------------------------ 46 47to which git will reply 48 49---------------- 50Initialized empty Git repository in .git/ 51---------------- 52 53which is just git's way of saying that you haven't been doing anything 54strange, and that it will have created a local `.git` directory setup for 55your new project. You will now have a `.git` directory, and you can 56inspect that with `ls`. For your new empty project, it should show you 57three entries, among other things: 58 59 - a file called `HEAD`, that has `ref: refs/heads/master` in it. 60 This is similar to a symbolic link and points at 61 `refs/heads/master` relative to the `HEAD` file. 62+ 63Don't worry about the fact that the file that the `HEAD` link points to 64doesn't even exist yet -- you haven't created the commit that will 65start your `HEAD` development branch yet. 66 67 - a subdirectory called `objects`, which will contain all the 68 objects of your project. You should never have any real reason to 69 look at the objects directly, but you might want to know that these 70 objects are what contains all the real 'data' in your repository. 71 72 - a subdirectory called `refs`, which contains references to objects. 73 74In particular, the `refs` subdirectory will contain two other 75subdirectories, named `heads` and `tags` respectively. They do 76exactly what their names imply: they contain references to any number 77of different 'heads' of development (aka 'branches'), and to any 78'tags' that you have created to name specific versions in your 79repository. 80 81One note: the special `master` head is the default branch, which is 82why the `.git/HEAD` file was created points to it even if it 83doesn't yet exist. Basically, the `HEAD` link is supposed to always 84point to the branch you are working on right now, and you always 85start out expecting to work on the `master` branch. 86 87However, this is only a convention, and you can name your branches 88anything you want, and don't have to ever even 'have' a `master` 89branch. A number of the git tools will assume that `.git/HEAD` is 90valid, though. 91 92[NOTE] 93An 'object' is identified by its 160-bit SHA1 hash, aka 'object name', 94and a reference to an object is always the 40-byte hex 95representation of that SHA1 name. The files in the `refs` 96subdirectory are expected to contain these hex references 97(usually with a final `\'\n\'` at the end), and you should thus 98expect to see a number of 41-byte files containing these 99references in these `refs` subdirectories when you actually start 100populating your tree. 101 102[NOTE] 103An advanced user may want to take a look at the 104link:repository-layout.html[repository layout] document 105after finishing this tutorial. 106 107You have now created your first git repository. Of course, since it's 108empty, that's not very useful, so let's start populating it with data. 109 110 111Populating a git repository 112--------------------------- 113 114We'll keep this simple and stupid, so we'll start off with populating a 115few trivial files just to get a feel for it. 116 117Start off with just creating any random files that you want to maintain 118in your git repository. We'll start off with a few bad examples, just to 119get a feel for how this works: 120 121------------------------------------------------ 122$ echo "Hello World" >hello 123$ echo "Silly example" >example 124------------------------------------------------ 125 126you have now created two files in your working tree (aka 'working directory'), 127but to actually check in your hard work, you will have to go through two steps: 128 129 - fill in the 'index' file (aka 'cache') with the information about your 130 working tree state. 131 132 - commit that index file as an object. 133 134The first step is trivial: when you want to tell git about any changes 135to your working tree, you use the `git-update-index` program. That 136program normally just takes a list of filenames you want to update, but 137to avoid trivial mistakes, it refuses to add new entries to the index 138(or remove existing ones) unless you explicitly tell it that you're 139adding a new entry with the `\--add` flag (or removing an entry with the 140`\--remove`) flag. 141 142So to populate the index with the two files you just created, you can do 143 144------------------------------------------------ 145$ git-update-index --add hello example 146------------------------------------------------ 147 148and you have now told git to track those two files. 149 150In fact, as you did that, if you now look into your object directory, 151you'll notice that git will have added two new objects to the object 152database. If you did exactly the steps above, you should now be able to do 153 154 155---------------- 156$ ls .git/objects/??/* 157---------------- 158 159and see two files: 160 161---------------- 162.git/objects/55/7db03de997c86a4a028e1ebd3a1ceb225be238 163.git/objects/f2/4c74a2e500f5ee1332c86b94199f52b1d1d962 164---------------- 165 166which correspond with the objects with names of `557db...` and 167`f24c7...` respectively. 168 169If you want to, you can use `git-cat-file` to look at those objects, but 170you'll have to use the object name, not the filename of the object: 171 172---------------- 173$ git-cat-file -t 557db03de997c86a4a028e1ebd3a1ceb225be238 174---------------- 175 176where the `-t` tells `git-cat-file` to tell you what the "type" of the 177object is. git will tell you that you have a "blob" object (i.e., just a 178regular file), and you can see the contents with 179 180---------------- 181$ git-cat-file "blob" 557db03 182---------------- 183 184which will print out "Hello World". The object `557db03` is nothing 185more than the contents of your file `hello`. 186 187[NOTE] 188Don't confuse that object with the file `hello` itself. The 189object is literally just those specific *contents* of the file, and 190however much you later change the contents in file `hello`, the object 191we just looked at will never change. Objects are immutable. 192 193[NOTE] 194The second example demonstrates that you can 195abbreviate the object name to only the first several 196hexadecimal digits in most places. 197 198Anyway, as we mentioned previously, you normally never actually take a 199look at the objects themselves, and typing long 40-character hex 200names is not something you'd normally want to do. The above digression 201was just to show that `git-update-index` did something magical, and 202actually saved away the contents of your files into the git object 203database. 204 205Updating the index did something else too: it created a `.git/index` 206file. This is the index that describes your current working tree, and 207something you should be very aware of. Again, you normally never worry 208about the index file itself, but you should be aware of the fact that 209you have not actually really "checked in" your files into git so far, 210you've only *told* git about them. 211 212However, since git knows about them, you can now start using some of the 213most basic git commands to manipulate the files or look at their status. 214 215In particular, let's not even check in the two files into git yet, we'll 216start off by adding another line to `hello` first: 217 218------------------------------------------------ 219$ echo "It's a new day for git" >>hello 220------------------------------------------------ 221 222and you can now, since you told git about the previous state of `hello`, ask 223git what has changed in the tree compared to your old index, using the 224`git-diff-files` command: 225 226------------ 227$ git-diff-files 228------------ 229 230Oops. That wasn't very readable. It just spit out its own internal 231version of a `diff`, but that internal version really just tells you 232that it has noticed that "hello" has been modified, and that the old object 233contents it had have been replaced with something else. 234 235To make it readable, we can tell git-diff-files to output the 236differences as a patch, using the `-p` flag: 237 238------------ 239$ git-diff-files -p 240diff --git a/hello b/hello 241index 557db03..263414f 100644 242--- a/hello 243+++ b/hello 244@@ -1 +1,2 @@ 245 Hello World 246+It's a new day for git 247---- 248 249i.e. the diff of the change we caused by adding another line to `hello`. 250 251In other words, `git-diff-files` always shows us the difference between 252what is recorded in the index, and what is currently in the working 253tree. That's very useful. 254 255A common shorthand for `git-diff-files -p` is to just write `git 256diff`, which will do the same thing. 257 258------------ 259$ git diff 260diff --git a/hello b/hello 261index 557db03..263414f 100644 262--- a/hello 263+++ b/hello 264@@ -1 +1,2 @@ 265 Hello World 266+It's a new day for git 267------------ 268 269 270Committing git state 271-------------------- 272 273Now, we want to go to the next stage in git, which is to take the files 274that git knows about in the index, and commit them as a real tree. We do 275that in two phases: creating a 'tree' object, and committing that 'tree' 276object as a 'commit' object together with an explanation of what the 277tree was all about, along with information of how we came to that state. 278 279Creating a tree object is trivial, and is done with `git-write-tree`. 280There are no options or other input: git-write-tree will take the 281current index state, and write an object that describes that whole 282index. In other words, we're now tying together all the different 283filenames with their contents (and their permissions), and we're 284creating the equivalent of a git "directory" object: 285 286------------------------------------------------ 287$ git-write-tree 288------------------------------------------------ 289 290and this will just output the name of the resulting tree, in this case 291(if you have done exactly as I've described) it should be 292 293---------------- 2948988da15d077d4829fc51d8544c097def6644dbb 295---------------- 296 297which is another incomprehensible object name. Again, if you want to, 298you can use `git-cat-file -t 8988d\...` to see that this time the object 299is not a "blob" object, but a "tree" object (you can also use 300`git-cat-file` to actually output the raw object contents, but you'll see 301mainly a binary mess, so that's less interesting). 302 303However -- normally you'd never use `git-write-tree` on its own, because 304normally you always commit a tree into a commit object using the 305`git-commit-tree` command. In fact, it's easier to not actually use 306`git-write-tree` on its own at all, but to just pass its result in as an 307argument to `git-commit-tree`. 308 309`git-commit-tree` normally takes several arguments -- it wants to know 310what the 'parent' of a commit was, but since this is the first commit 311ever in this new repository, and it has no parents, we only need to pass in 312the object name of the tree. However, `git-commit-tree` also wants to get a 313commit message on its standard input, and it will write out the resulting 314object name for the commit to its standard output. 315 316And this is where we create the `.git/refs/heads/master` file 317which is pointed at by `HEAD`. This file is supposed to contain 318the reference to the top-of-tree of the master branch, and since 319that's exactly what `git-commit-tree` spits out, we can do this 320all with a sequence of simple shell commands: 321 322------------------------------------------------ 323$ tree=$(git-write-tree) 324$ commit=$(echo 'Initial commit' | git-commit-tree $tree) 325$ git-update-ref HEAD $commit 326------------------------------------------------ 327 328In this case this creates a totally new commit that is not related to 329anything else. Normally you do this only *once* for a project ever, and 330all later commits will be parented on top of an earlier commit. 331 332Again, normally you'd never actually do this by hand. There is a 333helpful script called `git commit` that will do all of this for you. So 334you could have just written `git commit` 335instead, and it would have done the above magic scripting for you. 336 337 338Making a change 339--------------- 340 341Remember how we did the `git-update-index` on file `hello` and then we 342changed `hello` afterward, and could compare the new state of `hello` with the 343state we saved in the index file? 344 345Further, remember how I said that `git-write-tree` writes the contents 346of the *index* file to the tree, and thus what we just committed was in 347fact the *original* contents of the file `hello`, not the new ones. We did 348that on purpose, to show the difference between the index state, and the 349state in the working tree, and how they don't have to match, even 350when we commit things. 351 352As before, if we do `git-diff-files -p` in our git-tutorial project, 353we'll still see the same difference we saw last time: the index file 354hasn't changed by the act of committing anything. However, now that we 355have committed something, we can also learn to use a new command: 356`git-diff-index`. 357 358Unlike `git-diff-files`, which showed the difference between the index 359file and the working tree, `git-diff-index` shows the differences 360between a committed *tree* and either the index file or the working 361tree. In other words, `git-diff-index` wants a tree to be diffed 362against, and before we did the commit, we couldn't do that, because we 363didn't have anything to diff against. 364 365But now we can do 366 367---------------- 368$ git-diff-index -p HEAD 369---------------- 370 371(where `-p` has the same meaning as it did in `git-diff-files`), and it 372will show us the same difference, but for a totally different reason. 373Now we're comparing the working tree not against the index file, 374but against the tree we just wrote. It just so happens that those two 375are obviously the same, so we get the same result. 376 377Again, because this is a common operation, you can also just shorthand 378it with 379 380---------------- 381$ git diff HEAD 382---------------- 383 384which ends up doing the above for you. 385 386In other words, `git-diff-index` normally compares a tree against the 387working tree, but when given the `\--cached` flag, it is told to 388instead compare against just the index cache contents, and ignore the 389current working tree state entirely. Since we just wrote the index 390file to HEAD, doing `git-diff-index \--cached -p HEAD` should thus return 391an empty set of differences, and that's exactly what it does. 392 393[NOTE] 394================ 395`git-diff-index` really always uses the index for its 396comparisons, and saying that it compares a tree against the working 397tree is thus not strictly accurate. In particular, the list of 398files to compare (the "meta-data") *always* comes from the index file, 399regardless of whether the `\--cached` flag is used or not. The `\--cached` 400flag really only determines whether the file *contents* to be compared 401come from the working tree or not. 402 403This is not hard to understand, as soon as you realize that git simply 404never knows (or cares) about files that it is not told about 405explicitly. git will never go *looking* for files to compare, it 406expects you to tell it what the files are, and that's what the index 407is there for. 408================ 409 410However, our next step is to commit the *change* we did, and again, to 411understand what's going on, keep in mind the difference between "working 412tree contents", "index file" and "committed tree". We have changes 413in the working tree that we want to commit, and we always have to 414work through the index file, so the first thing we need to do is to 415update the index cache: 416 417------------------------------------------------ 418$ git-update-index hello 419------------------------------------------------ 420 421(note how we didn't need the `\--add` flag this time, since git knew 422about the file already). 423 424Note what happens to the different `git-diff-\*` versions here. After 425we've updated `hello` in the index, `git-diff-files -p` now shows no 426differences, but `git-diff-index -p HEAD` still *does* show that the 427current state is different from the state we committed. In fact, now 428`git-diff-index` shows the same difference whether we use the `--cached` 429flag or not, since now the index is coherent with the working tree. 430 431Now, since we've updated `hello` in the index, we can commit the new 432version. We could do it by writing the tree by hand again, and 433committing the tree (this time we'd have to use the `-p HEAD` flag to 434tell commit that the HEAD was the *parent* of the new commit, and that 435this wasn't an initial commit any more), but you've done that once 436already, so let's just use the helpful script this time: 437 438------------------------------------------------ 439$ git commit 440------------------------------------------------ 441 442which starts an editor for you to write the commit message and tells you 443a bit about what you have done. 444 445Write whatever message you want, and all the lines that start with '#' 446will be pruned out, and the rest will be used as the commit message for 447the change. If you decide you don't want to commit anything after all at 448this point (you can continue to edit things and update the index), you 449can just leave an empty message. Otherwise `git commit` will commit 450the change for you. 451 452You've now made your first real git commit. And if you're interested in 453looking at what `git commit` really does, feel free to investigate: 454it's a few very simple shell scripts to generate the helpful (?) commit 455message headers, and a few one-liners that actually do the 456commit itself (`git-commit`). 457 458 459Inspecting Changes 460------------------ 461 462While creating changes is useful, it's even more useful if you can tell 463later what changed. The most useful command for this is another of the 464`diff` family, namely `git-diff-tree`. 465 466`git-diff-tree` can be given two arbitrary trees, and it will tell you the 467differences between them. Perhaps even more commonly, though, you can 468give it just a single commit object, and it will figure out the parent 469of that commit itself, and show the difference directly. Thus, to get 470the same diff that we've already seen several times, we can now do 471 472---------------- 473$ git-diff-tree -p HEAD 474---------------- 475 476(again, `-p` means to show the difference as a human-readable patch), 477and it will show what the last commit (in `HEAD`) actually changed. 478 479[NOTE] 480============ 481Here is an ASCII art by Jon Loeliger that illustrates how 482various diff-\* commands compare things. 483 484 diff-tree 485 +----+ 486 | | 487 | | 488 V V 489 +-----------+ 490 | Object DB | 491 | Backing | 492 | Store | 493 +-----------+ 494 ^ ^ 495 | | 496 | | diff-index --cached 497 | | 498 diff-index | V 499 | +-----------+ 500 | | Index | 501 | | "cache" | 502 | +-----------+ 503 | ^ 504 | | 505 | | diff-files 506 | | 507 V V 508 +-----------+ 509 | Working | 510 | Directory | 511 +-----------+ 512============ 513 514More interestingly, you can also give `git-diff-tree` the `--pretty` flag, 515which tells it to also show the commit message and author and date of the 516commit, and you can tell it to show a whole series of diffs. 517Alternatively, you can tell it to be "silent", and not show the diffs at 518all, but just show the actual commit message. 519 520In fact, together with the `git-rev-list` program (which generates a 521list of revisions), `git-diff-tree` ends up being a veritable fount of 522changes. A trivial (but very useful) script called `git-whatchanged` is 523included with git which does exactly this, and shows a log of recent 524activities. 525 526To see the whole history of our pitiful little git-tutorial project, you 527can do 528 529---------------- 530$ git log 531---------------- 532 533which shows just the log messages, or if we want to see the log together 534with the associated patches use the more complex (and much more 535powerful) 536 537---------------- 538$ git-whatchanged -p --root 539---------------- 540 541and you will see exactly what has changed in the repository over its 542short history. 543 544[NOTE] 545The `\--root` flag is a flag to `git-diff-tree` to tell it to 546show the initial aka 'root' commit too. Normally you'd probably not 547want to see the initial import diff, but since the tutorial project 548was started from scratch and is so small, we use it to make the result 549a bit more interesting. 550 551With that, you should now be having some inkling of what git does, and 552can explore on your own. 553 554[NOTE] 555Most likely, you are not directly using the core 556git Plumbing commands, but using Porcelain such as `git-add`, `git-rm' 557and `git-commit'. 558 559 560Tagging a version 561----------------- 562 563In git, there are two kinds of tags, a "light" one, and an "annotated tag". 564 565A "light" tag is technically nothing more than a branch, except we put 566it in the `.git/refs/tags/` subdirectory instead of calling it a `head`. 567So the simplest form of tag involves nothing more than 568 569------------------------------------------------ 570$ git tag my-first-tag 571------------------------------------------------ 572 573which just writes the current `HEAD` into the `.git/refs/tags/my-first-tag` 574file, after which point you can then use this symbolic name for that 575particular state. You can, for example, do 576 577---------------- 578$ git diff my-first-tag 579---------------- 580 581to diff your current state against that tag (which at this point will 582obviously be an empty diff, but if you continue to develop and commit 583stuff, you can use your tag as an "anchor-point" to see what has changed 584since you tagged it. 585 586An "annotated tag" is actually a real git object, and contains not only a 587pointer to the state you want to tag, but also a small tag name and 588message, along with optionally a PGP signature that says that yes, 589you really did 590that tag. You create these annotated tags with either the `-a` or 591`-s` flag to `git tag`: 592 593---------------- 594$ git tag -s <tagname> 595---------------- 596 597which will sign the current `HEAD` (but you can also give it another 598argument that specifies the thing to tag, i.e., you could have tagged the 599current `mybranch` point by using `git tag <tagname> mybranch`). 600 601You normally only do signed tags for major releases or things 602like that, while the light-weight tags are useful for any marking you 603want to do -- any time you decide that you want to remember a certain 604point, just create a private tag for it, and you have a nice symbolic 605name for the state at that point. 606 607 608Copying repositories 609-------------------- 610 611git repositories are normally totally self-sufficient and relocatable. 612Unlike CVS, for example, there is no separate notion of 613"repository" and "working tree". A git repository normally *is* the 614working tree, with the local git information hidden in the `.git` 615subdirectory. There is nothing else. What you see is what you got. 616 617[NOTE] 618You can tell git to split the git internal information from 619the directory that it tracks, but we'll ignore that for now: it's not 620how normal projects work, and it's really only meant for special uses. 621So the mental model of "the git information is always tied directly to 622the working tree that it describes" may not be technically 100% 623accurate, but it's a good model for all normal use. 624 625This has two implications: 626 627 - if you grow bored with the tutorial repository you created (or you've 628 made a mistake and want to start all over), you can just do simple 629+ 630---------------- 631$ rm -rf git-tutorial 632---------------- 633+ 634and it will be gone. There's no external repository, and there's no 635history outside the project you created. 636 637 - if you want to move or duplicate a git repository, you can do so. There 638 is `git clone` command, but if all you want to do is just to 639 create a copy of your repository (with all the full history that 640 went along with it), you can do so with a regular 641 `cp -a git-tutorial new-git-tutorial`. 642+ 643Note that when you've moved or copied a git repository, your git index 644file (which caches various information, notably some of the "stat" 645information for the files involved) will likely need to be refreshed. 646So after you do a `cp -a` to create a new copy, you'll want to do 647+ 648---------------- 649$ git-update-index --refresh 650---------------- 651+ 652in the new repository to make sure that the index file is up-to-date. 653 654Note that the second point is true even across machines. You can 655duplicate a remote git repository with *any* regular copy mechanism, be it 656`scp`, `rsync` or `wget`. 657 658When copying a remote repository, you'll want to at a minimum update the 659index cache when you do this, and especially with other peoples' 660repositories you often want to make sure that the index cache is in some 661known state (you don't know *what* they've done and not yet checked in), 662so usually you'll precede the `git-update-index` with a 663 664---------------- 665$ git-read-tree --reset HEAD 666$ git-update-index --refresh 667---------------- 668 669which will force a total index re-build from the tree pointed to by `HEAD`. 670It resets the index contents to `HEAD`, and then the `git-update-index` 671makes sure to match up all index entries with the checked-out files. 672If the original repository had uncommitted changes in its 673working tree, `git-update-index --refresh` notices them and 674tells you they need to be updated. 675 676The above can also be written as simply 677 678---------------- 679$ git reset 680---------------- 681 682and in fact a lot of the common git command combinations can be scripted 683with the `git xyz` interfaces. You can learn things by just looking 684at what the various git scripts do. For example, `git reset` used to be 685the above two lines implemented in `git-reset`, but some things like 686`git status` and `git commit` are slightly more complex scripts around 687the basic git commands. 688 689Many (most?) public remote repositories will not contain any of 690the checked out files or even an index file, and will *only* contain the 691actual core git files. Such a repository usually doesn't even have the 692`.git` subdirectory, but has all the git files directly in the 693repository. 694 695To create your own local live copy of such a "raw" git repository, you'd 696first create your own subdirectory for the project, and then copy the 697raw repository contents into the `.git` directory. For example, to 698create your own copy of the git repository, you'd do the following 699 700---------------- 701$ mkdir my-git 702$ cd my-git 703$ rsync -rL rsync://rsync.kernel.org/pub/scm/git/git.git/ .git 704---------------- 705 706followed by 707 708---------------- 709$ git-read-tree HEAD 710---------------- 711 712to populate the index. However, now you have populated the index, and 713you have all the git internal files, but you will notice that you don't 714actually have any of the working tree files to work on. To get 715those, you'd check them out with 716 717---------------- 718$ git-checkout-index -u -a 719---------------- 720 721where the `-u` flag means that you want the checkout to keep the index 722up-to-date (so that you don't have to refresh it afterward), and the 723`-a` flag means "check out all files" (if you have a stale copy or an 724older version of a checked out tree you may also need to add the `-f` 725flag first, to tell git-checkout-index to *force* overwriting of any old 726files). 727 728Again, this can all be simplified with 729 730---------------- 731$ git clone rsync://rsync.kernel.org/pub/scm/git/git.git/ my-git 732$ cd my-git 733$ git checkout 734---------------- 735 736which will end up doing all of the above for you. 737 738You have now successfully copied somebody else's (mine) remote 739repository, and checked it out. 740 741 742Creating a new branch 743--------------------- 744 745Branches in git are really nothing more than pointers into the git 746object database from within the `.git/refs/` subdirectory, and as we 747already discussed, the `HEAD` branch is nothing but a symlink to one of 748these object pointers. 749 750You can at any time create a new branch by just picking an arbitrary 751point in the project history, and just writing the SHA1 name of that 752object into a file under `.git/refs/heads/`. You can use any filename you 753want (and indeed, subdirectories), but the convention is that the 754"normal" branch is called `master`. That's just a convention, though, 755and nothing enforces it. 756 757To show that as an example, let's go back to the git-tutorial repository we 758used earlier, and create a branch in it. You do that by simply just 759saying that you want to check out a new branch: 760 761------------ 762$ git checkout -b mybranch 763------------ 764 765will create a new branch based at the current `HEAD` position, and switch 766to it. 767 768[NOTE] 769================================================ 770If you make the decision to start your new branch at some 771other point in the history than the current `HEAD`, you can do so by 772just telling `git checkout` what the base of the checkout would be. 773In other words, if you have an earlier tag or branch, you'd just do 774 775------------ 776$ git checkout -b mybranch earlier-commit 777------------ 778 779and it would create the new branch `mybranch` at the earlier commit, 780and check out the state at that time. 781================================================ 782 783You can always just jump back to your original `master` branch by doing 784 785------------ 786$ git checkout master 787------------ 788 789(or any other branch-name, for that matter) and if you forget which 790branch you happen to be on, a simple 791 792------------ 793$ cat .git/HEAD 794------------ 795 796will tell you where it's pointing. To get the list of branches 797you have, you can say 798 799------------ 800$ git branch 801------------ 802 803which used to be nothing more than a simple script around `ls .git/refs/heads`. 804There will be an asterisk in front of the branch you are currently on. 805 806Sometimes you may wish to create a new branch _without_ actually 807checking it out and switching to it. If so, just use the command 808 809------------ 810$ git branch <branchname> [startingpoint] 811------------ 812 813which will simply _create_ the branch, but will not do anything further. 814You can then later -- once you decide that you want to actually develop 815on that branch -- switch to that branch with a regular `git checkout` 816with the branchname as the argument. 817 818 819Merging two branches 820-------------------- 821 822One of the ideas of having a branch is that you do some (possibly 823experimental) work in it, and eventually merge it back to the main 824branch. So assuming you created the above `mybranch` that started out 825being the same as the original `master` branch, let's make sure we're in 826that branch, and do some work there. 827 828------------------------------------------------ 829$ git checkout mybranch 830$ echo "Work, work, work" >>hello 831$ git commit -m "Some work." -i hello 832------------------------------------------------ 833 834Here, we just added another line to `hello`, and we used a shorthand for 835doing both `git-update-index hello` and `git commit` by just giving the 836filename directly to `git commit`, with an `-i` flag (it tells 837git to 'include' that file in addition to what you have done to 838the index file so far when making the commit). The `-m` flag is to give the 839commit log message from the command line. 840 841Now, to make it a bit more interesting, let's assume that somebody else 842does some work in the original branch, and simulate that by going back 843to the master branch, and editing the same file differently there: 844 845------------ 846$ git checkout master 847------------ 848 849Here, take a moment to look at the contents of `hello`, and notice how they 850don't contain the work we just did in `mybranch` -- because that work 851hasn't happened in the `master` branch at all. Then do 852 853------------ 854$ echo "Play, play, play" >>hello 855$ echo "Lots of fun" >>example 856$ git commit -m "Some fun." -i hello example 857------------ 858 859since the master branch is obviously in a much better mood. 860 861Now, you've got two branches, and you decide that you want to merge the 862work done. Before we do that, let's introduce a cool graphical tool that 863helps you view what's going on: 864 865---------------- 866$ gitk --all 867---------------- 868 869will show you graphically both of your branches (that's what the `\--all` 870means: normally it will just show you your current `HEAD`) and their 871histories. You can also see exactly how they came to be from a common 872source. 873 874Anyway, let's exit `gitk` (`^Q` or the File menu), and decide that we want 875to merge the work we did on the `mybranch` branch into the `master` 876branch (which is currently our `HEAD` too). To do that, there's a nice 877script called `git merge`, which wants to know which branches you want 878to resolve and what the merge is all about: 879 880------------ 881$ git merge -m "Merge work in mybranch" mybranch 882------------ 883 884where the first argument is going to be used as the commit message if 885the merge can be resolved automatically. 886 887Now, in this case we've intentionally created a situation where the 888merge will need to be fixed up by hand, though, so git will do as much 889of it as it can automatically (which in this case is just merge the `example` 890file, which had no differences in the `mybranch` branch), and say: 891 892---------------- 893 Auto-merging hello 894 CONFLICT (content): Merge conflict in hello 895 Automatic merge failed; fix up by hand 896---------------- 897 898It tells you that it did an "Automatic merge", which 899failed due to conflicts in `hello`. 900 901Not to worry. It left the (trivial) conflict in `hello` in the same form you 902should already be well used to if you've ever used CVS, so let's just 903open `hello` in our editor (whatever that may be), and fix it up somehow. 904I'd suggest just making it so that `hello` contains all four lines: 905 906------------ 907Hello World 908It's a new day for git 909Play, play, play 910Work, work, work 911------------ 912 913and once you're happy with your manual merge, just do a 914 915------------ 916$ git commit -i hello 917------------ 918 919which will very loudly warn you that you're now committing a merge 920(which is correct, so never mind), and you can write a small merge 921message about your adventures in git-merge-land. 922 923After you're done, start up `gitk \--all` to see graphically what the 924history looks like. Notice that `mybranch` still exists, and you can 925switch to it, and continue to work with it if you want to. The 926`mybranch` branch will not contain the merge, but next time you merge it 927from the `master` branch, git will know how you merged it, so you'll not 928have to do _that_ merge again. 929 930Another useful tool, especially if you do not always work in X-Window 931environment, is `git show-branch`. 932 933------------------------------------------------ 934$ git-show-branch --topo-order --more=1 master mybranch 935* [master] Merge work in mybranch 936 ! [mybranch] Some work. 937-- 938- [master] Merge work in mybranch 939*+ [mybranch] Some work. 940* [master^] Some fun. 941------------------------------------------------ 942 943The first two lines indicate that it is showing the two branches 944and the first line of the commit log message from their 945top-of-the-tree commits, you are currently on `master` branch 946(notice the asterisk `\*` character), and the first column for 947the later output lines is used to show commits contained in the 948`master` branch, and the second column for the `mybranch` 949branch. Three commits are shown along with their log messages. 950All of them have non blank characters in the first column (`*` 951shows an ordinary commit on the current branch, `-` is a merge commit), which 952means they are now part of the `master` branch. Only the "Some 953work" commit has the plus `+` character in the second column, 954because `mybranch` has not been merged to incorporate these 955commits from the master branch. The string inside brackets 956before the commit log message is a short name you can use to 957name the commit. In the above example, 'master' and 'mybranch' 958are branch heads. 'master^' is the first parent of 'master' 959branch head. Please see 'git-rev-parse' documentation if you 960see more complex cases. 961 962[NOTE] 963Without the '--more=1' option, 'git-show-branch' would not output the 964'[master^]' commit, as '[mybranch]' commit is a common ancestor of 965both 'master' and 'mybranch' tips. Please see 'git-show-branch' 966documentation for details. 967 968[NOTE] 969If there were more commits on the 'master' branch after the merge, the 970merge commit itself would not be shown by 'git-show-branch' by 971default. You would need to provide '--sparse' option to make the 972merge commit visible in this case. 973 974Now, let's pretend you are the one who did all the work in 975`mybranch`, and the fruit of your hard work has finally been merged 976to the `master` branch. Let's go back to `mybranch`, and run 977`git merge` to get the "upstream changes" back to your branch. 978 979------------ 980$ git checkout mybranch 981$ git merge -m "Merge upstream changes." master 982------------ 983 984This outputs something like this (the actual commit object names 985would be different) 986 987---------------- 988Updating from ae3a2da... to a80b4aa.... 989Fast forward 990 example | 1 + 991 hello | 1 + 992 2 files changed, 2 insertions(+), 0 deletions(-) 993---------------- 994 995Because your branch did not contain anything more than what are 996already merged into the `master` branch, the merge operation did 997not actually do a merge. Instead, it just updated the top of 998the tree of your branch to that of the `master` branch. This is 999often called 'fast forward' merge.10001001You can run `gitk \--all` again to see how the commit ancestry1002looks like, or run `show-branch`, which tells you this.10031004------------------------------------------------1005$ git show-branch master mybranch1006! [master] Merge work in mybranch1007 * [mybranch] Merge work in mybranch1008--1009-- [master] Merge work in mybranch1010------------------------------------------------101110121013Merging external work1014---------------------10151016It's usually much more common that you merge with somebody else than1017merging with your own branches, so it's worth pointing out that git1018makes that very easy too, and in fact, it's not that different from1019doing a `git merge`. In fact, a remote merge ends up being nothing1020more than "fetch the work from a remote repository into a temporary tag"1021followed by a `git merge`.10221023Fetching from a remote repository is done by, unsurprisingly,1024`git fetch`:10251026----------------1027$ git fetch <remote-repository>1028----------------10291030One of the following transports can be used to name the1031repository to download from:10321033Rsync::1034 `rsync://remote.machine/path/to/repo.git/`1035+1036Rsync transport is usable for both uploading and downloading,1037but is completely unaware of what git does, and can produce1038unexpected results when you download from the public repository1039while the repository owner is uploading into it via `rsync`1040transport. Most notably, it could update the files under1041`refs/` which holds the object name of the topmost commits1042before uploading the files in `objects/` -- the downloader would1043obtain head commit object name while that object itself is still1044not available in the repository. For this reason, it is1045considered deprecated.10461047SSH::1048 `remote.machine:/path/to/repo.git/` or1049+1050`ssh://remote.machine/path/to/repo.git/`1051+1052This transport can be used for both uploading and downloading,1053and requires you to have a log-in privilege over `ssh` to the1054remote machine. It finds out the set of objects the other side1055lacks by exchanging the head commits both ends have and1056transfers (close to) minimum set of objects. It is by far the1057most efficient way to exchange git objects between repositories.10581059Local directory::1060 `/path/to/repo.git/`1061+1062This transport is the same as SSH transport but uses `sh` to run1063both ends on the local machine instead of running other end on1064the remote machine via `ssh`.10651066git Native::1067 `git://remote.machine/path/to/repo.git/`1068+1069This transport was designed for anonymous downloading. Like SSH1070transport, it finds out the set of objects the downstream side1071lacks and transfers (close to) minimum set of objects.10721073HTTP(S)::1074 `http://remote.machine/path/to/repo.git/`1075+1076Downloader from http and https URL1077first obtains the topmost commit object name from the remote site1078by looking at the specified refname under `repo.git/refs/` directory,1079and then tries to obtain the1080commit object by downloading from `repo.git/objects/xx/xxx\...`1081using the object name of that commit object. Then it reads the1082commit object to find out its parent commits and the associate1083tree object; it repeats this process until it gets all the1084necessary objects. Because of this behavior, they are1085sometimes also called 'commit walkers'.1086+1087The 'commit walkers' are sometimes also called 'dumb1088transports', because they do not require any git aware smart1089server like git Native transport does. Any stock HTTP server1090that does not even support directory index would suffice. But1091you must prepare your repository with `git-update-server-info`1092to help dumb transport downloaders.10931094Once you fetch from the remote repository, you `merge` that1095with your current branch.10961097However -- it's such a common thing to `fetch` and then1098immediately `merge`, that it's called `git pull`, and you can1099simply do11001101----------------1102$ git pull <remote-repository>1103----------------11041105and optionally give a branch-name for the remote end as a second1106argument.11071108[NOTE]1109You could do without using any branches at all, by1110keeping as many local repositories as you would like to have1111branches, and merging between them with `git pull`, just like1112you merge between branches. The advantage of this approach is1113that it lets you keep a set of files for each `branch` checked1114out and you may find it easier to switch back and forth if you1115juggle multiple lines of development simultaneously. Of1116course, you will pay the price of more disk usage to hold1117multiple working trees, but disk space is cheap these days.11181119It is likely that you will be pulling from the same remote1120repository from time to time. As a short hand, you can store1121the remote repository URL in the local repository's config file1122like this:11231124------------------------------------------------1125$ git config remote.linus.url http://www.kernel.org/pub/scm/git/git.git/1126------------------------------------------------11271128and use the "linus" keyword with `git pull` instead of the full URL.11291130Examples.11311132. `git pull linus`1133. `git pull linus tag v0.99.1`11341135the above are equivalent to:11361137. `git pull http://www.kernel.org/pub/scm/git/git.git/ HEAD`1138. `git pull http://www.kernel.org/pub/scm/git/git.git/ tag v0.99.1`113911401141How does the merge work?1142------------------------11431144We said this tutorial shows what plumbing does to help you cope1145with the porcelain that isn't flushing, but we so far did not1146talk about how the merge really works. If you are following1147this tutorial the first time, I'd suggest to skip to "Publishing1148your work" section and come back here later.11491150OK, still with me? To give us an example to look at, let's go1151back to the earlier repository with "hello" and "example" file,1152and bring ourselves back to the pre-merge state:11531154------------1155$ git show-branch --more=2 master mybranch1156! [master] Merge work in mybranch1157 * [mybranch] Merge work in mybranch1158--1159-- [master] Merge work in mybranch1160+* [master^2] Some work.1161+* [master^] Some fun.1162------------11631164Remember, before running `git merge`, our `master` head was at1165"Some fun." commit, while our `mybranch` head was at "Some1166work." commit.11671168------------1169$ git checkout mybranch1170$ git reset --hard master^21171$ git checkout master1172$ git reset --hard master^1173------------11741175After rewinding, the commit structure should look like this:11761177------------1178$ git show-branch1179* [master] Some fun.1180 ! [mybranch] Some work.1181--1182 + [mybranch] Some work.1183* [master] Some fun.1184*+ [mybranch^] New day.1185------------11861187Now we are ready to experiment with the merge by hand.11881189`git merge` command, when merging two branches, uses 3-way merge1190algorithm. First, it finds the common ancestor between them.1191The command it uses is `git-merge-base`:11921193------------1194$ mb=$(git-merge-base HEAD mybranch)1195------------11961197The command writes the commit object name of the common ancestor1198to the standard output, so we captured its output to a variable,1199because we will be using it in the next step. By the way, the common1200ancestor commit is the "New day." commit in this case. You can1201tell it by:12021203------------1204$ git-name-rev $mb1205my-first-tag1206------------12071208After finding out a common ancestor commit, the second step is1209this:12101211------------1212$ git-read-tree -m -u $mb HEAD mybranch1213------------12141215This is the same `git-read-tree` command we have already seen,1216but it takes three trees, unlike previous examples. This reads1217the contents of each tree into different 'stage' in the index1218file (the first tree goes to stage 1, the second to stage 2,1219etc.). After reading three trees into three stages, the paths1220that are the same in all three stages are 'collapsed' into stage12210. Also paths that are the same in two of three stages are1222collapsed into stage 0, taking the SHA1 from either stage 2 or1223stage 3, whichever is different from stage 1 (i.e. only one side1224changed from the common ancestor).12251226After 'collapsing' operation, paths that are different in three1227trees are left in non-zero stages. At this point, you can1228inspect the index file with this command:12291230------------1231$ git-ls-files --stage1232100644 7f8b141b65fdcee47321e399a2598a235a032422 0 example1233100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1 hello1234100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2 hello1235100644 cc44c73eb783565da5831b4d820c962954019b69 3 hello1236------------12371238In our example of only two files, we did not have unchanged1239files so only 'example' resulted in collapsing, but in real-life1240large projects, only small number of files change in one commit,1241and this 'collapsing' tends to trivially merge most of the paths1242fairly quickly, leaving only a handful the real changes in non-zero1243stages.12441245To look at only non-zero stages, use `\--unmerged` flag:12461247------------1248$ git-ls-files --unmerged1249100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1 hello1250100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2 hello1251100644 cc44c73eb783565da5831b4d820c962954019b69 3 hello1252------------12531254The next step of merging is to merge these three versions of the1255file, using 3-way merge. This is done by giving1256`git-merge-one-file` command as one of the arguments to1257`git-merge-index` command:12581259------------1260$ git-merge-index git-merge-one-file hello1261Auto-merging hello.1262merge: warning: conflicts during merge1263ERROR: Merge conflict in hello.1264fatal: merge program failed1265------------12661267`git-merge-one-file` script is called with parameters to1268describe those three versions, and is responsible to leave the1269merge results in the working tree.1270It is a fairly straightforward shell script, and1271eventually calls `merge` program from RCS suite to perform a1272file-level 3-way merge. In this case, `merge` detects1273conflicts, and the merge result with conflict marks is left in1274the working tree.. This can be seen if you run `ls-files1275--stage` again at this point:12761277------------1278$ git-ls-files --stage1279100644 7f8b141b65fdcee47321e399a2598a235a032422 0 example1280100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1 hello1281100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2 hello1282100644 cc44c73eb783565da5831b4d820c962954019b69 3 hello1283------------12841285This is the state of the index file and the working file after1286`git merge` returns control back to you, leaving the conflicting1287merge for you to resolve. Notice that the path `hello` is still1288unmerged, and what you see with `git diff` at this point is1289differences since stage 2 (i.e. your version).129012911292Publishing your work1293--------------------12941295So, we can use somebody else's work from a remote repository, but1296how can *you* prepare a repository to let other people pull from1297it?12981299You do your real work in your working tree that has your1300primary repository hanging under it as its `.git` subdirectory.1301You *could* make that repository accessible remotely and ask1302people to pull from it, but in practice that is not the way1303things are usually done. A recommended way is to have a public1304repository, make it reachable by other people, and when the1305changes you made in your primary working tree are in good shape,1306update the public repository from it. This is often called1307'pushing'.13081309[NOTE]1310This public repository could further be mirrored, and that is1311how git repositories at `kernel.org` are managed.13121313Publishing the changes from your local (private) repository to1314your remote (public) repository requires a write privilege on1315the remote machine. You need to have an SSH account there to1316run a single command, `git-receive-pack`.13171318First, you need to create an empty repository on the remote1319machine that will house your public repository. This empty1320repository will be populated and be kept up-to-date by pushing1321into it later. Obviously, this repository creation needs to be1322done only once.13231324[NOTE]1325`git push` uses a pair of programs,1326`git-send-pack` on your local machine, and `git-receive-pack`1327on the remote machine. The communication between the two over1328the network internally uses an SSH connection.13291330Your private repository's git directory is usually `.git`, but1331your public repository is often named after the project name,1332i.e. `<project>.git`. Let's create such a public repository for1333project `my-git`. After logging into the remote machine, create1334an empty directory:13351336------------1337$ mkdir my-git.git1338------------13391340Then, make that directory into a git repository by running1341`git init`, but this time, since its name is not the usual1342`.git`, we do things slightly differently:13431344------------1345$ GIT_DIR=my-git.git git-init1346------------13471348Make sure this directory is available for others you want your1349changes to be pulled by via the transport of your choice. Also1350you need to make sure that you have the `git-receive-pack`1351program on the `$PATH`.13521353[NOTE]1354Many installations of sshd do not invoke your shell as the login1355shell when you directly run programs; what this means is that if1356your login shell is `bash`, only `.bashrc` is read and not1357`.bash_profile`. As a workaround, make sure `.bashrc` sets up1358`$PATH` so that you can run `git-receive-pack` program.13591360[NOTE]1361If you plan to publish this repository to be accessed over http,1362you should do `chmod +x my-git.git/hooks/post-update` at this1363point. This makes sure that every time you push into this1364repository, `git-update-server-info` is run.13651366Your "public repository" is now ready to accept your changes.1367Come back to the machine you have your private repository. From1368there, run this command:13691370------------1371$ git push <public-host>:/path/to/my-git.git master1372------------13731374This synchronizes your public repository to match the named1375branch head (i.e. `master` in this case) and objects reachable1376from them in your current repository.13771378As a real example, this is how I update my public git1379repository. Kernel.org mirror network takes care of the1380propagation to other publicly visible machines:13811382------------1383$ git push master.kernel.org:/pub/scm/git/git.git/1384------------138513861387Packing your repository1388-----------------------13891390Earlier, we saw that one file under `.git/objects/??/` directory1391is stored for each git object you create. This representation1392is efficient to create atomically and safely, but1393not so convenient to transport over the network. Since git objects are1394immutable once they are created, there is a way to optimize the1395storage by "packing them together". The command13961397------------1398$ git repack1399------------14001401will do it for you. If you followed the tutorial examples, you1402would have accumulated about 17 objects in `.git/objects/??/`1403directories by now. `git repack` tells you how many objects it1404packed, and stores the packed file in `.git/objects/pack`1405directory.14061407[NOTE]1408You will see two files, `pack-\*.pack` and `pack-\*.idx`,1409in `.git/objects/pack` directory. They are closely related to1410each other, and if you ever copy them by hand to a different1411repository for whatever reason, you should make sure you copy1412them together. The former holds all the data from the objects1413in the pack, and the latter holds the index for random1414access.14151416If you are paranoid, running `git-verify-pack` command would1417detect if you have a corrupt pack, but do not worry too much.1418Our programs are always perfect ;-).14191420Once you have packed objects, you do not need to leave the1421unpacked objects that are contained in the pack file anymore.14221423------------1424$ git prune-packed1425------------14261427would remove them for you.14281429You can try running `find .git/objects -type f` before and after1430you run `git prune-packed` if you are curious. Also `git1431count-objects` would tell you how many unpacked objects are in1432your repository and how much space they are consuming.14331434[NOTE]1435`git pull` is slightly cumbersome for HTTP transport, as a1436packed repository may contain relatively few objects in a1437relatively large pack. If you expect many HTTP pulls from your1438public repository you might want to repack & prune often, or1439never.14401441If you run `git repack` again at this point, it will say1442"Nothing to pack". Once you continue your development and1443accumulate the changes, running `git repack` again will create a1444new pack, that contains objects created since you packed your1445repository the last time. We recommend that you pack your project1446soon after the initial import (unless you are starting your1447project from scratch), and then run `git repack` every once in a1448while, depending on how active your project is.14491450When a repository is synchronized via `git push` and `git pull`1451objects packed in the source repository are usually stored1452unpacked in the destination, unless rsync transport is used.1453While this allows you to use different packing strategies on1454both ends, it also means you may need to repack both1455repositories every once in a while.145614571458Working with Others1459-------------------14601461Although git is a truly distributed system, it is often1462convenient to organize your project with an informal hierarchy1463of developers. Linux kernel development is run this way. There1464is a nice illustration (page 17, "Merges to Mainline") in1465link:http://www.xenotime.net/linux/mentor/linux-mentoring-2006.pdf[Randy Dunlap's presentation].14661467It should be stressed that this hierarchy is purely *informal*.1468There is nothing fundamental in git that enforces the "chain of1469patch flow" this hierarchy implies. You do not have to pull1470from only one remote repository.14711472A recommended workflow for a "project lead" goes like this:147314741. Prepare your primary repository on your local machine. Your1475 work is done there.147614772. Prepare a public repository accessible to others.1478+1479If other people are pulling from your repository over dumb1480transport protocols (HTTP), you need to keep this repository1481'dumb transport friendly'. After `git init`,1482`$GIT_DIR/hooks/post-update` copied from the standard templates1483would contain a call to `git-update-server-info` but the1484`post-update` hook itself is disabled by default -- enable it1485with `chmod +x post-update`. This makes sure `git-update-server-info`1486keeps the necessary files up-to-date.148714883. Push into the public repository from your primary1489 repository.149014914. `git repack` the public repository. This establishes a big1492 pack that contains the initial set of objects as the1493 baseline, and possibly `git prune` if the transport1494 used for pulling from your repository supports packed1495 repositories.149614975. Keep working in your primary repository. Your changes1498 include modifications of your own, patches you receive via1499 e-mails, and merges resulting from pulling the "public"1500 repositories of your "subsystem maintainers".1501+1502You can repack this private repository whenever you feel like.150315046. Push your changes to the public repository, and announce it1505 to the public.150615077. Every once in a while, "git repack" the public repository.1508 Go back to step 5. and continue working.150915101511A recommended work cycle for a "subsystem maintainer" who works1512on that project and has an own "public repository" goes like this:151315141. Prepare your work repository, by `git clone` the public1515 repository of the "project lead". The URL used for the1516 initial cloning is stored in the remote.origin.url1517 configuration variable.151815192. Prepare a public repository accessible to others, just like1520 the "project lead" person does.152115223. Copy over the packed files from "project lead" public1523 repository to your public repository, unless the "project1524 lead" repository lives on the same machine as yours. In the1525 latter case, you can use `objects/info/alternates` file to1526 point at the repository you are borrowing from.152715284. Push into the public repository from your primary1529 repository. Run `git repack`, and possibly `git prune` if the1530 transport used for pulling from your repository supports1531 packed repositories.153215335. Keep working in your primary repository. Your changes1534 include modifications of your own, patches you receive via1535 e-mails, and merges resulting from pulling the "public"1536 repositories of your "project lead" and possibly your1537 "sub-subsystem maintainers".1538+1539You can repack this private repository whenever you feel1540like.154115426. Push your changes to your public repository, and ask your1543 "project lead" and possibly your "sub-subsystem1544 maintainers" to pull from it.154515467. Every once in a while, `git repack` the public repository.1547 Go back to step 5. and continue working.154815491550A recommended work cycle for an "individual developer" who does1551not have a "public" repository is somewhat different. It goes1552like this:155315541. Prepare your work repository, by `git clone` the public1555 repository of the "project lead" (or a "subsystem1556 maintainer", if you work on a subsystem). The URL used for1557 the initial cloning is stored in the remote.origin.url1558 configuration variable.155915602. Do your work in your repository on 'master' branch.156115623. Run `git fetch origin` from the public repository of your1563 upstream every once in a while. This does only the first1564 half of `git pull` but does not merge. The head of the1565 public repository is stored in `.git/refs/remotes/origin/master`.156615674. Use `git cherry origin` to see which ones of your patches1568 were accepted, and/or use `git rebase origin` to port your1569 unmerged changes forward to the updated upstream.157015715. Use `git format-patch origin` to prepare patches for e-mail1572 submission to your upstream and send it out. Go back to1573 step 2. and continue.157415751576Working with Others, Shared Repository Style1577--------------------------------------------15781579If you are coming from CVS background, the style of cooperation1580suggested in the previous section may be new to you. You do not1581have to worry. git supports "shared public repository" style of1582cooperation you are probably more familiar with as well.15831584See link:cvs-migration.html[git for CVS users] for the details.15851586Bundling your work together1587---------------------------15881589It is likely that you will be working on more than one thing at1590a time. It is easy to manage those more-or-less independent tasks1591using branches with git.15921593We have already seen how branches work previously,1594with "fun and work" example using two branches. The idea is the1595same if there are more than two branches. Let's say you started1596out from "master" head, and have some new code in the "master"1597branch, and two independent fixes in the "commit-fix" and1598"diff-fix" branches:15991600------------1601$ git show-branch1602! [commit-fix] Fix commit message normalization.1603 ! [diff-fix] Fix rename detection.1604 * [master] Release candidate #11605---1606 + [diff-fix] Fix rename detection.1607 + [diff-fix~1] Better common substring algorithm.1608+ [commit-fix] Fix commit message normalization.1609 * [master] Release candidate #11610++* [diff-fix~2] Pretty-print messages.1611------------16121613Both fixes are tested well, and at this point, you want to merge1614in both of them. You could merge in 'diff-fix' first and then1615'commit-fix' next, like this:16161617------------1618$ git merge -m "Merge fix in diff-fix" diff-fix1619$ git merge -m "Merge fix in commit-fix" commit-fix1620------------16211622Which would result in:16231624------------1625$ git show-branch1626! [commit-fix] Fix commit message normalization.1627 ! [diff-fix] Fix rename detection.1628 * [master] Merge fix in commit-fix1629---1630 - [master] Merge fix in commit-fix1631+ * [commit-fix] Fix commit message normalization.1632 - [master~1] Merge fix in diff-fix1633 +* [diff-fix] Fix rename detection.1634 +* [diff-fix~1] Better common substring algorithm.1635 * [master~2] Release candidate #11636++* [master~3] Pretty-print messages.1637------------16381639However, there is no particular reason to merge in one branch1640first and the other next, when what you have are a set of truly1641independent changes (if the order mattered, then they are not1642independent by definition). You could instead merge those two1643branches into the current branch at once. First let's undo what1644we just did and start over. We would want to get the master1645branch before these two merges by resetting it to 'master~2':16461647------------1648$ git reset --hard master~21649------------16501651You can make sure 'git show-branch' matches the state before1652those two 'git merge' you just did. Then, instead of running1653two 'git merge' commands in a row, you would merge these two1654branch heads (this is known as 'making an Octopus'):16551656------------1657$ git merge commit-fix diff-fix1658$ git show-branch1659! [commit-fix] Fix commit message normalization.1660 ! [diff-fix] Fix rename detection.1661 * [master] Octopus merge of branches 'diff-fix' and 'commit-fix'1662---1663 - [master] Octopus merge of branches 'diff-fix' and 'commit-fix'1664+ * [commit-fix] Fix commit message normalization.1665 +* [diff-fix] Fix rename detection.1666 +* [diff-fix~1] Better common substring algorithm.1667 * [master~1] Release candidate #11668++* [master~2] Pretty-print messages.1669------------16701671Note that you should not do Octopus because you can. An octopus1672is a valid thing to do and often makes it easier to view the1673commit history if you are merging more than two independent1674changes at the same time. However, if you have merge conflicts1675with any of the branches you are merging in and need to hand1676resolve, that is an indication that the development happened in1677those branches were not independent after all, and you should1678merge two at a time, documenting how you resolved the conflicts,1679and the reason why you preferred changes made in one side over1680the other. Otherwise it would make the project history harder1681to follow, not easier.