1A git core tutorial for developers 2================================== 3 4Introduction 5------------ 6 7This is trying to be a short tutorial on setting up and using a git 8repository, mainly because being hands-on and using explicit examples is 9often the best way of explaining what is going on. 10 11In normal life, most people wouldn't use the "core" git programs 12directly, but rather script around them to make them more palatable. 13Understanding the core git stuff may help some people get those scripts 14done, though, and it may also be instructive in helping people 15understand what it is that the higher-level helper scripts are actually 16doing. 17 18The core git is often called "plumbing", with the prettier user 19interfaces on top of it called "porcelain". You may not want to use the 20plumbing directly very often, but it can be good to know what the 21plumbing does for when the porcelain isn't flushing. 22 23The material presented here often goes deep describing how things 24work internally. If you are mostly interested in using git as a 25SCM, you can skip them during your first pass. 26 27[NOTE] 28And those "too deep" descriptions are often marked as Note. 29 30[NOTE] 31If you are already familiar with another version control system, 32like CVS, you may want to take a look at 33link:everyday.html[Everyday GIT in 20 commands or so] first 34before reading this. 35 36 37Creating a git repository 38------------------------- 39 40Creating a new git repository couldn't be easier: all git repositories start 41out empty, and the only thing you need to do is find yourself a 42subdirectory that you want to use as a working tree - either an empty 43one for a totally new project, or an existing working tree that you want 44to import into git. 45 46For our first example, we're going to start a totally new repository from 47scratch, with no pre-existing files, and we'll call it `git-tutorial`. 48To start up, create a subdirectory for it, change into that 49subdirectory, and initialize the git infrastructure with `git-init-db`: 50 51------------------------------------------------ 52$ mkdir git-tutorial 53$ cd git-tutorial 54$ git-init-db 55------------------------------------------------ 56 57to which git will reply 58 59---------------- 60defaulting to local storage area 61---------------- 62 63which is just git's way of saying that you haven't been doing anything 64strange, and that it will have created a local `.git` directory setup for 65your new project. You will now have a `.git` directory, and you can 66inspect that with `ls`. For your new empty project, it should show you 67three entries, among other things: 68 69 - a file called `HEAD`, that has `ref: refs/heads/master` in it. 70 This is similar to a symbolic link and points at 71 `refs/heads/master` relative to the `HEAD` file. 72+ 73Don't worry about the fact that the file that the `HEAD` link points to 74doesn't even exist yet -- you haven't created the commit that will 75start your `HEAD` development branch yet. 76 77 - a subdirectory called `objects`, which will contain all the 78 objects of your project. You should never have any real reason to 79 look at the objects directly, but you might want to know that these 80 objects are what contains all the real 'data' in your repository. 81 82 - a subdirectory called `refs`, which contains references to objects. 83 84In particular, the `refs` subdirectory will contain two other 85subdirectories, named `heads` and `tags` respectively. They do 86exactly what their names imply: they contain references to any number 87of different 'heads' of development (aka 'branches'), and to any 88'tags' that you have created to name specific versions in your 89repository. 90 91One note: the special `master` head is the default branch, which is 92why the `.git/HEAD` file was created points to it even if it 93doesn't yet exist. Basically, the `HEAD` link is supposed to always 94point to the branch you are working on right now, and you always 95start out expecting to work on the `master` branch. 96 97However, this is only a convention, and you can name your branches 98anything you want, and don't have to ever even 'have' a `master` 99branch. A number of the git tools will assume that `.git/HEAD` is 100valid, though. 101 102[NOTE] 103An 'object' is identified by its 160-bit SHA1 hash, aka 'object name', 104and a reference to an object is always the 40-byte hex 105representation of that SHA1 name. The files in the `refs` 106subdirectory are expected to contain these hex references 107(usually with a final `\'\n\'` at the end), and you should thus 108expect to see a number of 41-byte files containing these 109references in these `refs` subdirectories when you actually start 110populating your tree. 111 112[NOTE] 113An advanced user may want to take a look at the 114link:repository-layout.html[repository layout] document 115after finishing this tutorial. 116 117You have now created your first git repository. Of course, since it's 118empty, that's not very useful, so let's start populating it with data. 119 120 121Populating a git repository 122--------------------------- 123 124We'll keep this simple and stupid, so we'll start off with populating a 125few trivial files just to get a feel for it. 126 127Start off with just creating any random files that you want to maintain 128in your git repository. We'll start off with a few bad examples, just to 129get a feel for how this works: 130 131------------------------------------------------ 132$ echo "Hello World" >hello 133$ echo "Silly example" >example 134------------------------------------------------ 135 136you have now created two files in your working tree (aka 'working directory'), 137but to actually check in your hard work, you will have to go through two steps: 138 139 - fill in the 'index' file (aka 'cache') with the information about your 140 working tree state. 141 142 - commit that index file as an object. 143 144The first step is trivial: when you want to tell git about any changes 145to your working tree, you use the `git-update-index` program. That 146program normally just takes a list of filenames you want to update, but 147to avoid trivial mistakes, it refuses to add new entries to the index 148(or remove existing ones) unless you explicitly tell it that you're 149adding a new entry with the `\--add` flag (or removing an entry with the 150`\--remove`) flag. 151 152So to populate the index with the two files you just created, you can do 153 154------------------------------------------------ 155$ git-update-index --add hello example 156------------------------------------------------ 157 158and you have now told git to track those two files. 159 160In fact, as you did that, if you now look into your object directory, 161you'll notice that git will have added two new objects to the object 162database. If you did exactly the steps above, you should now be able to do 163 164 165---------------- 166$ ls .git/objects/??/* 167---------------- 168 169and see two files: 170 171---------------- 172.git/objects/55/7db03de997c86a4a028e1ebd3a1ceb225be238 173.git/objects/f2/4c74a2e500f5ee1332c86b94199f52b1d1d962 174---------------- 175 176which correspond with the objects with names of `557db...` and 177`f24c7...` respectively. 178 179If you want to, you can use `git-cat-file` to look at those objects, but 180you'll have to use the object name, not the filename of the object: 181 182---------------- 183$ git-cat-file -t 557db03de997c86a4a028e1ebd3a1ceb225be238 184---------------- 185 186where the `-t` tells `git-cat-file` to tell you what the "type" of the 187object is. git will tell you that you have a "blob" object (i.e., just a 188regular file), and you can see the contents with 189 190---------------- 191$ git-cat-file "blob" 557db03 192---------------- 193 194which will print out "Hello World". The object `557db03` is nothing 195more than the contents of your file `hello`. 196 197[NOTE] 198Don't confuse that object with the file `hello` itself. The 199object is literally just those specific *contents* of the file, and 200however much you later change the contents in file `hello`, the object 201we just looked at will never change. Objects are immutable. 202 203[NOTE] 204The second example demonstrates that you can 205abbreviate the object name to only the first several 206hexadecimal digits in most places. 207 208Anyway, as we mentioned previously, you normally never actually take a 209look at the objects themselves, and typing long 40-character hex 210names is not something you'd normally want to do. The above digression 211was just to show that `git-update-index` did something magical, and 212actually saved away the contents of your files into the git object 213database. 214 215Updating the index did something else too: it created a `.git/index` 216file. This is the index that describes your current working tree, and 217something you should be very aware of. Again, you normally never worry 218about the index file itself, but you should be aware of the fact that 219you have not actually really "checked in" your files into git so far, 220you've only *told* git about them. 221 222However, since git knows about them, you can now start using some of the 223most basic git commands to manipulate the files or look at their status. 224 225In particular, let's not even check in the two files into git yet, we'll 226start off by adding another line to `hello` first: 227 228------------------------------------------------ 229$ echo "It's a new day for git" >>hello 230------------------------------------------------ 231 232and you can now, since you told git about the previous state of `hello`, ask 233git what has changed in the tree compared to your old index, using the 234`git-diff-files` command: 235 236------------ 237$ git-diff-files 238------------ 239 240Oops. That wasn't very readable. It just spit out its own internal 241version of a `diff`, but that internal version really just tells you 242that it has noticed that "hello" has been modified, and that the old object 243contents it had have been replaced with something else. 244 245To make it readable, we can tell git-diff-files to output the 246differences as a patch, using the `-p` flag: 247 248------------ 249$ git-diff-files -p 250diff --git a/hello b/hello 251index 557db03..263414f 100644 252--- a/hello 253+++ b/hello 254@@ -1 +1,2 @@ 255 Hello World 256+It's a new day for git 257---- 258 259i.e. the diff of the change we caused by adding another line to `hello`. 260 261In other words, `git-diff-files` always shows us the difference between 262what is recorded in the index, and what is currently in the working 263tree. That's very useful. 264 265A common shorthand for `git-diff-files -p` is to just write `git 266diff`, which will do the same thing. 267 268------------ 269$ git diff 270diff --git a/hello b/hello 271index 557db03..263414f 100644 272--- a/hello 273+++ b/hello 274@@ -1 +1,2 @@ 275 Hello World 276+It's a new day for git 277------------ 278 279 280Committing git state 281-------------------- 282 283Now, we want to go to the next stage in git, which is to take the files 284that git knows about in the index, and commit them as a real tree. We do 285that in two phases: creating a 'tree' object, and committing that 'tree' 286object as a 'commit' object together with an explanation of what the 287tree was all about, along with information of how we came to that state. 288 289Creating a tree object is trivial, and is done with `git-write-tree`. 290There are no options or other input: git-write-tree will take the 291current index state, and write an object that describes that whole 292index. In other words, we're now tying together all the different 293filenames with their contents (and their permissions), and we're 294creating the equivalent of a git "directory" object: 295 296------------------------------------------------ 297$ git-write-tree 298------------------------------------------------ 299 300and this will just output the name of the resulting tree, in this case 301(if you have done exactly as I've described) it should be 302 303---------------- 3048988da15d077d4829fc51d8544c097def6644dbb 305---------------- 306 307which is another incomprehensible object name. Again, if you want to, 308you can use `git-cat-file -t 8988d\...` to see that this time the object 309is not a "blob" object, but a "tree" object (you can also use 310`git-cat-file` to actually output the raw object contents, but you'll see 311mainly a binary mess, so that's less interesting). 312 313However -- normally you'd never use `git-write-tree` on its own, because 314normally you always commit a tree into a commit object using the 315`git-commit-tree` command. In fact, it's easier to not actually use 316`git-write-tree` on its own at all, but to just pass its result in as an 317argument to `git-commit-tree`. 318 319`git-commit-tree` normally takes several arguments -- it wants to know 320what the 'parent' of a commit was, but since this is the first commit 321ever in this new repository, and it has no parents, we only need to pass in 322the object name of the tree. However, `git-commit-tree` 323also wants to get a commit message 324on its standard input, and it will write out the resulting object name for the 325commit to its standard output. 326 327And this is where we create the `.git/refs/heads/master` file 328which is pointed at by `HEAD`. This file is supposed to contain 329the reference to the top-of-tree of the master branch, and since 330that's exactly what `git-commit-tree` spits out, we can do this 331all with a sequence of simple shell commands: 332 333------------------------------------------------ 334$ tree=$(git-write-tree) 335$ commit=$(echo 'Initial commit' | git-commit-tree $tree) 336$ git-update-ref HEAD $commit 337------------------------------------------------ 338 339which will say: 340 341---------------- 342Committing initial tree 8988da15d077d4829fc51d8544c097def6644dbb 343---------------- 344 345just to warn you about the fact that it created a totally new commit 346that is not related to anything else. Normally you do this only *once* 347for a project ever, and all later commits will be parented on top of an 348earlier commit, and you'll never see this "Committing initial tree" 349message ever again. 350 351Again, normally you'd never actually do this by hand. There is a 352helpful script called `git commit` that will do all of this for you. So 353you could have just written `git commit` 354instead, and it would have done the above magic scripting for you. 355 356 357Making a change 358--------------- 359 360Remember how we did the `git-update-index` on file `hello` and then we 361changed `hello` afterward, and could compare the new state of `hello` with the 362state we saved in the index file? 363 364Further, remember how I said that `git-write-tree` writes the contents 365of the *index* file to the tree, and thus what we just committed was in 366fact the *original* contents of the file `hello`, not the new ones. We did 367that on purpose, to show the difference between the index state, and the 368state in the working tree, and how they don't have to match, even 369when we commit things. 370 371As before, if we do `git-diff-files -p` in our git-tutorial project, 372we'll still see the same difference we saw last time: the index file 373hasn't changed by the act of committing anything. However, now that we 374have committed something, we can also learn to use a new command: 375`git-diff-index`. 376 377Unlike `git-diff-files`, which showed the difference between the index 378file and the working tree, `git-diff-index` shows the differences 379between a committed *tree* and either the index file or the working 380tree. In other words, `git-diff-index` wants a tree to be diffed 381against, and before we did the commit, we couldn't do that, because we 382didn't have anything to diff against. 383 384But now we can do 385 386---------------- 387$ git-diff-index -p HEAD 388---------------- 389 390(where `-p` has the same meaning as it did in `git-diff-files`), and it 391will show us the same difference, but for a totally different reason. 392Now we're comparing the working tree not against the index file, 393but against the tree we just wrote. It just so happens that those two 394are obviously the same, so we get the same result. 395 396Again, because this is a common operation, you can also just shorthand 397it with 398 399---------------- 400$ git diff HEAD 401---------------- 402 403which ends up doing the above for you. 404 405In other words, `git-diff-index` normally compares a tree against the 406working tree, but when given the `\--cached` flag, it is told to 407instead compare against just the index cache contents, and ignore the 408current working tree state entirely. Since we just wrote the index 409file to HEAD, doing `git-diff-index \--cached -p HEAD` should thus return 410an empty set of differences, and that's exactly what it does. 411 412[NOTE] 413================ 414`git-diff-index` really always uses the index for its 415comparisons, and saying that it compares a tree against the working 416tree is thus not strictly accurate. In particular, the list of 417files to compare (the "meta-data") *always* comes from the index file, 418regardless of whether the `\--cached` flag is used or not. The `\--cached` 419flag really only determines whether the file *contents* to be compared 420come from the working tree or not. 421 422This is not hard to understand, as soon as you realize that git simply 423never knows (or cares) about files that it is not told about 424explicitly. git will never go *looking* for files to compare, it 425expects you to tell it what the files are, and that's what the index 426is there for. 427================ 428 429However, our next step is to commit the *change* we did, and again, to 430understand what's going on, keep in mind the difference between "working 431tree contents", "index file" and "committed tree". We have changes 432in the working tree that we want to commit, and we always have to 433work through the index file, so the first thing we need to do is to 434update the index cache: 435 436------------------------------------------------ 437$ git-update-index hello 438------------------------------------------------ 439 440(note how we didn't need the `\--add` flag this time, since git knew 441about the file already). 442 443Note what happens to the different `git-diff-\*` versions here. After 444we've updated `hello` in the index, `git-diff-files -p` now shows no 445differences, but `git-diff-index -p HEAD` still *does* show that the 446current state is different from the state we committed. In fact, now 447`git-diff-index` shows the same difference whether we use the `--cached` 448flag or not, since now the index is coherent with the working tree. 449 450Now, since we've updated `hello` in the index, we can commit the new 451version. We could do it by writing the tree by hand again, and 452committing the tree (this time we'd have to use the `-p HEAD` flag to 453tell commit that the HEAD was the *parent* of the new commit, and that 454this wasn't an initial commit any more), but you've done that once 455already, so let's just use the helpful script this time: 456 457------------------------------------------------ 458$ git commit 459------------------------------------------------ 460 461which starts an editor for you to write the commit message and tells you 462a bit about what you have done. 463 464Write whatever message you want, and all the lines that start with '#' 465will be pruned out, and the rest will be used as the commit message for 466the change. If you decide you don't want to commit anything after all at 467this point (you can continue to edit things and update the index), you 468can just leave an empty message. Otherwise `git commit` will commit 469the change for you. 470 471You've now made your first real git commit. And if you're interested in 472looking at what `git commit` really does, feel free to investigate: 473it's a few very simple shell scripts to generate the helpful (?) commit 474message headers, and a few one-liners that actually do the 475commit itself (`git-commit`). 476 477 478Inspecting Changes 479------------------ 480 481While creating changes is useful, it's even more useful if you can tell 482later what changed. The most useful command for this is another of the 483`diff` family, namely `git-diff-tree`. 484 485`git-diff-tree` can be given two arbitrary trees, and it will tell you the 486differences between them. Perhaps even more commonly, though, you can 487give it just a single commit object, and it will figure out the parent 488of that commit itself, and show the difference directly. Thus, to get 489the same diff that we've already seen several times, we can now do 490 491---------------- 492$ git-diff-tree -p HEAD 493---------------- 494 495(again, `-p` means to show the difference as a human-readable patch), 496and it will show what the last commit (in `HEAD`) actually changed. 497 498[NOTE] 499============ 500Here is an ASCII art by Jon Loeliger that illustrates how 501various diff-\* commands compare things. 502 503 diff-tree 504 +----+ 505 | | 506 | | 507 V V 508 +-----------+ 509 | Object DB | 510 | Backing | 511 | Store | 512 +-----------+ 513 ^ ^ 514 | | 515 | | diff-index --cached 516 | | 517 diff-index | V 518 | +-----------+ 519 | | Index | 520 | | "cache" | 521 | +-----------+ 522 | ^ 523 | | 524 | | diff-files 525 | | 526 V V 527 +-----------+ 528 | Working | 529 | Directory | 530 +-----------+ 531============ 532 533More interestingly, you can also give `git-diff-tree` the `--pretty` flag, 534which tells it to also show the commit message and author and date of the 535commit, and you can tell it to show a whole series of diffs. 536Alternatively, you can tell it to be "silent", and not show the diffs at 537all, but just show the actual commit message. 538 539In fact, together with the `git-rev-list` program (which generates a 540list of revisions), `git-diff-tree` ends up being a veritable fount of 541changes. A trivial (but very useful) script called `git-whatchanged` is 542included with git which does exactly this, and shows a log of recent 543activities. 544 545To see the whole history of our pitiful little git-tutorial project, you 546can do 547 548---------------- 549$ git log 550---------------- 551 552which shows just the log messages, or if we want to see the log together 553with the associated patches use the more complex (and much more 554powerful) 555 556---------------- 557$ git-whatchanged -p --root 558---------------- 559 560and you will see exactly what has changed in the repository over its 561short history. 562 563[NOTE] 564The `\--root` flag is a flag to `git-diff-tree` to tell it to 565show the initial aka 'root' commit too. Normally you'd probably not 566want to see the initial import diff, but since the tutorial project 567was started from scratch and is so small, we use it to make the result 568a bit more interesting. 569 570With that, you should now be having some inkling of what git does, and 571can explore on your own. 572 573[NOTE] 574Most likely, you are not directly using the core 575git Plumbing commands, but using Porcelain like Cogito on top 576of it. Cogito works a bit differently and you usually do not 577have to run `git-update-index` yourself for changed files (you 578do tell underlying git about additions and removals via 579`cg-add` and `cg-rm` commands). Just before you make a commit 580with `cg-commit`, Cogito figures out which files you modified, 581and runs `git-update-index` on them for you. 582 583 584Tagging a version 585----------------- 586 587In git, there are two kinds of tags, a "light" one, and an "annotated tag". 588 589A "light" tag is technically nothing more than a branch, except we put 590it in the `.git/refs/tags/` subdirectory instead of calling it a `head`. 591So the simplest form of tag involves nothing more than 592 593------------------------------------------------ 594$ git tag my-first-tag 595------------------------------------------------ 596 597which just writes the current `HEAD` into the `.git/refs/tags/my-first-tag` 598file, after which point you can then use this symbolic name for that 599particular state. You can, for example, do 600 601---------------- 602$ git diff my-first-tag 603---------------- 604 605to diff your current state against that tag (which at this point will 606obviously be an empty diff, but if you continue to develop and commit 607stuff, you can use your tag as an "anchor-point" to see what has changed 608since you tagged it. 609 610An "annotated tag" is actually a real git object, and contains not only a 611pointer to the state you want to tag, but also a small tag name and 612message, along with optionally a PGP signature that says that yes, 613you really did 614that tag. You create these annotated tags with either the `-a` or 615`-s` flag to `git tag`: 616 617---------------- 618$ git tag -s <tagname> 619---------------- 620 621which will sign the current `HEAD` (but you can also give it another 622argument that specifies the thing to tag, i.e., you could have tagged the 623current `mybranch` point by using `git tag <tagname> mybranch`). 624 625You normally only do signed tags for major releases or things 626like that, while the light-weight tags are useful for any marking you 627want to do -- any time you decide that you want to remember a certain 628point, just create a private tag for it, and you have a nice symbolic 629name for the state at that point. 630 631 632Copying repositories 633-------------------- 634 635git repositories are normally totally self-sufficient and relocatable 636Unlike CVS, for example, there is no separate notion of 637"repository" and "working tree". A git repository normally *is* the 638working tree, with the local git information hidden in the `.git` 639subdirectory. There is nothing else. What you see is what you got. 640 641[NOTE] 642You can tell git to split the git internal information from 643the directory that it tracks, but we'll ignore that for now: it's not 644how normal projects work, and it's really only meant for special uses. 645So the mental model of "the git information is always tied directly to 646the working tree that it describes" may not be technically 100% 647accurate, but it's a good model for all normal use. 648 649This has two implications: 650 651 - if you grow bored with the tutorial repository you created (or you've 652 made a mistake and want to start all over), you can just do simple 653+ 654---------------- 655$ rm -rf git-tutorial 656---------------- 657+ 658and it will be gone. There's no external repository, and there's no 659history outside the project you created. 660 661 - if you want to move or duplicate a git repository, you can do so. There 662 is `git clone` command, but if all you want to do is just to 663 create a copy of your repository (with all the full history that 664 went along with it), you can do so with a regular 665 `cp -a git-tutorial new-git-tutorial`. 666+ 667Note that when you've moved or copied a git repository, your git index 668file (which caches various information, notably some of the "stat" 669information for the files involved) will likely need to be refreshed. 670So after you do a `cp -a` to create a new copy, you'll want to do 671+ 672---------------- 673$ git-update-index --refresh 674---------------- 675+ 676in the new repository to make sure that the index file is up-to-date. 677 678Note that the second point is true even across machines. You can 679duplicate a remote git repository with *any* regular copy mechanism, be it 680`scp`, `rsync` or `wget`. 681 682When copying a remote repository, you'll want to at a minimum update the 683index cache when you do this, and especially with other peoples' 684repositories you often want to make sure that the index cache is in some 685known state (you don't know *what* they've done and not yet checked in), 686so usually you'll precede the `git-update-index` with a 687 688---------------- 689$ git-read-tree --reset HEAD 690$ git-update-index --refresh 691---------------- 692 693which will force a total index re-build from the tree pointed to by `HEAD`. 694It resets the index contents to `HEAD`, and then the `git-update-index` 695makes sure to match up all index entries with the checked-out files. 696If the original repository had uncommitted changes in its 697working tree, `git-update-index --refresh` notices them and 698tells you they need to be updated. 699 700The above can also be written as simply 701 702---------------- 703$ git reset 704---------------- 705 706and in fact a lot of the common git command combinations can be scripted 707with the `git xyz` interfaces. You can learn things by just looking 708at what the various git scripts do. For example, `git reset` is the 709above two lines implemented in `git-reset`, but some things like 710`git status` and `git commit` are slightly more complex scripts around 711the basic git commands. 712 713Many (most?) public remote repositories will not contain any of 714the checked out files or even an index file, and will *only* contain the 715actual core git files. Such a repository usually doesn't even have the 716`.git` subdirectory, but has all the git files directly in the 717repository. 718 719To create your own local live copy of such a "raw" git repository, you'd 720first create your own subdirectory for the project, and then copy the 721raw repository contents into the `.git` directory. For example, to 722create your own copy of the git repository, you'd do the following 723 724---------------- 725$ mkdir my-git 726$ cd my-git 727$ rsync -rL rsync://rsync.kernel.org/pub/scm/git/git.git/ .git 728---------------- 729 730followed by 731 732---------------- 733$ git-read-tree HEAD 734---------------- 735 736to populate the index. However, now you have populated the index, and 737you have all the git internal files, but you will notice that you don't 738actually have any of the working tree files to work on. To get 739those, you'd check them out with 740 741---------------- 742$ git-checkout-index -u -a 743---------------- 744 745where the `-u` flag means that you want the checkout to keep the index 746up-to-date (so that you don't have to refresh it afterward), and the 747`-a` flag means "check out all files" (if you have a stale copy or an 748older version of a checked out tree you may also need to add the `-f` 749flag first, to tell git-checkout-index to *force* overwriting of any old 750files). 751 752Again, this can all be simplified with 753 754---------------- 755$ git clone rsync://rsync.kernel.org/pub/scm/git/git.git/ my-git 756$ cd my-git 757$ git checkout 758---------------- 759 760which will end up doing all of the above for you. 761 762You have now successfully copied somebody else's (mine) remote 763repository, and checked it out. 764 765 766Creating a new branch 767--------------------- 768 769Branches in git are really nothing more than pointers into the git 770object database from within the `.git/refs/` subdirectory, and as we 771already discussed, the `HEAD` branch is nothing but a symlink to one of 772these object pointers. 773 774You can at any time create a new branch by just picking an arbitrary 775point in the project history, and just writing the SHA1 name of that 776object into a file under `.git/refs/heads/`. You can use any filename you 777want (and indeed, subdirectories), but the convention is that the 778"normal" branch is called `master`. That's just a convention, though, 779and nothing enforces it. 780 781To show that as an example, let's go back to the git-tutorial repository we 782used earlier, and create a branch in it. You do that by simply just 783saying that you want to check out a new branch: 784 785------------ 786$ git checkout -b mybranch 787------------ 788 789will create a new branch based at the current `HEAD` position, and switch 790to it. 791 792[NOTE] 793================================================ 794If you make the decision to start your new branch at some 795other point in the history than the current `HEAD`, you can do so by 796just telling `git checkout` what the base of the checkout would be. 797In other words, if you have an earlier tag or branch, you'd just do 798 799------------ 800$ git checkout -b mybranch earlier-commit 801------------ 802 803and it would create the new branch `mybranch` at the earlier commit, 804and check out the state at that time. 805================================================ 806 807You can always just jump back to your original `master` branch by doing 808 809------------ 810$ git checkout master 811------------ 812 813(or any other branch-name, for that matter) and if you forget which 814branch you happen to be on, a simple 815 816------------ 817$ cat .git/HEAD 818------------ 819 820will tell you where it's pointing. To get the list of branches 821you have, you can say 822 823------------ 824$ git branch 825------------ 826 827which is nothing more than a simple script around `ls .git/refs/heads`. 828There will be asterisk in front of the branch you are currently on. 829 830Sometimes you may wish to create a new branch _without_ actually 831checking it out and switching to it. If so, just use the command 832 833------------ 834$ git branch <branchname> [startingpoint] 835------------ 836 837which will simply _create_ the branch, but will not do anything further. 838You can then later -- once you decide that you want to actually develop 839on that branch -- switch to that branch with a regular `git checkout` 840with the branchname as the argument. 841 842 843Merging two branches 844-------------------- 845 846One of the ideas of having a branch is that you do some (possibly 847experimental) work in it, and eventually merge it back to the main 848branch. So assuming you created the above `mybranch` that started out 849being the same as the original `master` branch, let's make sure we're in 850that branch, and do some work there. 851 852------------------------------------------------ 853$ git checkout mybranch 854$ echo "Work, work, work" >>hello 855$ git commit -m 'Some work.' -i hello 856------------------------------------------------ 857 858Here, we just added another line to `hello`, and we used a shorthand for 859doing both `git-update-index hello` and `git commit` by just giving the 860filename directly to `git commit`, with an `-i` flag (it tells 861git to 'include' that file in addition to what you have done to 862the index file so far when making the commit). The `-m` flag is to give the 863commit log message from the command line. 864 865Now, to make it a bit more interesting, let's assume that somebody else 866does some work in the original branch, and simulate that by going back 867to the master branch, and editing the same file differently there: 868 869------------ 870$ git checkout master 871------------ 872 873Here, take a moment to look at the contents of `hello`, and notice how they 874don't contain the work we just did in `mybranch` -- because that work 875hasn't happened in the `master` branch at all. Then do 876 877------------ 878$ echo "Play, play, play" >>hello 879$ echo "Lots of fun" >>example 880$ git commit -m 'Some fun.' -i hello example 881------------ 882 883since the master branch is obviously in a much better mood. 884 885Now, you've got two branches, and you decide that you want to merge the 886work done. Before we do that, let's introduce a cool graphical tool that 887helps you view what's going on: 888 889---------------- 890$ gitk --all 891---------------- 892 893will show you graphically both of your branches (that's what the `\--all` 894means: normally it will just show you your current `HEAD`) and their 895histories. You can also see exactly how they came to be from a common 896source. 897 898Anyway, let's exit `gitk` (`^Q` or the File menu), and decide that we want 899to merge the work we did on the `mybranch` branch into the `master` 900branch (which is currently our `HEAD` too). To do that, there's a nice 901script called `git merge`, which wants to know which branches you want 902to resolve and what the merge is all about: 903 904------------ 905$ git merge "Merge work in mybranch" HEAD mybranch 906------------ 907 908where the first argument is going to be used as the commit message if 909the merge can be resolved automatically. 910 911Now, in this case we've intentionally created a situation where the 912merge will need to be fixed up by hand, though, so git will do as much 913of it as it can automatically (which in this case is just merge the `example` 914file, which had no differences in the `mybranch` branch), and say: 915 916---------------- 917 Trying really trivial in-index merge... 918 fatal: Merge requires file-level merging 919 Nope. 920 ... 921 Auto-merging hello 922 CONFLICT (content): Merge conflict in hello 923 Automatic merge failed; fix up by hand 924---------------- 925 926which is way too verbose, but it basically tells you that it failed the 927really trivial merge ("Simple merge") and did an "Automatic merge" 928instead, but that too failed due to conflicts in `hello`. 929 930Not to worry. It left the (trivial) conflict in `hello` in the same form you 931should already be well used to if you've ever used CVS, so let's just 932open `hello` in our editor (whatever that may be), and fix it up somehow. 933I'd suggest just making it so that `hello` contains all four lines: 934 935------------ 936Hello World 937It's a new day for git 938Play, play, play 939Work, work, work 940------------ 941 942and once you're happy with your manual merge, just do a 943 944------------ 945$ git commit -i hello 946------------ 947 948which will very loudly warn you that you're now committing a merge 949(which is correct, so never mind), and you can write a small merge 950message about your adventures in git-merge-land. 951 952After you're done, start up `gitk \--all` to see graphically what the 953history looks like. Notice that `mybranch` still exists, and you can 954switch to it, and continue to work with it if you want to. The 955`mybranch` branch will not contain the merge, but next time you merge it 956from the `master` branch, git will know how you merged it, so you'll not 957have to do _that_ merge again. 958 959Another useful tool, especially if you do not always work in X-Window 960environment, is `git show-branch`. 961 962------------------------------------------------ 963$ git show-branch --topo-order master mybranch 964* [master] Merge work in mybranch 965 ! [mybranch] Some work. 966-- 967- [master] Merge work in mybranch 968*+ [mybranch] Some work. 969------------------------------------------------ 970 971The first two lines indicate that it is showing the two branches 972and the first line of the commit log message from their 973top-of-the-tree commits, you are currently on `master` branch 974(notice the asterisk `\*` character), and the first column for 975the later output lines is used to show commits contained in the 976`master` branch, and the second column for the `mybranch` 977branch. Three commits are shown along with their log messages. 978All of them have non blank characters in the first column (`*` 979shows an ordinary commit on the current branch, `.` is a merge commit), which 980means they are now part of the `master` branch. Only the "Some 981work" commit has the plus `+` character in the second column, 982because `mybranch` has not been merged to incorporate these 983commits from the master branch. The string inside brackets 984before the commit log message is a short name you can use to 985name the commit. In the above example, 'master' and 'mybranch' 986are branch heads. 'master~1' is the first parent of 'master' 987branch head. Please see 'git-rev-parse' documentation if you 988see more complex cases. 989 990Now, let's pretend you are the one who did all the work in 991`mybranch`, and the fruit of your hard work has finally been merged 992to the `master` branch. Let's go back to `mybranch`, and run 993resolve to get the "upstream changes" back to your branch. 994 995------------ 996$ git checkout mybranch 997$ git merge "Merge upstream changes." HEAD master 998------------ 9991000This outputs something like this (the actual commit object names1001would be different)10021003----------------1004Updating from ae3a2da... to a80b4aa....1005Fast forward1006 example | 1 +1007 hello | 1 +1008 2 files changed, 2 insertions(+), 0 deletions(-)1009----------------10101011Because your branch did not contain anything more than what are1012already merged into the `master` branch, the resolve operation did1013not actually do a merge. Instead, it just updated the top of1014the tree of your branch to that of the `master` branch. This is1015often called 'fast forward' merge.10161017You can run `gitk \--all` again to see how the commit ancestry1018looks like, or run `show-branch`, which tells you this.10191020------------------------------------------------1021$ git show-branch master mybranch1022! [master] Merge work in mybranch1023 * [mybranch] Merge work in mybranch1024--1025-- [master] Merge work in mybranch1026------------------------------------------------102710281029Merging external work1030---------------------10311032It's usually much more common that you merge with somebody else than1033merging with your own branches, so it's worth pointing out that git1034makes that very easy too, and in fact, it's not that different from1035doing a `git merge`. In fact, a remote merge ends up being nothing1036more than "fetch the work from a remote repository into a temporary tag"1037followed by a `git merge`.10381039Fetching from a remote repository is done by, unsurprisingly,1040`git fetch`:10411042----------------1043$ git fetch <remote-repository>1044----------------10451046One of the following transports can be used to name the1047repository to download from:10481049Rsync::1050 `rsync://remote.machine/path/to/repo.git/`1051+1052Rsync transport is usable for both uploading and downloading,1053but is completely unaware of what git does, and can produce1054unexpected results when you download from the public repository1055while the repository owner is uploading into it via `rsync`1056transport. Most notably, it could update the files under1057`refs/` which holds the object name of the topmost commits1058before uploading the files in `objects/` -- the downloader would1059obtain head commit object name while that object itself is still1060not available in the repository. For this reason, it is1061considered deprecated.10621063SSH::1064 `remote.machine:/path/to/repo.git/` or1065+1066`ssh://remote.machine/path/to/repo.git/`1067+1068This transport can be used for both uploading and downloading,1069and requires you to have a log-in privilege over `ssh` to the1070remote machine. It finds out the set of objects the other side1071lacks by exchanging the head commits both ends have and1072transfers (close to) minimum set of objects. It is by far the1073most efficient way to exchange git objects between repositories.10741075Local directory::1076 `/path/to/repo.git/`1077+1078This transport is the same as SSH transport but uses `sh` to run1079both ends on the local machine instead of running other end on1080the remote machine via `ssh`.10811082git Native::1083 `git://remote.machine/path/to/repo.git/`1084+1085This transport was designed for anonymous downloading. Like SSH1086transport, it finds out the set of objects the downstream side1087lacks and transfers (close to) minimum set of objects.10881089HTTP(S)::1090 `http://remote.machine/path/to/repo.git/`1091+1092Downloader from http and https URL1093first obtains the topmost commit object name from the remote site1094by looking at the specified refname under `repo.git/refs/` directory,1095and then tries to obtain the1096commit object by downloading from `repo.git/objects/xx/xxx\...`1097using the object name of that commit object. Then it reads the1098commit object to find out its parent commits and the associate1099tree object; it repeats this process until it gets all the1100necessary objects. Because of this behavior, they are1101sometimes also called 'commit walkers'.1102+1103The 'commit walkers' are sometimes also called 'dumb1104transports', because they do not require any git aware smart1105server like git Native transport does. Any stock HTTP server1106that does not even support directory index would suffice. But1107you must prepare your repository with `git-update-server-info`1108to help dumb transport downloaders.1109+1110There are (confusingly enough) `git-ssh-fetch` and `git-ssh-upload`1111programs, which are 'commit walkers'; they outlived their1112usefulness when git Native and SSH transports were introduced,1113and not used by `git pull` or `git push` scripts.11141115Once you fetch from the remote repository, you `resolve` that1116with your current branch.11171118However -- it's such a common thing to `fetch` and then1119immediately `resolve`, that it's called `git pull`, and you can1120simply do11211122----------------1123$ git pull <remote-repository>1124----------------11251126and optionally give a branch-name for the remote end as a second1127argument.11281129[NOTE]1130You could do without using any branches at all, by1131keeping as many local repositories as you would like to have1132branches, and merging between them with `git pull`, just like1133you merge between branches. The advantage of this approach is1134that it lets you keep set of files for each `branch` checked1135out and you may find it easier to switch back and forth if you1136juggle multiple lines of development simultaneously. Of1137course, you will pay the price of more disk usage to hold1138multiple working trees, but disk space is cheap these days.11391140[NOTE]1141You could even pull from your own repository by1142giving '.' as <remote-repository> parameter to `git pull`. This1143is useful when you want to merge a local branch (or more, if you1144are making an Octopus) into the current branch.11451146It is likely that you will be pulling from the same remote1147repository from time to time. As a short hand, you can store1148the remote repository URL in a file under .git/remotes/1149directory, like this:11501151------------------------------------------------1152$ mkdir -p .git/remotes/1153$ cat >.git/remotes/linus <<\EOF1154URL: http://www.kernel.org/pub/scm/git/git.git/1155EOF1156------------------------------------------------11571158and use the filename to `git pull` instead of the full URL.1159The URL specified in such file can even be a prefix1160of a full URL, like this:11611162------------------------------------------------1163$ cat >.git/remotes/jgarzik <<\EOF1164URL: http://www.kernel.org/pub/scm/linux/git/jgarzik/1165EOF1166------------------------------------------------116711681169Examples.11701171. `git pull linus`1172. `git pull linus tag v0.99.1`1173. `git pull jgarzik/netdev-2.6.git/ e100`11741175the above are equivalent to:11761177. `git pull http://www.kernel.org/pub/scm/git/git.git/ HEAD`1178. `git pull http://www.kernel.org/pub/scm/git/git.git/ tag v0.99.1`1179. `git pull http://www.kernel.org/pub/.../jgarzik/netdev-2.6.git e100`118011811182How does the merge work?1183------------------------11841185We said this tutorial shows what plumbing does to help you cope1186with the porcelain that isn't flushing, but we so far did not1187talk about how the merge really works. If you are following1188this tutorial the first time, I'd suggest to skip to "Publishing1189your work" section and come back here later.11901191OK, still with me? To give us an example to look at, let's go1192back to the earlier repository with "hello" and "example" file,1193and bring ourselves back to the pre-merge state:11941195------------1196$ git show-branch --more=3 master mybranch1197! [master] Merge work in mybranch1198 * [mybranch] Merge work in mybranch1199--1200-- [master] Merge work in mybranch1201+* [master^2] Some work.1202+* [master^] Some fun.1203------------12041205Remember, before running `git merge`, our `master` head was at1206"Some fun." commit, while our `mybranch` head was at "Some1207work." commit.12081209------------1210$ git checkout mybranch1211$ git reset --hard master^21212$ git checkout master1213$ git reset --hard master^1214------------12151216After rewinding, the commit structure should look like this:12171218------------1219$ git show-branch1220* [master] Some fun.1221 ! [mybranch] Some work.1222--1223 + [mybranch] Some work.1224* [master] Some fun.1225*+ [mybranch^] New day.1226------------12271228Now we are ready to experiment with the merge by hand.12291230`git merge` command, when merging two branches, uses 3-way merge1231algorithm. First, it finds the common ancestor between them.1232The command it uses is `git-merge-base`:12331234------------1235$ mb=$(git-merge-base HEAD mybranch)1236------------12371238The command writes the commit object name of the common ancestor1239to the standard output, so we captured its output to a variable,1240because we will be using it in the next step. BTW, the common1241ancestor commit is the "New day." commit in this case. You can1242tell it by:12431244------------1245$ git-name-rev $mb1246my-first-tag1247------------12481249After finding out a common ancestor commit, the second step is1250this:12511252------------1253$ git-read-tree -m -u $mb HEAD mybranch1254------------12551256This is the same `git-read-tree` command we have already seen,1257but it takes three trees, unlike previous examples. This reads1258the contents of each tree into different 'stage' in the index1259file (the first tree goes to stage 1, the second stage 2,1260etc.). After reading three trees into three stages, the paths1261that are the same in all three stages are 'collapsed' into stage12620. Also paths that are the same in two of three stages are1263collapsed into stage 0, taking the SHA1 from either stage 2 or1264stage 3, whichever is different from stage 1 (i.e. only one side1265changed from the common ancestor).12661267After 'collapsing' operation, paths that are different in three1268trees are left in non-zero stages. At this point, you can1269inspect the index file with this command:12701271------------1272$ git-ls-files --stage1273100644 7f8b141b65fdcee47321e399a2598a235a032422 0 example1274100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1 hello1275100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2 hello1276100644 cc44c73eb783565da5831b4d820c962954019b69 3 hello1277------------12781279In our example of only two files, we did not have unchanged1280files so only 'example' resulted in collapsing, but in real-life1281large projects, only small number of files change in one commit,1282and this 'collapsing' tends to trivially merge most of the paths1283fairly quickly, leaving only a handful the real changes in non-zero1284stages.12851286To look at only non-zero stages, use `\--unmerged` flag:12871288------------1289$ git-ls-files --unmerged1290100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1 hello1291100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2 hello1292100644 cc44c73eb783565da5831b4d820c962954019b69 3 hello1293------------12941295The next step of merging is to merge these three versions of the1296file, using 3-way merge. This is done by giving1297`git-merge-one-file` command as one of the arguments to1298`git-merge-index` command:12991300------------1301$ git-merge-index git-merge-one-file hello1302Auto-merging hello.1303merge: warning: conflicts during merge1304ERROR: Merge conflict in hello.1305fatal: merge program failed1306------------13071308`git-merge-one-file` script is called with parameters to1309describe those three versions, and is responsible to leave the1310merge results in the working tree.1311It is a fairly straightforward shell script, and1312eventually calls `merge` program from RCS suite to perform a1313file-level 3-way merge. In this case, `merge` detects1314conflicts, and the merge result with conflict marks is left in1315the working tree.. This can be seen if you run `ls-files1316--stage` again at this point:13171318------------1319$ git-ls-files --stage1320100644 7f8b141b65fdcee47321e399a2598a235a032422 0 example1321100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1 hello1322100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2 hello1323100644 cc44c73eb783565da5831b4d820c962954019b69 3 hello1324------------13251326This is the state of the index file and the working file after1327`git merge` returns control back to you, leaving the conflicting1328merge for you to resolve. Notice that the path `hello` is still1329unmerged, and what you see with `git diff` at this point is1330differences since stage 2 (i.e. your version).133113321333Publishing your work1334--------------------13351336So we can use somebody else's work from a remote repository; but1337how can *you* prepare a repository to let other people pull from1338it?13391340Your do your real work in your working tree that has your1341primary repository hanging under it as its `.git` subdirectory.1342You *could* make that repository accessible remotely and ask1343people to pull from it, but in practice that is not the way1344things are usually done. A recommended way is to have a public1345repository, make it reachable by other people, and when the1346changes you made in your primary working tree are in good shape,1347update the public repository from it. This is often called1348'pushing'.13491350[NOTE]1351This public repository could further be mirrored, and that is1352how git repositories at `kernel.org` are managed.13531354Publishing the changes from your local (private) repository to1355your remote (public) repository requires a write privilege on1356the remote machine. You need to have an SSH account there to1357run a single command, `git-receive-pack`.13581359First, you need to create an empty repository on the remote1360machine that will house your public repository. This empty1361repository will be populated and be kept up-to-date by pushing1362into it later. Obviously, this repository creation needs to be1363done only once.13641365[NOTE]1366`git push` uses a pair of programs,1367`git-send-pack` on your local machine, and `git-receive-pack`1368on the remote machine. The communication between the two over1369the network internally uses an SSH connection.13701371Your private repository's git directory is usually `.git`, but1372your public repository is often named after the project name,1373i.e. `<project>.git`. Let's create such a public repository for1374project `my-git`. After logging into the remote machine, create1375an empty directory:13761377------------1378$ mkdir my-git.git1379------------13801381Then, make that directory into a git repository by running1382`git init-db`, but this time, since its name is not the usual1383`.git`, we do things slightly differently:13841385------------1386$ GIT_DIR=my-git.git git-init-db1387------------13881389Make sure this directory is available for others you want your1390changes to be pulled by via the transport of your choice. Also1391you need to make sure that you have the `git-receive-pack`1392program on the `$PATH`.13931394[NOTE]1395Many installations of sshd do not invoke your shell as the login1396shell when you directly run programs; what this means is that if1397your login shell is `bash`, only `.bashrc` is read and not1398`.bash_profile`. As a workaround, make sure `.bashrc` sets up1399`$PATH` so that you can run `git-receive-pack` program.14001401[NOTE]1402If you plan to publish this repository to be accessed over http,1403you should do `chmod +x my-git.git/hooks/post-update` at this1404point. This makes sure that every time you push into this1405repository, `git-update-server-info` is run.14061407Your "public repository" is now ready to accept your changes.1408Come back to the machine you have your private repository. From1409there, run this command:14101411------------1412$ git push <public-host>:/path/to/my-git.git master1413------------14141415This synchronizes your public repository to match the named1416branch head (i.e. `master` in this case) and objects reachable1417from them in your current repository.14181419As a real example, this is how I update my public git1420repository. Kernel.org mirror network takes care of the1421propagation to other publicly visible machines:14221423------------1424$ git push master.kernel.org:/pub/scm/git/git.git/ 1425------------142614271428Packing your repository1429-----------------------14301431Earlier, we saw that one file under `.git/objects/??/` directory1432is stored for each git object you create. This representation1433is efficient to create atomically and safely, but1434not so convenient to transport over the network. Since git objects are1435immutable once they are created, there is a way to optimize the1436storage by "packing them together". The command14371438------------1439$ git repack1440------------14411442will do it for you. If you followed the tutorial examples, you1443would have accumulated about 17 objects in `.git/objects/??/`1444directories by now. `git repack` tells you how many objects it1445packed, and stores the packed file in `.git/objects/pack`1446directory.14471448[NOTE]1449You will see two files, `pack-\*.pack` and `pack-\*.idx`,1450in `.git/objects/pack` directory. They are closely related to1451each other, and if you ever copy them by hand to a different1452repository for whatever reason, you should make sure you copy1453them together. The former holds all the data from the objects1454in the pack, and the latter holds the index for random1455access.14561457If you are paranoid, running `git-verify-pack` command would1458detect if you have a corrupt pack, but do not worry too much.1459Our programs are always perfect ;-).14601461Once you have packed objects, you do not need to leave the1462unpacked objects that are contained in the pack file anymore.14631464------------1465$ git prune-packed1466------------14671468would remove them for you.14691470You can try running `find .git/objects -type f` before and after1471you run `git prune-packed` if you are curious. Also `git1472count-objects` would tell you how many unpacked objects are in1473your repository and how much space they are consuming.14741475[NOTE]1476`git pull` is slightly cumbersome for HTTP transport, as a1477packed repository may contain relatively few objects in a1478relatively large pack. If you expect many HTTP pulls from your1479public repository you might want to repack & prune often, or1480never.14811482If you run `git repack` again at this point, it will say1483"Nothing to pack". Once you continue your development and1484accumulate the changes, running `git repack` again will create a1485new pack, that contains objects created since you packed your1486repository the last time. We recommend that you pack your project1487soon after the initial import (unless you are starting your1488project from scratch), and then run `git repack` every once in a1489while, depending on how active your project is.14901491When a repository is synchronized via `git push` and `git pull`1492objects packed in the source repository are usually stored1493unpacked in the destination, unless rsync transport is used.1494While this allows you to use different packing strategies on1495both ends, it also means you may need to repack both1496repositories every once in a while.149714981499Working with Others1500-------------------15011502Although git is a truly distributed system, it is often1503convenient to organize your project with an informal hierarchy1504of developers. Linux kernel development is run this way. There1505is a nice illustration (page 17, "Merges to Mainline") in Randy1506Dunlap's presentation (`http://tinyurl.com/a2jdg`).15071508It should be stressed that this hierarchy is purely *informal*.1509There is nothing fundamental in git that enforces the "chain of1510patch flow" this hierarchy implies. You do not have to pull1511from only one remote repository.15121513A recommended workflow for a "project lead" goes like this:151415151. Prepare your primary repository on your local machine. Your1516 work is done there.151715182. Prepare a public repository accessible to others.1519+1520If other people are pulling from your repository over dumb1521transport protocols (HTTP), you need to keep this repository1522'dumb transport friendly'. After `git init-db`,1523`$GIT_DIR/hooks/post-update` copied from the standard templates1524would contain a call to `git-update-server-info` but the1525`post-update` hook itself is disabled by default -- enable it1526with `chmod +x post-update`. This makes sure `git-update-server-info`1527keeps the necessary files up-to-date.152815293. Push into the public repository from your primary1530 repository.153115324. `git repack` the public repository. This establishes a big1533 pack that contains the initial set of objects as the1534 baseline, and possibly `git prune` if the transport1535 used for pulling from your repository supports packed1536 repositories.153715385. Keep working in your primary repository. Your changes1539 include modifications of your own, patches you receive via1540 e-mails, and merges resulting from pulling the "public"1541 repositories of your "subsystem maintainers".1542+1543You can repack this private repository whenever you feel like.154415456. Push your changes to the public repository, and announce it1546 to the public.154715487. Every once in a while, "git repack" the public repository.1549 Go back to step 5. and continue working.155015511552A recommended work cycle for a "subsystem maintainer" who works1553on that project and has an own "public repository" goes like this:155415551. Prepare your work repository, by `git clone` the public1556 repository of the "project lead". The URL used for the1557 initial cloning is stored in `.git/remotes/origin`.155815592. Prepare a public repository accessible to others, just like1560 the "project lead" person does.156115623. Copy over the packed files from "project lead" public1563 repository to your public repository, unless the "project1564 lead" repository lives on the same machine as yours. In the1565 latter case, you can use `objects/info/alternates` file to1566 point at the repository you are borrowing from.156715684. Push into the public repository from your primary1569 repository. Run `git repack`, and possibly `git prune` if the1570 transport used for pulling from your repository supports1571 packed repositories.157215735. Keep working in your primary repository. Your changes1574 include modifications of your own, patches you receive via1575 e-mails, and merges resulting from pulling the "public"1576 repositories of your "project lead" and possibly your1577 "sub-subsystem maintainers".1578+1579You can repack this private repository whenever you feel1580like.158115826. Push your changes to your public repository, and ask your1583 "project lead" and possibly your "sub-subsystem1584 maintainers" to pull from it.158515867. Every once in a while, `git repack` the public repository.1587 Go back to step 5. and continue working.158815891590A recommended work cycle for an "individual developer" who does1591not have a "public" repository is somewhat different. It goes1592like this:159315941. Prepare your work repository, by `git clone` the public1595 repository of the "project lead" (or a "subsystem1596 maintainer", if you work on a subsystem). The URL used for1597 the initial cloning is stored in `.git/remotes/origin`.159815992. Do your work in your repository on 'master' branch.160016013. Run `git fetch origin` from the public repository of your1602 upstream every once in a while. This does only the first1603 half of `git pull` but does not merge. The head of the1604 public repository is stored in `.git/refs/heads/origin`.160516064. Use `git cherry origin` to see which ones of your patches1607 were accepted, and/or use `git rebase origin` to port your1608 unmerged changes forward to the updated upstream.160916105. Use `git format-patch origin` to prepare patches for e-mail1611 submission to your upstream and send it out. Go back to1612 step 2. and continue.161316141615Working with Others, Shared Repository Style1616--------------------------------------------16171618If you are coming from CVS background, the style of cooperation1619suggested in the previous section may be new to you. You do not1620have to worry. git supports "shared public repository" style of1621cooperation you are probably more familiar with as well.16221623See link:cvs-migration.txt[git for CVS users] for the details.16241625Bundling your work together1626---------------------------16271628It is likely that you will be working on more than one thing at1629a time. It is easy to manage those more-or-less independent tasks1630using branches with git.16311632We have already seen how branches work previously,1633with "fun and work" example using two branches. The idea is the1634same if there are more than two branches. Let's say you started1635out from "master" head, and have some new code in the "master"1636branch, and two independent fixes in the "commit-fix" and1637"diff-fix" branches:16381639------------1640$ git show-branch1641! [commit-fix] Fix commit message normalization.1642 ! [diff-fix] Fix rename detection.1643 * [master] Release candidate #11644---1645 + [diff-fix] Fix rename detection.1646 + [diff-fix~1] Better common substring algorithm.1647+ [commit-fix] Fix commit message normalization.1648 * [master] Release candidate #11649++* [diff-fix~2] Pretty-print messages.1650------------16511652Both fixes are tested well, and at this point, you want to merge1653in both of them. You could merge in 'diff-fix' first and then1654'commit-fix' next, like this:16551656------------1657$ git merge 'Merge fix in diff-fix' master diff-fix1658$ git merge 'Merge fix in commit-fix' master commit-fix1659------------16601661Which would result in:16621663------------1664$ git show-branch1665! [commit-fix] Fix commit message normalization.1666 ! [diff-fix] Fix rename detection.1667 * [master] Merge fix in commit-fix1668---1669 - [master] Merge fix in commit-fix1670+ * [commit-fix] Fix commit message normalization.1671 - [master~1] Merge fix in diff-fix1672 +* [diff-fix] Fix rename detection.1673 +* [diff-fix~1] Better common substring algorithm.1674 * [master~2] Release candidate #11675++* [master~3] Pretty-print messages.1676------------16771678However, there is no particular reason to merge in one branch1679first and the other next, when what you have are a set of truly1680independent changes (if the order mattered, then they are not1681independent by definition). You could instead merge those two1682branches into the current branch at once. First let's undo what1683we just did and start over. We would want to get the master1684branch before these two merges by resetting it to 'master~2':16851686------------1687$ git reset --hard master~21688------------16891690You can make sure 'git show-branch' matches the state before1691those two 'git merge' you just did. Then, instead of running1692two 'git merge' commands in a row, you would pull these two1693branch heads (this is known as 'making an Octopus'):16941695------------1696$ git pull . commit-fix diff-fix1697$ git show-branch1698! [commit-fix] Fix commit message normalization.1699 ! [diff-fix] Fix rename detection.1700 * [master] Octopus merge of branches 'diff-fix' and 'commit-fix'1701---1702 - [master] Octopus merge of branches 'diff-fix' and 'commit-fix'1703+ * [commit-fix] Fix commit message normalization.1704 +* [diff-fix] Fix rename detection.1705 +* [diff-fix~1] Better common substring algorithm.1706 * [master~1] Release candidate #11707++* [master~2] Pretty-print messages.1708------------17091710Note that you should not do Octopus because you can. An octopus1711is a valid thing to do and often makes it easier to view the1712commit history if you are pulling more than two independent1713changes at the same time. However, if you have merge conflicts1714with any of the branches you are merging in and need to hand1715resolve, that is an indication that the development happened in1716those branches were not independent after all, and you should1717merge two at a time, documenting how you resolved the conflicts,1718and the reason why you preferred changes made in one side over1719the other. Otherwise it would make the project history harder1720to follow, not easier.17211722[ to be continued.. cvsimports ]