1A short git tutorial 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 23 24Creating a git repository 25------------------------- 26 27Creating a new git repository couldn't be easier: all git repositories start 28out empty, and the only thing you need to do is find yourself a 29subdirectory that you want to use as a working tree - either an empty 30one for a totally new project, or an existing working tree that you want 31to import into git. 32 33For our first example, we're going to start a totally new repository from 34scratch, with no pre-existing files, and we'll call it `git-tutorial`. 35To start up, create a subdirectory for it, change into that 36subdirectory, and initialize the git infrastructure with `git-init-db`: 37 38------------------------------------------------ 39$ mkdir git-tutorial 40$ cd git-tutorial 41$ git-init-db 42------------------------------------------------ 43 44to which git will reply 45 46---------------- 47defaulting to local storage area 48---------------- 49 50which is just git's way of saying that you haven't been doing anything 51strange, and that it will have created a local `.git` directory setup for 52your new project. You will now have a `.git` directory, and you can 53inspect that with `ls`. For your new empty project, it should show you 54three entries, among other things: 55 56 - a symlink called `HEAD`, pointing to `refs/heads/master` (if your 57 platform does not have native symlinks, it is a file containing the 58 line "ref: refs/heads/master") 59+ 60Don't worry about the fact that the file that the `HEAD` link points to 61doesn't even exist yet -- you haven't created the commit that will 62start your `HEAD` development branch yet. 63 64 - a subdirectory called `objects`, which will contain all the 65 objects of your project. You should never have any real reason to 66 look at the objects directly, but you might want to know that these 67 objects are what contains all the real 'data' in your repository. 68 69 - a subdirectory called `refs`, which contains references to objects. 70 71In particular, the `refs` subdirectory will contain two other 72subdirectories, named `heads` and `tags` respectively. They do 73exactly what their names imply: they contain references to any number 74of different 'heads' of development (aka 'branches'), and to any 75'tags' that you have created to name specific versions in your 76repository. 77 78One note: the special `master` head is the default branch, which is 79why the `.git/HEAD` file was created as a symlink to it even if it 80doesn't yet exist. Basically, the `HEAD` link is supposed to always 81point to the branch you are working on right now, and you always 82start out expecting to work on the `master` branch. 83 84However, this is only a convention, and you can name your branches 85anything you want, and don't have to ever even 'have' a `master` 86branch. A number of the git tools will assume that `.git/HEAD` is 87valid, though. 88 89[NOTE] 90An 'object' is identified by its 160-bit SHA1 hash, aka 'object name', 91and a reference to an object is always the 40-byte hex 92representation of that SHA1 name. The files in the `refs` 93subdirectory are expected to contain these hex references 94(usually with a final `\'\n\'` at the end), and you should thus 95expect to see a number of 41-byte files containing these 96references in these `refs` subdirectories when you actually start 97populating your tree. 98 99[NOTE] 100An advanced user may want to take a look at the 101link:repository-layout.html[repository layout] document 102after finishing this tutorial. 103 104You have now created your first git repository. Of course, since it's 105empty, that's not very useful, so let's start populating it with data. 106 107 108Populating a git repository 109--------------------------- 110 111We'll keep this simple and stupid, so we'll start off with populating a 112few trivial files just to get a feel for it. 113 114Start off with just creating any random files that you want to maintain 115in your git repository. We'll start off with a few bad examples, just to 116get a feel for how this works: 117 118------------------------------------------------ 119$ echo "Hello World" >hello 120$ echo "Silly example" >example 121------------------------------------------------ 122 123you have now created two files in your working tree (aka 'working directory'), but to 124actually check in your hard work, you will have to go through two steps: 125 126 - fill in the 'index' file (aka 'cache') with the information about your 127 working tree state. 128 129 - commit that index file as an object. 130 131The first step is trivial: when you want to tell git about any changes 132to your working tree, you use the `git-update-index` program. That 133program normally just takes a list of filenames you want to update, but 134to avoid trivial mistakes, it refuses to add new entries to the index 135(or remove existing ones) unless you explicitly tell it that you're 136adding a new entry with the `\--add` flag (or removing an entry with the 137`\--remove`) flag. 138 139So to populate the index with the two files you just created, you can do 140 141------------------------------------------------ 142$ git-update-index --add hello example 143------------------------------------------------ 144 145and you have now told git to track those two files. 146 147In fact, as you did that, if you now look into your object directory, 148you'll notice that git will have added two new objects to the object 149database. If you did exactly the steps above, you should now be able to do 150 151 152---------------- 153$ ls .git/objects/??/* 154---------------- 155 156and see two files: 157 158---------------- 159.git/objects/55/7db03de997c86a4a028e1ebd3a1ceb225be238 160.git/objects/f2/4c74a2e500f5ee1332c86b94199f52b1d1d962 161---------------- 162 163which correspond with the objects with names of 557db... and f24c7.. 164respectively. 165 166If you want to, you can use `git-cat-file` to look at those objects, but 167you'll have to use the object name, not the filename of the object: 168 169---------------- 170$ git-cat-file -t 557db03de997c86a4a028e1ebd3a1ceb225be238 171---------------- 172 173where the `-t` tells `git-cat-file` to tell you what the "type" of the 174object is. git will tell you that you have a "blob" object (ie just a 175regular file), and you can see the contents with 176 177---------------- 178$ git-cat-file "blob" 557db03 179---------------- 180 181which will print out "Hello World". The object 557db03 is nothing 182more than the contents of your file `hello`. 183 184[NOTE] 185Don't confuse that object with the file `hello` itself. The 186object is literally just those specific *contents* of the file, and 187however much you later change the contents in file `hello`, the object 188we just looked at will never change. Objects are immutable. 189 190[NOTE] 191The second example demonstrates that you can 192abbreviate the object name to only the first several 193hexadecimal digits in most places. 194 195Anyway, as we mentioned previously, you normally never actually take a 196look at the objects themselves, and typing long 40-character hex 197names is not something you'd normally want to do. The above digression 198was just to show that `git-update-index` did something magical, and 199actually saved away the contents of your files into the git object 200database. 201 202Updating the index did something else too: it created a `.git/index` 203file. This is the index that describes your current working tree, and 204something you should be very aware of. Again, you normally never worry 205about the index file itself, but you should be aware of the fact that 206you have not actually really "checked in" your files into git so far, 207you've only *told* git about them. 208 209However, since git knows about them, you can now start using some of the 210most basic git commands to manipulate the files or look at their status. 211 212In particular, let's not even check in the two files into git yet, we'll 213start off by adding another line to `hello` first: 214 215------------------------------------------------ 216$ echo "It's a new day for git" >>hello 217------------------------------------------------ 218 219and you can now, since you told git about the previous state of `hello`, ask 220git what has changed in the tree compared to your old index, using the 221`git-diff-files` command: 222 223------------ 224$ git-diff-files 225------------ 226 227Oops. That wasn't very readable. It just spit out its own internal 228version of a `diff`, but that internal version really just tells you 229that it has noticed that "hello" has been modified, and that the old object 230contents it had have been replaced with something else. 231 232To make it readable, we can tell git-diff-files to output the 233differences as a patch, using the `-p` flag: 234 235------------ 236$ git-diff-files -p 237diff --git a/hello b/hello 238index 557db03..263414f 100644 239--- a/hello 240+++ b/hello 241@@ -1 +1,2 @@ 242 Hello World 243+It's a new day for git 244---- 245 246i.e. the diff of the change we caused by adding another line to `hello`. 247 248In other words, `git-diff-files` always shows us the difference between 249what is recorded in the index, and what is currently in the working 250tree. That's very useful. 251 252A common shorthand for `git-diff-files -p` is to just write `git 253diff`, which will do the same thing. 254 255 256Committing git state 257-------------------- 258 259Now, we want to go to the next stage in git, which is to take the files 260that git knows about in the index, and commit them as a real tree. We do 261that in two phases: creating a 'tree' object, and committing that 'tree' 262object as a 'commit' object together with an explanation of what the 263tree was all about, along with information of how we came to that state. 264 265Creating a tree object is trivial, and is done with `git-write-tree`. 266There are no options or other input: git-write-tree will take the 267current index state, and write an object that describes that whole 268index. In other words, we're now tying together all the different 269filenames with their contents (and their permissions), and we're 270creating the equivalent of a git "directory" object: 271 272------------------------------------------------ 273$ git-write-tree 274------------------------------------------------ 275 276and this will just output the name of the resulting tree, in this case 277(if you have done exactly as I've described) it should be 278 279---------------- 2808988da15d077d4829fc51d8544c097def6644dbb 281---------------- 282 283which is another incomprehensible object name. Again, if you want to, 284you can use `git-cat-file -t 8988d\...` to see that this time the object 285is not a "blob" object, but a "tree" object (you can also use 286`git-cat-file` to actually output the raw object contents, but you'll see 287mainly a binary mess, so that's less interesting). 288 289However -- normally you'd never use `git-write-tree` on its own, because 290normally you always commit a tree into a commit object using the 291`git-commit-tree` command. In fact, it's easier to not actually use 292`git-write-tree` on its own at all, but to just pass its result in as an 293argument to `git-commit-tree`. 294 295`git-commit-tree` normally takes several arguments -- it wants to know 296what the 'parent' of a commit was, but since this is the first commit 297ever in this new repository, and it has no parents, we only need to pass in 298the object name of the tree. However, `git-commit-tree` 299also wants to get a commit message 300on its standard input, and it will write out the resulting object name for the 301commit to its standard output. 302 303And this is where we create the `.git/refs/heads/master` file 304which is pointed at by `HEAD`. This file is supposed to contain 305the reference to the top-of-tree of the master branch, and since 306that's exactly what `git-commit-tree` spits out, we can do this 307all with a sequence of simple shell commands: 308 309------------------------------------------------ 310$ tree=$(git-write-tree) 311$ commit=$(echo 'Initial commit' | git-commit-tree $tree) 312$ git-update-ref HEAD $commit 313------------------------------------------------ 314 315which will say: 316 317---------------- 318Committing initial tree 8988da15d077d4829fc51d8544c097def6644dbb 319---------------- 320 321just to warn you about the fact that it created a totally new commit 322that is not related to anything else. Normally you do this only *once* 323for a project ever, and all later commits will be parented on top of an 324earlier commit, and you'll never see this "Committing initial tree" 325message ever again. 326 327Again, normally you'd never actually do this by hand. There is a 328helpful script called `git commit` that will do all of this for you. So 329you could have just written `git commit` 330instead, and it would have done the above magic scripting for you. 331 332 333Making a change 334--------------- 335 336Remember how we did the `git-update-index` on file `hello` and then we 337changed `hello` afterward, and could compare the new state of `hello` with the 338state we saved in the index file? 339 340Further, remember how I said that `git-write-tree` writes the contents 341of the *index* file to the tree, and thus what we just committed was in 342fact the *original* contents of the file `hello`, not the new ones. We did 343that on purpose, to show the difference between the index state, and the 344state in the working tree, and how they don't have to match, even 345when we commit things. 346 347As before, if we do `git-diff-files -p` in our git-tutorial project, 348we'll still see the same difference we saw last time: the index file 349hasn't changed by the act of committing anything. However, now that we 350have committed something, we can also learn to use a new command: 351`git-diff-index`. 352 353Unlike `git-diff-files`, which showed the difference between the index 354file and the working tree, `git-diff-index` shows the differences 355between a committed *tree* and either the index file or the working 356tree. In other words, `git-diff-index` wants a tree to be diffed 357against, and before we did the commit, we couldn't do that, because we 358didn't have anything to diff against. 359 360But now we can do 361 362---------------- 363$ git-diff-index -p HEAD 364---------------- 365 366(where `-p` has the same meaning as it did in `git-diff-files`), and it 367will show us the same difference, but for a totally different reason. 368Now we're comparing the working tree not against the index file, 369but against the tree we just wrote. It just so happens that those two 370are obviously the same, so we get the same result. 371 372Again, because this is a common operation, you can also just shorthand 373it with 374 375---------------- 376$ git diff HEAD 377---------------- 378 379which ends up doing the above for you. 380 381In other words, `git-diff-index` normally compares a tree against the 382working tree, but when given the `\--cached` flag, it is told to 383instead compare against just the index cache contents, and ignore the 384current working tree state entirely. Since we just wrote the index 385file to HEAD, doing `git-diff-index \--cached -p HEAD` should thus return 386an empty set of differences, and that's exactly what it does. 387 388[NOTE] 389================ 390`git-diff-index` really always uses the index for its 391comparisons, and saying that it compares a tree against the working 392tree is thus not strictly accurate. In particular, the list of 393files to compare (the "meta-data") *always* comes from the index file, 394regardless of whether the `\--cached` flag is used or not. The `\--cached` 395flag really only determines whether the file *contents* to be compared 396come from the working tree or not. 397 398This is not hard to understand, as soon as you realize that git simply 399never knows (or cares) about files that it is not told about 400explicitly. git will never go *looking* for files to compare, it 401expects you to tell it what the files are, and that's what the index 402is there for. 403================ 404 405However, our next step is to commit the *change* we did, and again, to 406understand what's going on, keep in mind the difference between "working 407tree contents", "index file" and "committed tree". We have changes 408in the working tree that we want to commit, and we always have to 409work through the index file, so the first thing we need to do is to 410update the index cache: 411 412------------------------------------------------ 413$ git-update-index hello 414------------------------------------------------ 415 416(note how we didn't need the `\--add` flag this time, since git knew 417about the file already). 418 419Note what happens to the different `git-diff-\*` versions here. After 420we've updated `hello` in the index, `git-diff-files -p` now shows no 421differences, but `git-diff-index -p HEAD` still *does* show that the 422current state is different from the state we committed. In fact, now 423`git-diff-index` shows the same difference whether we use the `--cached` 424flag or not, since now the index is coherent with the working tree. 425 426Now, since we've updated `hello` in the index, we can commit the new 427version. We could do it by writing the tree by hand again, and 428committing the tree (this time we'd have to use the `-p HEAD` flag to 429tell commit that the HEAD was the *parent* of the new commit, and that 430this wasn't an initial commit any more), but you've done that once 431already, so let's just use the helpful script this time: 432 433------------------------------------------------ 434$ git commit 435------------------------------------------------ 436 437which starts an editor for you to write the commit message and tells you 438a bit about what you have done. 439 440Write whatever message you want, and all the lines that start with '#' 441will be pruned out, and the rest will be used as the commit message for 442the change. If you decide you don't want to commit anything after all at 443this point (you can continue to edit things and update the index), you 444can just leave an empty message. Otherwise `git commit` will commit 445the change for you. 446 447You've now made your first real git commit. And if you're interested in 448looking at what `git commit` really does, feel free to investigate: 449it's a few very simple shell scripts to generate the helpful (?) commit 450message headers, and a few one-liners that actually do the 451commit itself (`git-commit`). 452 453 454Inspecting Changes 455------------------ 456 457While creating changes is useful, it's even more useful if you can tell 458later what changed. The most useful command for this is another of the 459`diff` family, namely `git-diff-tree`. 460 461`git-diff-tree` can be given two arbitrary trees, and it will tell you the 462differences between them. Perhaps even more commonly, though, you can 463give it just a single commit object, and it will figure out the parent 464of that commit itself, and show the difference directly. Thus, to get 465the same diff that we've already seen several times, we can now do 466 467---------------- 468$ git-diff-tree -p HEAD 469---------------- 470 471(again, `-p` means to show the difference as a human-readable patch), 472and it will show what the last commit (in `HEAD`) actually changed. 473 474[NOTE] 475============ 476Here is an ASCII art by Jon Loeliger that illustrates how 477various diff-\* commands compare things. 478 479 diff-tree 480 +----+ 481 | | 482 | | 483 V V 484 +-----------+ 485 | Object DB | 486 | Backing | 487 | Store | 488 +-----------+ 489 ^ ^ 490 | | 491 | | diff-index --cached 492 | | 493 diff-index | V 494 | +-----------+ 495 | | Index | 496 | | "cache" | 497 | +-----------+ 498 | ^ 499 | | 500 | | diff-files 501 | | 502 V V 503 +-----------+ 504 | Working | 505 | Directory | 506 +-----------+ 507============ 508 509More interestingly, you can also give `git-diff-tree` the `-v` flag, which 510tells it to also show the commit message and author and date of the 511commit, and you can tell it to show a whole series of diffs. 512Alternatively, you can tell it to be "silent", and not show the diffs at 513all, but just show the actual commit message. 514 515In fact, together with the `git-rev-list` program (which generates a 516list of revisions), `git-diff-tree` ends up being a veritable fount of 517changes. A trivial (but very useful) script called `git-whatchanged` is 518included with git which does exactly this, and shows a log of recent 519activities. 520 521To see the whole history of our pitiful little git-tutorial project, you 522can do 523 524---------------- 525$ git log 526---------------- 527 528which shows just the log messages, or if we want to see the log together 529with the associated patches use the more complex (and much more 530powerful) 531 532---------------- 533$ git-whatchanged -p --root 534---------------- 535 536and you will see exactly what has changed in the repository over its 537short history. 538 539[NOTE] 540The `\--root` flag is a flag to `git-diff-tree` to tell it to 541show the initial aka 'root' commit too. Normally you'd probably not 542want to see the initial import diff, but since the tutorial project 543was started from scratch and is so small, we use it to make the result 544a bit more interesting. 545 546With that, you should now be having some inkling of what git does, and 547can explore on your own. 548 549[NOTE] 550Most likely, you are not directly using the core 551git Plumbing commands, but using Porcelain like Cogito on top 552of it. Cogito works a bit differently and you usually do not 553have to run `git-update-index` yourself for changed files (you 554do tell underlying git about additions and removals via 555`cg-add` and `cg-rm` commands). Just before you make a commit 556with `cg-commit`, Cogito figures out which files you modified, 557and runs `git-update-index` on them for you. 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, ie 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` is the 685above 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$ ls -l .git/HEAD 794------------ 795 796will tell you where it's pointing (Note that on platforms with bad or no 797symlink support, you have to execute 798 799------------ 800$ cat .git/HEAD 801------------ 802 803instead). To get the list of branches you have, you can say 804 805------------ 806$ git branch 807------------ 808 809which is nothing more than a simple script around `ls .git/refs/heads`. 810There will be asterisk in front of the branch you are currently on. 811 812Sometimes you may wish to create a new branch _without_ actually 813checking it out and switching to it. If so, just use the command 814 815------------ 816$ git branch <branchname> [startingpoint] 817------------ 818 819which will simply _create_ the branch, but will not do anything further. 820You can then later -- once you decide that you want to actually develop 821on that branch -- switch to that branch with a regular `git checkout` 822with the branchname as the argument. 823 824 825Merging two branches 826-------------------- 827 828One of the ideas of having a branch is that you do some (possibly 829experimental) work in it, and eventually merge it back to the main 830branch. So assuming you created the above `mybranch` that started out 831being the same as the original `master` branch, let's make sure we're in 832that branch, and do some work there. 833 834------------------------------------------------ 835$ git checkout mybranch 836$ echo "Work, work, work" >>hello 837$ git commit -m 'Some work.' hello 838------------------------------------------------ 839 840Here, we just added another line to `hello`, and we used a shorthand for 841doing both `git-update-index hello` and `git commit` by just giving the 842filename directly to `git commit`. The `-m` flag is to give the 843commit log message from the command line. 844 845Now, to make it a bit more interesting, let's assume that somebody else 846does some work in the original branch, and simulate that by going back 847to the master branch, and editing the same file differently there: 848 849------------ 850$ git checkout master 851------------ 852 853Here, take a moment to look at the contents of `hello`, and notice how they 854don't contain the work we just did in `mybranch` -- because that work 855hasn't happened in the `master` branch at all. Then do 856 857------------ 858$ echo "Play, play, play" >>hello 859$ echo "Lots of fun" >>example 860$ git commit -m 'Some fun.' hello example 861------------ 862 863since the master branch is obviously in a much better mood. 864 865Now, you've got two branches, and you decide that you want to merge the 866work done. Before we do that, let's introduce a cool graphical tool that 867helps you view what's going on: 868 869---------------- 870$ gitk --all 871---------------- 872 873will show you graphically both of your branches (that's what the `\--all` 874means: normally it will just show you your current `HEAD`) and their 875histories. You can also see exactly how they came to be from a common 876source. 877 878Anyway, let's exit `gitk` (`^Q` or the File menu), and decide that we want 879to merge the work we did on the `mybranch` branch into the `master` 880branch (which is currently our `HEAD` too). To do that, there's a nice 881script called `git merge`, which wants to know which branches you want 882to resolve and what the merge is all about: 883 884------------ 885$ git merge "Merge work in mybranch" HEAD mybranch 886------------ 887 888where the first argument is going to be used as the commit message if 889the merge can be resolved automatically. 890 891Now, in this case we've intentionally created a situation where the 892merge will need to be fixed up by hand, though, so git will do as much 893of it as it can automatically (which in this case is just merge the `example` 894file, which had no differences in the `mybranch` branch), and say: 895 896---------------- 897 Trying really trivial in-index merge... 898 fatal: Merge requires file-level merging 899 Nope. 900 ... 901 merge: warning: conflicts during merge 902 ERROR: Merge conflict in hello. 903 fatal: merge program failed 904 Automatic merge failed/prevented; fix up by hand 905---------------- 906 907which is way too verbose, but it basically tells you that it failed the 908really trivial merge ("Simple merge") and did an "Automatic merge" 909instead, but that too failed due to conflicts in `hello`. 910 911Not to worry. It left the (trivial) conflict in `hello` in the same form you 912should already be well used to if you've ever used CVS, so let's just 913open `hello` in our editor (whatever that may be), and fix it up somehow. 914I'd suggest just making it so that `hello` contains all four lines: 915 916------------ 917Hello World 918It's a new day for git 919Play, play, play 920Work, work, work 921------------ 922 923and once you're happy with your manual merge, just do a 924 925------------ 926$ git commit hello 927------------ 928 929which will very loudly warn you that you're now committing a merge 930(which is correct, so never mind), and you can write a small merge 931message about your adventures in git-merge-land. 932 933After you're done, start up `gitk \--all` to see graphically what the 934history looks like. Notice that `mybranch` still exists, and you can 935switch to it, and continue to work with it if you want to. The 936`mybranch` branch will not contain the merge, but next time you merge it 937from the `master` branch, git will know how you merged it, so you'll not 938have to do _that_ merge again. 939 940Another useful tool, especially if you do not always work in X-Window 941environment, is `git show-branch`. 942 943------------------------------------------------ 944$ git show-branch master mybranch 945* [master] Merged "mybranch" changes. 946 ! [mybranch] Some work. 947-- 948+ [master] Merged "mybranch" changes. 949++ [mybranch] Some work. 950------------------------------------------------ 951 952The first two lines indicate that it is showing the two branches 953and the first line of the commit log message from their 954top-of-the-tree commits, you are currently on `master` branch 955(notice the asterisk `*` character), and the first column for 956the later output lines is used to show commits contained in the 957`master` branch, and the second column for the `mybranch` 958branch. Three commits are shown along with their log messages. 959All of them have plus `+` characters in the first column, which 960means they are now part of the `master` branch. Only the "Some 961work" commit has the plus `+` character in the second column, 962because `mybranch` has not been merged to incorporate these 963commits from the master branch. The string inside brackets 964before the commit log message is a short name you can use to 965name the commit. In the above example, 'master' and 'mybranch' 966are branch heads. 'master~1' is the first parent of 'master' 967branch head. Please see 'git-rev-parse' documentation if you 968see more complex cases. 969 970Now, let's pretend you are the one who did all the work in 971`mybranch`, and the fruit of your hard work has finally been merged 972to the `master` branch. Let's go back to `mybranch`, and run 973resolve to get the "upstream changes" back to your branch. 974 975------------ 976$ git checkout mybranch 977$ git merge "Merge upstream changes." HEAD master 978------------ 979 980This outputs something like this (the actual commit object names 981would be different) 982 983---------------- 984Updating from ae3a2da... to a80b4aa.... 985 example | 1 + 986 hello | 1 + 987 2 files changed, 2 insertions(+), 0 deletions(-) 988---------------- 989 990Because your branch did not contain anything more than what are 991already merged into the `master` branch, the resolve operation did 992not actually do a merge. Instead, it just updated the top of 993the tree of your branch to that of the `master` branch. This is 994often called 'fast forward' merge. 995 996You can run `gitk \--all` again to see how the commit ancestry 997looks like, or run `show-branch`, which tells you this. 998 999------------------------------------------------1000$ git show-branch master mybranch1001! [master] Merged "mybranch" changes.1002 * [mybranch] Merged "mybranch" changes.1003--1004++ [master] Merged "mybranch" changes.1005------------------------------------------------100610071008Merging external work1009---------------------10101011It's usually much more common that you merge with somebody else than1012merging with your own branches, so it's worth pointing out that git1013makes that very easy too, and in fact, it's not that different from1014doing a `git merge`. In fact, a remote merge ends up being nothing1015more than "fetch the work from a remote repository into a temporary tag"1016followed by a `git merge`.10171018Fetching from a remote repository is done by, unsurprisingly,1019`git fetch`:10201021----------------1022$ git fetch <remote-repository>1023----------------10241025One of the following transports can be used to name the1026repository to download from:10271028Rsync::1029 `rsync://remote.machine/path/to/repo.git/`1030+1031Rsync transport is usable for both uploading and downloading,1032but is completely unaware of what git does, and can produce1033unexpected results when you download from the public repository1034while the repository owner is uploading into it via `rsync`1035transport. Most notably, it could update the files under1036`refs/` which holds the object name of the topmost commits1037before uploading the files in `objects/` -- the downloader would1038obtain head commit object name while that object itself is still1039not available in the repository. For this reason, it is1040considered deprecated.10411042SSH::1043 `remote.machine:/path/to/repo.git/` or1044+1045`ssh://remote.machine/path/to/repo.git/`1046+1047This transport can be used for both uploading and downloading,1048and requires you to have a log-in privilege over `ssh` to the1049remote machine. It finds out the set of objects the other side1050lacks by exchanging the head commits both ends have and1051transfers (close to) minimum set of objects. It is by far the1052most efficient way to exchange git objects between repositories.10531054Local directory::1055 `/path/to/repo.git/`1056+1057This transport is the same as SSH transport but uses `sh` to run1058both ends on the local machine instead of running other end on1059the remote machine via `ssh`.10601061git Native::1062 `git://remote.machine/path/to/repo.git/`1063+1064This transport was designed for anonymous downloading. Like SSH1065transport, it finds out the set of objects the downstream side1066lacks and transfers (close to) minimum set of objects.10671068HTTP(S)::1069 `http://remote.machine/path/to/repo.git/`1070+1071HTTP and HTTPS transport are used only for downloading. They1072first obtain the topmost commit object name from the remote site1073by looking at `repo.git/info/refs` file, tries to obtain the1074commit object by downloading from `repo.git/objects/xx/xxx\...`1075using the object name of that commit object. Then it reads the1076commit object to find out its parent commits and the associate1077tree object; it repeats this process until it gets all the1078necessary objects. Because of this behaviour, they are1079sometimes also called 'commit walkers'.1080+1081The 'commit walkers' are sometimes also called 'dumb1082transports', because they do not require any git aware smart1083server like git Native transport does. Any stock HTTP server1084would suffice.1085+1086There are (confusingly enough) `git-ssh-fetch` and `git-ssh-upload`1087programs, which are 'commit walkers'; they outlived their1088usefulness when git Native and SSH transports were introduced,1089and not used by `git pull` or `git push` scripts.10901091Once you fetch from the remote repository, you `resolve` that1092with your current branch.10931094However -- it's such a common thing to `fetch` and then1095immediately `resolve`, that it's called `git pull`, and you can1096simply do10971098----------------1099$ git pull <remote-repository>1100----------------11011102and optionally give a branch-name for the remote end as a second1103argument.11041105[NOTE]1106You could do without using any branches at all, by1107keeping as many local repositories as you would like to have1108branches, and merging between them with `git pull`, just like1109you merge between branches. The advantage of this approach is1110that it lets you keep set of files for each `branch` checked1111out and you may find it easier to switch back and forth if you1112juggle multiple lines of development simultaneously. Of1113course, you will pay the price of more disk usage to hold1114multiple working trees, but disk space is cheap these days.11151116[NOTE]1117You could even pull from your own repository by1118giving '.' as <remote-repository> parameter to `git pull`. This1119is useful when you want to merge a local branch (or more, if you1120are making an Octopus) into the current branch.11211122It is likely that you will be pulling from the same remote1123repository from time to time. As a short hand, you can store1124the remote repository URL in a file under .git/remotes/1125directory, like this:11261127------------------------------------------------1128$ mkdir -p .git/remotes/1129$ cat >.git/remotes/linus <<\EOF1130URL: http://www.kernel.org/pub/scm/git/git.git/1131EOF1132------------------------------------------------11331134and use the filename to `git pull` instead of the full URL.1135The URL specified in such file can even be a prefix1136of a full URL, like this:11371138------------------------------------------------1139$ cat >.git/remotes/jgarzik <<\EOF1140URL: http://www.kernel.org/pub/scm/linux/git/jgarzik/1141EOF1142------------------------------------------------114311441145Examples.11461147. `git pull linus`1148. `git pull linus tag v0.99.1`1149. `git pull jgarzik/netdev-2.6.git/ e100`11501151the above are equivalent to:11521153. `git pull http://www.kernel.org/pub/scm/git/git.git/ HEAD`1154. `git pull http://www.kernel.org/pub/scm/git/git.git/ tag v0.99.1`1155. `git pull http://www.kernel.org/pub/.../jgarzik/netdev-2.6.git e100`115611571158How does the merge work?1159------------------------11601161We said this tutorial shows what plumbing does to help you cope1162with the porcelain that isn't flushing, but we so far did not1163talk about how the merge really works. If you are following1164this tutorial the first time, I'd suggest to skip to "Publishing1165your work" section and come back here later.11661167OK, still with me? To give us an example to look at, let's go1168back to the earlier repository with "hello" and "example" file,1169and bring ourselves back to the pre-merge state:11701171------------1172$ git show-branch --more=3 master mybranch1173! [master] Merge work in mybranch1174 * [mybranch] Merge work in mybranch1175--1176++ [master] Merge work in mybranch1177++ [master^2] Some work.1178++ [master^] Some fun.1179------------11801181Remember, before running `git merge`, our `master` head was at1182"Some fun." commit, while our `mybranch` head was at "Some1183work." commit.11841185------------1186$ git checkout mybranch1187$ git reset --hard master^21188$ git checkout master1189$ git reset --hard master^1190------------11911192After rewinding, the commit structure should look like this:11931194------------1195$ git show-branch1196* [master] Some fun.1197 ! [mybranch] Some work.1198--1199 + [mybranch] Some work.1200+ [master] Some fun.1201++ [mybranch^] New day.1202------------12031204Now we are ready to experiment with the merge by hand.12051206`git merge` command, when merging two branches, uses 3-way merge1207algorithm. First, it finds the common ancestor between them.1208The command it uses is `git-merge-base`:12091210------------1211$ mb=$(git-merge-base HEAD mybranch)1212------------12131214The command writes the commit object name of the common ancestor1215to the standard output, so we captured its output to a variable,1216because we will be using it in the next step. BTW, the common1217ancestor commit is the "New day." commit in this case. You can1218tell it by:12191220------------1221$ git-name-rev $mb1222my-first-tag1223------------12241225After finding out a common ancestor commit, the second step is1226this:12271228------------1229$ git-read-tree -m -u $mb HEAD mybranch1230------------12311232This is the same `git-read-tree` command we have already seen,1233but it takes three trees, unlike previous examples. This reads1234the contents of each tree into different 'stage' in the index1235file (the first tree goes to stage 1, the second stage 2,1236etc.). After reading three trees into three stages, the paths1237that are the same in all three stages are 'collapsed' into stage12380. Also paths that are the same in two of three stages are1239collapsed into stage 0, taking the SHA1 from either stage 2 or1240stage 3, whichever is different from stage 1 (i.e. only one side1241changed from the common ancestor).12421243After 'collapsing' operation, paths that are different in three1244trees are left in non-zero stages. At this point, you can1245inspect the index file with this command:12461247------------1248$ git-ls-files --stage1249100644 7f8b141b65fdcee47321e399a2598a235a032422 0 example1250100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1 hello1251100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2 hello1252100644 cc44c73eb783565da5831b4d820c962954019b69 3 hello1253------------12541255In our example of only two files, we did not have unchanged1256files so only 'example' resulted in collapsing, but in real-life1257large projects, only small number of files change in one commit,1258and this 'collapsing' tends to trivially merge most of the paths1259fairly quickly, leaving only a handful the real changes in non-zero1260stages.12611262To look at only non-zero stages, use `\--unmerged` flag:12631264------------1265$ git-ls-files --unmerged1266100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1 hello1267100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2 hello1268100644 cc44c73eb783565da5831b4d820c962954019b69 3 hello1269------------12701271The next step of merging is to merge these three versions of the1272file, using 3-way merge. This is done by giving1273`git-merge-one-file` command as one of the arguments to1274`git-merge-index` command:12751276------------1277$ git-merge-index git-merge-one-file hello1278Auto-merging hello.1279merge: warning: conflicts during merge1280ERROR: Merge conflict in hello.1281fatal: merge program failed1282------------12831284`git-merge-one-file` script is called with parameters to1285describe those three versions, and is responsible to leave the1286merge results in the working tree and register it in the index1287file. It is a fairly straightforward shell script, and1288eventually calls `merge` program from RCS suite to perform the1289file-level 3-way merge. In this case, `merge` detects1290conflicts, and the merge result with conflict marks is left in1291the working tree, while the index file is updated with the1292version from the current branch (this is to make `git diff`1293useful after this step). This can be seen if you run `ls-files1294--stage` again at this point:12951296------------1297$ git-ls-files --stage1298100644 7f8b141b65fdcee47321e399a2598a235a032422 0 example1299100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 0 hello1300------------13011302As you can see, there is no unmerged paths in the index file.1303This is the state of the index file and the working file after1304`git merge` returns control back to you, leaving the conflicting1305merge for you to resolve.130613071308Publishing your work1309--------------------13101311So we can use somebody else's work from a remote repository; but1312how can *you* prepare a repository to let other people pull from1313it?13141315Your do your real work in your working tree that has your1316primary repository hanging under it as its `.git` subdirectory.1317You *could* make that repository accessible remotely and ask1318people to pull from it, but in practice that is not the way1319things are usually done. A recommended way is to have a public1320repository, make it reachable by other people, and when the1321changes you made in your primary working tree are in good shape,1322update the public repository from it. This is often called1323'pushing'.13241325[NOTE]1326This public repository could further be mirrored, and that is1327how git repositories at `kernel.org` are managed.13281329Publishing the changes from your local (private) repository to1330your remote (public) repository requires a write privilege on1331the remote machine. You need to have an SSH account there to1332run a single command, `git-receive-pack`.13331334First, you need to create an empty repository on the remote1335machine that will house your public repository. This empty1336repository will be populated and be kept up-to-date by pushing1337into it later. Obviously, this repository creation needs to be1338done only once.13391340[NOTE]1341`git push` uses a pair of programs,1342`git-send-pack` on your local machine, and `git-receive-pack`1343on the remote machine. The communication between the two over1344the network internally uses an SSH connection.13451346Your private repository's git directory is usually `.git`, but1347your public repository is often named after the project name,1348i.e. `<project>.git`. Let's create such a public repository for1349project `my-git`. After logging into the remote machine, create1350an empty directory:13511352------------1353$ mkdir my-git.git1354------------13551356Then, make that directory into a git repository by running1357`git init-db`, but this time, since its name is not the usual1358`.git`, we do things slightly differently:13591360------------1361$ GIT_DIR=my-git.git git-init-db1362------------13631364Make sure this directory is available for others you want your1365changes to be pulled by via the transport of your choice. Also1366you need to make sure that you have the `git-receive-pack`1367program on the `$PATH`.13681369[NOTE]1370Many installations of sshd do not invoke your shell as the login1371shell when you directly run programs; what this means is that if1372your login shell is `bash`, only `.bashrc` is read and not1373`.bash_profile`. As a workaround, make sure `.bashrc` sets up1374`$PATH` so that you can run `git-receive-pack` program.13751376[NOTE]1377If you plan to publish this repository to be accessed over http,1378you should do `chmod +x my-git.git/hooks/post-update` at this1379point. This makes sure that every time you push into this1380repository, `git-update-server-info` is run.13811382Your "public repository" is now ready to accept your changes.1383Come back to the machine you have your private repository. From1384there, run this command:13851386------------1387$ git push <public-host>:/path/to/my-git.git master1388------------13891390This synchronizes your public repository to match the named1391branch head (i.e. `master` in this case) and objects reachable1392from them in your current repository.13931394As a real example, this is how I update my public git1395repository. Kernel.org mirror network takes care of the1396propagation to other publicly visible machines:13971398------------1399$ git push master.kernel.org:/pub/scm/git/git.git/ 1400------------140114021403Packing your repository1404-----------------------14051406Earlier, we saw that one file under `.git/objects/??/` directory1407is stored for each git object you create. This representation1408is efficient to create atomically and safely, but1409not so convenient to transport over the network. Since git objects are1410immutable once they are created, there is a way to optimize the1411storage by "packing them together". The command14121413------------1414$ git repack1415------------14161417will do it for you. If you followed the tutorial examples, you1418would have accumulated about 17 objects in `.git/objects/??/`1419directories by now. `git repack` tells you how many objects it1420packed, and stores the packed file in `.git/objects/pack`1421directory.14221423[NOTE]1424You will see two files, `pack-\*.pack` and `pack-\*.idx`,1425in `.git/objects/pack` directory. They are closely related to1426each other, and if you ever copy them by hand to a different1427repository for whatever reason, you should make sure you copy1428them together. The former holds all the data from the objects1429in the pack, and the latter holds the index for random1430access.14311432If you are paranoid, running `git-verify-pack` command would1433detect if you have a corrupt pack, but do not worry too much.1434Our programs are always perfect ;-).14351436Once you have packed objects, you do not need to leave the1437unpacked objects that are contained in the pack file anymore.14381439------------1440$ git prune-packed1441------------14421443would remove them for you.14441445You can try running `find .git/objects -type f` before and after1446you run `git prune-packed` if you are curious. Also `git1447count-objects` would tell you how many unpacked objects are in1448your repository and how much space they are consuming.14491450[NOTE]1451`git pull` is slightly cumbersome for HTTP transport, as a1452packed repository may contain relatively few objects in a1453relatively large pack. If you expect many HTTP pulls from your1454public repository you might want to repack & prune often, or1455never.14561457If you run `git repack` again at this point, it will say1458"Nothing to pack". Once you continue your development and1459accumulate the changes, running `git repack` again will create a1460new pack, that contains objects created since you packed your1461repository the last time. We recommend that you pack your project1462soon after the initial import (unless you are starting your1463project from scratch), and then run `git repack` every once in a1464while, depending on how active your project is.14651466When a repository is synchronized via `git push` and `git pull`1467objects packed in the source repository are usually stored1468unpacked in the destination, unless rsync transport is used.1469While this allows you to use different packing strategies on1470both ends, it also means you may need to repack both1471repositories every once in a while.147214731474Working with Others1475-------------------14761477Although git is a truly distributed system, it is often1478convenient to organize your project with an informal hierarchy1479of developers. Linux kernel development is run this way. There1480is a nice illustration (page 17, "Merges to Mainline") in Randy1481Dunlap's presentation (`http://tinyurl.com/a2jdg`).14821483It should be stressed that this hierarchy is purely *informal*.1484There is nothing fundamental in git that enforces the "chain of1485patch flow" this hierarchy implies. You do not have to pull1486from only one remote repository.14871488A recommended workflow for a "project lead" goes like this:148914901. Prepare your primary repository on your local machine. Your1491 work is done there.149214932. Prepare a public repository accessible to others.1494+1495If other people are pulling from your repository over dumb1496transport protocols, you need to keep this repository 'dumb1497transport friendly'. After `git init-db`,1498`$GIT_DIR/hooks/post-update` copied from the standard templates1499would contain a call to `git-update-server-info` but the1500`post-update` hook itself is disabled by default -- enable it1501with `chmod +x post-update`.150215033. Push into the public repository from your primary1504 repository.150515064. `git repack` the public repository. This establishes a big1507 pack that contains the initial set of objects as the1508 baseline, and possibly `git prune` if the transport1509 used for pulling from your repository supports packed1510 repositories.151115125. Keep working in your primary repository. Your changes1513 include modifications of your own, patches you receive via1514 e-mails, and merges resulting from pulling the "public"1515 repositories of your "subsystem maintainers".1516+1517You can repack this private repository whenever you feel like.151815196. Push your changes to the public repository, and announce it1520 to the public.152115227. Every once in a while, "git repack" the public repository.1523 Go back to step 5. and continue working.152415251526A recommended work cycle for a "subsystem maintainer" who works1527on that project and has an own "public repository" goes like this:152815291. Prepare your work repository, by `git clone` the public1530 repository of the "project lead". The URL used for the1531 initial cloning is stored in `.git/remotes/origin`.153215332. Prepare a public repository accessible to others, just like1534 the "project lead" person does.153515363. Copy over the packed files from "project lead" public1537 repository to your public repository, unless the "project1538 lead" repository lives on the same machine as yours. In the1539 latter case, you can use `objects/info/alternates` file to1540 point at the repository you are borrowing from.154115424. Push into the public repository from your primary1543 repository. Run `git repack`, and possibly `git prune` if the1544 transport used for pulling from your repository supports1545 packed repositories.154615475. Keep working in your primary repository. Your changes1548 include modifications of your own, patches you receive via1549 e-mails, and merges resulting from pulling the "public"1550 repositories of your "project lead" and possibly your1551 "sub-subsystem maintainers".1552+1553You can repack this private repository whenever you feel1554like.155515566. Push your changes to your public repository, and ask your1557 "project lead" and possibly your "sub-subsystem1558 maintainers" to pull from it.155915607. Every once in a while, `git repack` the public repository.1561 Go back to step 5. and continue working.156215631564A recommended work cycle for an "individual developer" who does1565not have a "public" repository is somewhat different. It goes1566like this:156715681. Prepare your work repository, by `git clone` the public1569 repository of the "project lead" (or a "subsystem1570 maintainer", if you work on a subsystem). The URL used for1571 the initial cloning is stored in `.git/remotes/origin`.157215732. Do your work in your repository on 'master' branch.157415753. Run `git fetch origin` from the public repository of your1576 upstream every once in a while. This does only the first1577 half of `git pull` but does not merge. The head of the1578 public repository is stored in `.git/refs/heads/origin`.157915804. Use `git cherry origin` to see which ones of your patches1581 were accepted, and/or use `git rebase origin` to port your1582 unmerged changes forward to the updated upstream.158315845. Use `git format-patch origin` to prepare patches for e-mail1585 submission to your upstream and send it out. Go back to1586 step 2. and continue.158715881589Working with Others, Shared Repository Style1590--------------------------------------------15911592If you are coming from CVS background, the style of cooperation1593suggested in the previous section may be new to you. You do not1594have to worry. git supports "shared public repository" style of1595cooperation you are probably more familiar with as well.15961597For this, set up a public repository on a machine that is1598reachable via SSH by people with "commit privileges". Put the1599committers in the same user group and make the repository1600writable by that group.16011602You, as an individual committer, then:16031604- First clone the shared repository to a local repository:1605------------------------------------------------1606$ git clone repo.shared.xz:/pub/scm/project.git/ my-project1607$ cd my-project1608$ hack away1609------------------------------------------------16101611- Merge the work others might have done while you were hacking1612 away:1613------------------------------------------------1614$ git pull origin1615$ test the merge result1616------------------------------------------------1617[NOTE]1618================================1619The first `git clone` would have placed the following in1620`my-project/.git/remotes/origin` file, and that's why this and1621the next step work.1622------------1623URL: repo.shared.xz:/pub/scm/project.git/ my-project1624Pull: master:origin1625------------1626================================16271628- push your work as the new head of the shared1629 repository.1630------------------------------------------------1631$ git push origin master1632------------------------------------------------1633If somebody else pushed into the same shared repository while1634you were working locally, `git push` in the last step would1635complain, telling you that the remote `master` head does not1636fast forward. You need to pull and merge those other changes1637back before you push your work when it happens.163816391640Bundling your work together1641---------------------------16421643It is likely that you will be working on more than one thing at1644a time. It is easy to use those more-or-less independent tasks1645using branches with git.16461647We have already seen how branches work in a previous example,1648with "fun and work" example using two branches. The idea is the1649same if there are more than two branches. Let's say you started1650out from "master" head, and have some new code in the "master"1651branch, and two independent fixes in the "commit-fix" and1652"diff-fix" branches:16531654------------1655$ git show-branch1656! [commit-fix] Fix commit message normalization.1657 ! [diff-fix] Fix rename detection.1658 * [master] Release candidate #11659---1660 + [diff-fix] Fix rename detection.1661 + [diff-fix~1] Better common substring algorithm.1662+ [commit-fix] Fix commit message normalization.1663 + [master] Release candidate #11664+++ [diff-fix~2] Pretty-print messages.1665------------16661667Both fixes are tested well, and at this point, you want to merge1668in both of them. You could merge in 'diff-fix' first and then1669'commit-fix' next, like this:16701671------------1672$ git merge 'Merge fix in diff-fix' master diff-fix1673$ git merge 'Merge fix in commit-fix' master commit-fix1674------------16751676Which would result in:16771678------------1679$ git show-branch1680! [commit-fix] Fix commit message normalization.1681 ! [diff-fix] Fix rename detection.1682 * [master] Merge fix in commit-fix1683---1684 + [master] Merge fix in commit-fix1685+ + [commit-fix] Fix commit message normalization.1686 + [master~1] Merge fix in diff-fix1687 ++ [diff-fix] Fix rename detection.1688 ++ [diff-fix~1] Better common substring algorithm.1689 + [master~2] Release candidate #11690+++ [master~3] Pretty-print messages.1691------------16921693However, there is no particular reason to merge in one branch1694first and the other next, when what you have are a set of truly1695independent changes (if the order mattered, then they are not1696independent by definition). You could instead merge those two1697branches into the current branch at once. First let's undo what1698we just did and start over. We would want to get the master1699branch before these two merges by resetting it to 'master~2':17001701------------1702$ git reset --hard master~21703------------17041705You can make sure 'git show-branch' matches the state before1706those two 'git merge' you just did. Then, instead of running1707two 'git merge' commands in a row, you would pull these two1708branch heads (this is known as 'making an Octopus'):17091710------------1711$ git pull . commit-fix diff-fix1712$ git show-branch1713! [commit-fix] Fix commit message normalization.1714 ! [diff-fix] Fix rename detection.1715 * [master] Octopus merge of branches 'diff-fix' and 'commit-fix'1716---1717 + [master] Octopus merge of branches 'diff-fix' and 'commit-fix'1718+ + [commit-fix] Fix commit message normalization.1719 ++ [diff-fix] Fix rename detection.1720 ++ [diff-fix~1] Better common substring algorithm.1721 + [master~1] Release candidate #11722+++ [master~2] Pretty-print messages.1723------------17241725Note that you should not do Octopus because you can. An octopus1726is a valid thing to do and often makes it easier to view the1727commit history if you are pulling more than two independent1728changes at the same time. However, if you have merge conflicts1729with any of the branches you are merging in and need to hand1730resolve, that is an indication that the development happened in1731those branches were not independent after all, and you should1732merge two at a time, documenting how you resolved the conflicts,1733and the reason why you preferred changes made in one side over1734the other. Otherwise it would make the project history harder1735to follow, not easier.17361737[ to be continued.. cvsimports ]