1gitcore-tutorial(7) 2=================== 3 4NAME 5---- 6gitcore-tutorial - A Git core tutorial for developers 7 8SYNOPSIS 9-------- 10git * 11 12DESCRIPTION 13----------- 14 15This tutorial explains how to use the "core" Git commands to set up and 16work with a Git repository. 17 18If you just need to use Git as a revision control system you may prefer 19to start with "A Tutorial Introduction to Git" (linkgit:gittutorial[7]) or 20link:user-manual.html[the Git User Manual]. 21 22However, an understanding of these low-level tools can be helpful if 23you want to understand Git's internals. 24 25The core Git is often called "plumbing", with the prettier user 26interfaces on top of it called "porcelain". You may not want to use the 27plumbing directly very often, but it can be good to know what the 28plumbing does for when the porcelain isn't flushing. 29 30Back when this document was originally written, many porcelain 31commands were shell scripts. For simplicity, it still uses them as 32examples to illustrate how plumbing is fit together to form the 33porcelain commands. The source tree includes some of these scripts in 34contrib/examples/ for reference. Although these are not implemented as 35shell scripts anymore, the description of what the plumbing layer 36commands do is still valid. 37 38[NOTE] 39Deeper technical details are often marked as Notes, which you can 40skip on your first reading. 41 42 43Creating a Git repository 44------------------------- 45 46Creating a new Git repository couldn't be easier: all Git repositories start 47out empty, and the only thing you need to do is find yourself a 48subdirectory that you want to use as a working tree - either an empty 49one for a totally new project, or an existing working tree that you want 50to import into Git. 51 52For our first example, we're going to start a totally new repository from 53scratch, with no pre-existing files, and we'll call it 'git-tutorial'. 54To start up, create a subdirectory for it, change into that 55subdirectory, and initialize the Git infrastructure with 'git init': 56 57------------------------------------------------ 58$ mkdir git-tutorial 59$ cd git-tutorial 60$ git init 61------------------------------------------------ 62 63to which Git will reply 64 65---------------- 66Initialized empty Git repository in .git/ 67---------------- 68 69which is just Git's way of saying that you haven't been doing anything 70strange, and that it will have created a local `.git` directory setup for 71your new project. You will now have a `.git` directory, and you can 72inspect that with 'ls'. For your new empty project, it should show you 73three entries, among other things: 74 75 - a file called `HEAD`, that has `ref: refs/heads/master` in it. 76 This is similar to a symbolic link and points at 77 `refs/heads/master` relative to the `HEAD` file. 78+ 79Don't worry about the fact that the file that the `HEAD` link points to 80doesn't even exist yet -- you haven't created the commit that will 81start your `HEAD` development branch yet. 82 83 - a subdirectory called `objects`, which will contain all the 84 objects of your project. You should never have any real reason to 85 look at the objects directly, but you might want to know that these 86 objects are what contains all the real 'data' in your repository. 87 88 - a subdirectory called `refs`, which contains references to objects. 89 90In particular, the `refs` subdirectory will contain two other 91subdirectories, named `heads` and `tags` respectively. They do 92exactly what their names imply: they contain references to any number 93of different 'heads' of development (aka 'branches'), and to any 94'tags' that you have created to name specific versions in your 95repository. 96 97One note: the special `master` head is the default branch, which is 98why the `.git/HEAD` file was created points to it even if it 99doesn't yet exist. Basically, the `HEAD` link is supposed to always 100point to the branch you are working on right now, and you always 101start out expecting to work on the `master` branch. 102 103However, this is only a convention, and you can name your branches 104anything you want, and don't have to ever even 'have' a `master` 105branch. A number of the Git tools will assume that `.git/HEAD` is 106valid, though. 107 108[NOTE] 109An 'object' is identified by its 160-bit SHA-1 hash, aka 'object name', 110and a reference to an object is always the 40-byte hex 111representation of that SHA-1 name. The files in the `refs` 112subdirectory are expected to contain these hex references 113(usually with a final `\n` at the end), and you should thus 114expect to see a number of 41-byte files containing these 115references in these `refs` subdirectories when you actually start 116populating your tree. 117 118[NOTE] 119An advanced user may want to take a look at linkgit:gitrepository-layout[5] 120after finishing this tutorial. 121 122You have now created your first Git repository. Of course, since it's 123empty, that's not very useful, so let's start populating it with data. 124 125 126Populating a Git repository 127--------------------------- 128 129We'll keep this simple and stupid, so we'll start off with populating a 130few trivial files just to get a feel for it. 131 132Start off with just creating any random files that you want to maintain 133in your Git repository. We'll start off with a few bad examples, just to 134get a feel for how this works: 135 136------------------------------------------------ 137$ echo "Hello World" >hello 138$ echo "Silly example" >example 139------------------------------------------------ 140 141you have now created two files in your working tree (aka 'working directory'), 142but to actually check in your hard work, you will have to go through two steps: 143 144 - fill in the 'index' file (aka 'cache') with the information about your 145 working tree state. 146 147 - commit that index file as an object. 148 149The first step is trivial: when you want to tell Git about any changes 150to your working tree, you use the 'git update-index' program. That 151program normally just takes a list of filenames you want to update, but 152to avoid trivial mistakes, it refuses to add new entries to the index 153(or remove existing ones) unless you explicitly tell it that you're 154adding a new entry with the `--add` flag (or removing an entry with the 155`--remove`) flag. 156 157So to populate the index with the two files you just created, you can do 158 159------------------------------------------------ 160$ git update-index --add hello example 161------------------------------------------------ 162 163and you have now told Git to track those two files. 164 165In fact, as you did that, if you now look into your object directory, 166you'll notice that Git will have added two new objects to the object 167database. If you did exactly the steps above, you should now be able to do 168 169 170---------------- 171$ ls .git/objects/??/* 172---------------- 173 174and see two files: 175 176---------------- 177.git/objects/55/7db03de997c86a4a028e1ebd3a1ceb225be238 178.git/objects/f2/4c74a2e500f5ee1332c86b94199f52b1d1d962 179---------------- 180 181which correspond with the objects with names of `557db...` and 182`f24c7...` respectively. 183 184If you want to, you can use 'git cat-file' to look at those objects, but 185you'll have to use the object name, not the filename of the object: 186 187---------------- 188$ git cat-file -t 557db03de997c86a4a028e1ebd3a1ceb225be238 189---------------- 190 191where the `-t` tells 'git cat-file' to tell you what the "type" of the 192object is. Git will tell you that you have a "blob" object (i.e., just a 193regular file), and you can see the contents with 194 195---------------- 196$ git cat-file blob 557db03 197---------------- 198 199which will print out "Hello World". The object `557db03` is nothing 200more than the contents of your file `hello`. 201 202[NOTE] 203Don't confuse that object with the file `hello` itself. The 204object is literally just those specific *contents* of the file, and 205however much you later change the contents in file `hello`, the object 206we just looked at will never change. Objects are immutable. 207 208[NOTE] 209The second example demonstrates that you can 210abbreviate the object name to only the first several 211hexadecimal digits in most places. 212 213Anyway, as we mentioned previously, you normally never actually take a 214look at the objects themselves, and typing long 40-character hex 215names is not something you'd normally want to do. The above digression 216was just to show that 'git update-index' did something magical, and 217actually saved away the contents of your files into the Git object 218database. 219 220Updating the index did something else too: it created a `.git/index` 221file. This is the index that describes your current working tree, and 222something you should be very aware of. Again, you normally never worry 223about the index file itself, but you should be aware of the fact that 224you have not actually really "checked in" your files into Git so far, 225you've only *told* Git about them. 226 227However, since Git knows about them, you can now start using some of the 228most basic Git commands to manipulate the files or look at their status. 229 230In particular, let's not even check in the two files into Git yet, we'll 231start off by adding another line to `hello` first: 232 233------------------------------------------------ 234$ echo "It's a new day for git" >>hello 235------------------------------------------------ 236 237and you can now, since you told Git about the previous state of `hello`, ask 238Git what has changed in the tree compared to your old index, using the 239'git diff-files' command: 240 241------------ 242$ git diff-files 243------------ 244 245Oops. That wasn't very readable. It just spit out its own internal 246version of a 'diff', but that internal version really just tells you 247that it has noticed that "hello" has been modified, and that the old object 248contents it had have been replaced with something else. 249 250To make it readable, we can tell 'git diff-files' to output the 251differences as a patch, using the `-p` flag: 252 253------------ 254$ git diff-files -p 255diff --git a/hello b/hello 256index 557db03..263414f 100644 257--- a/hello 258+++ b/hello 259@@ -1 +1,2 @@ 260 Hello World 261+It's a new day for git 262---- 263 264i.e. the diff of the change we caused by adding another line to `hello`. 265 266In other words, 'git diff-files' always shows us the difference between 267what is recorded in the index, and what is currently in the working 268tree. That's very useful. 269 270A common shorthand for `git diff-files -p` is to just write `git 271diff`, which will do the same thing. 272 273------------ 274$ git diff 275diff --git a/hello b/hello 276index 557db03..263414f 100644 277--- a/hello 278+++ b/hello 279@@ -1 +1,2 @@ 280 Hello World 281+It's a new day for git 282------------ 283 284 285Committing Git state 286-------------------- 287 288Now, we want to go to the next stage in Git, which is to take the files 289that Git knows about in the index, and commit them as a real tree. We do 290that in two phases: creating a 'tree' object, and committing that 'tree' 291object as a 'commit' object together with an explanation of what the 292tree was all about, along with information of how we came to that state. 293 294Creating a tree object is trivial, and is done with 'git write-tree'. 295There are no options or other input: `git write-tree` will take the 296current index state, and write an object that describes that whole 297index. In other words, we're now tying together all the different 298filenames with their contents (and their permissions), and we're 299creating the equivalent of a Git "directory" object: 300 301------------------------------------------------ 302$ git write-tree 303------------------------------------------------ 304 305and this will just output the name of the resulting tree, in this case 306(if you have done exactly as I've described) it should be 307 308---------------- 3098988da15d077d4829fc51d8544c097def6644dbb 310---------------- 311 312which is another incomprehensible object name. Again, if you want to, 313you can use `git cat-file -t 8988d...` to see that this time the object 314is not a "blob" object, but a "tree" object (you can also use 315`git cat-file` to actually output the raw object contents, but you'll see 316mainly a binary mess, so that's less interesting). 317 318However -- normally you'd never use 'git write-tree' on its own, because 319normally you always commit a tree into a commit object using the 320'git commit-tree' command. In fact, it's easier to not actually use 321'git write-tree' on its own at all, but to just pass its result in as an 322argument to 'git commit-tree'. 323 324'git commit-tree' normally takes several arguments -- it wants to know 325what the 'parent' of a commit was, but since this is the first commit 326ever in this new repository, and it has no parents, we only need to pass in 327the object name of the tree. However, 'git commit-tree' also wants to get a 328commit message on its standard input, and it will write out the resulting 329object name for the commit to its standard output. 330 331And this is where we create the `.git/refs/heads/master` file 332which is pointed at by `HEAD`. This file is supposed to contain 333the reference to the top-of-tree of the master branch, and since 334that's exactly what 'git commit-tree' spits out, we can do this 335all with a sequence of simple shell commands: 336 337------------------------------------------------ 338$ tree=$(git write-tree) 339$ commit=$(echo 'Initial commit' | git commit-tree $tree) 340$ git update-ref HEAD $commit 341------------------------------------------------ 342 343In this case this creates a totally new commit that is not related to 344anything else. Normally you do this only *once* for a project ever, and 345all later commits will be parented on top of an earlier commit. 346 347Again, normally you'd never actually do this by hand. There is a 348helpful script called `git commit` that will do all of this for you. So 349you could have just written `git commit` 350instead, and it would have done the above magic scripting for you. 351 352 353Making a change 354--------------- 355 356Remember how we did the 'git update-index' on file `hello` and then we 357changed `hello` afterward, and could compare the new state of `hello` with the 358state we saved in the index file? 359 360Further, remember how I said that 'git write-tree' writes the contents 361of the *index* file to the tree, and thus what we just committed was in 362fact the *original* contents of the file `hello`, not the new ones. We did 363that on purpose, to show the difference between the index state, and the 364state in the working tree, and how they don't have to match, even 365when we commit things. 366 367As before, if we do `git diff-files -p` in our git-tutorial project, 368we'll still see the same difference we saw last time: the index file 369hasn't changed by the act of committing anything. However, now that we 370have committed something, we can also learn to use a new command: 371'git diff-index'. 372 373Unlike 'git diff-files', which showed the difference between the index 374file and the working tree, 'git diff-index' shows the differences 375between a committed *tree* and either the index file or the working 376tree. In other words, 'git diff-index' wants a tree to be diffed 377against, and before we did the commit, we couldn't do that, because we 378didn't have anything to diff against. 379 380But now we can do 381 382---------------- 383$ git diff-index -p HEAD 384---------------- 385 386(where `-p` has the same meaning as it did in 'git diff-files'), and it 387will show us the same difference, but for a totally different reason. 388Now we're comparing the working tree not against the index file, 389but against the tree we just wrote. It just so happens that those two 390are obviously the same, so we get the same result. 391 392Again, because this is a common operation, you can also just shorthand 393it with 394 395---------------- 396$ git diff HEAD 397---------------- 398 399which ends up doing the above for you. 400 401In other words, 'git diff-index' normally compares a tree against the 402working tree, but when given the `--cached` flag, it is told to 403instead compare against just the index cache contents, and ignore the 404current working tree state entirely. Since we just wrote the index 405file to HEAD, doing `git diff-index --cached -p HEAD` should thus return 406an empty set of differences, and that's exactly what it does. 407 408[NOTE] 409================ 410'git diff-index' really always uses the index for its 411comparisons, and saying that it compares a tree against the working 412tree is thus not strictly accurate. In particular, the list of 413files to compare (the "meta-data") *always* comes from the index file, 414regardless of whether the `--cached` flag is used or not. The `--cached` 415flag really only determines whether the file *contents* to be compared 416come from the working tree or not. 417 418This is not hard to understand, as soon as you realize that Git simply 419never knows (or cares) about files that it is not told about 420explicitly. Git will never go *looking* for files to compare, it 421expects you to tell it what the files are, and that's what the index 422is there for. 423================ 424 425However, our next step is to commit the *change* we did, and again, to 426understand what's going on, keep in mind the difference between "working 427tree contents", "index file" and "committed tree". We have changes 428in the working tree that we want to commit, and we always have to 429work through the index file, so the first thing we need to do is to 430update the index cache: 431 432------------------------------------------------ 433$ git update-index hello 434------------------------------------------------ 435 436(note how we didn't need the `--add` flag this time, since Git knew 437about the file already). 438 439Note what happens to the different 'git diff-{asterisk}' versions here. 440After we've updated `hello` in the index, `git diff-files -p` now shows no 441differences, but `git diff-index -p HEAD` still *does* show that the 442current state is different from the state we committed. In fact, now 443'git diff-index' shows the same difference whether we use the `--cached` 444flag or not, since now the index is coherent with the working tree. 445 446Now, since we've updated `hello` in the index, we can commit the new 447version. We could do it by writing the tree by hand again, and 448committing the tree (this time we'd have to use the `-p HEAD` flag to 449tell commit that the HEAD was the *parent* of the new commit, and that 450this wasn't an initial commit any more), but you've done that once 451already, so let's just use the helpful script this time: 452 453------------------------------------------------ 454$ git commit 455------------------------------------------------ 456 457which starts an editor for you to write the commit message and tells you 458a bit about what you have done. 459 460Write whatever message you want, and all the lines that start with '#' 461will be pruned out, and the rest will be used as the commit message for 462the change. If you decide you don't want to commit anything after all at 463this point (you can continue to edit things and update the index), you 464can just leave an empty message. Otherwise `git commit` will commit 465the change for you. 466 467You've now made your first real Git commit. And if you're interested in 468looking at what `git commit` really does, feel free to investigate: 469it's a few very simple shell scripts to generate the helpful (?) commit 470message headers, and a few one-liners that actually do the 471commit itself ('git commit'). 472 473 474Inspecting Changes 475------------------ 476 477While creating changes is useful, it's even more useful if you can tell 478later what changed. The most useful command for this is another of the 479'diff' family, namely 'git diff-tree'. 480 481'git diff-tree' can be given two arbitrary trees, and it will tell you the 482differences between them. Perhaps even more commonly, though, you can 483give it just a single commit object, and it will figure out the parent 484of that commit itself, and show the difference directly. Thus, to get 485the same diff that we've already seen several times, we can now do 486 487---------------- 488$ git diff-tree -p HEAD 489---------------- 490 491(again, `-p` means to show the difference as a human-readable patch), 492and it will show what the last commit (in `HEAD`) actually changed. 493 494[NOTE] 495============ 496Here is an ASCII art by Jon Loeliger that illustrates how 497various 'diff-{asterisk}' commands compare things. 498 499 diff-tree 500 +----+ 501 | | 502 | | 503 V V 504 +-----------+ 505 | Object DB | 506 | Backing | 507 | Store | 508 +-----------+ 509 ^ ^ 510 | | 511 | | diff-index --cached 512 | | 513 diff-index | V 514 | +-----------+ 515 | | Index | 516 | | "cache" | 517 | +-----------+ 518 | ^ 519 | | 520 | | diff-files 521 | | 522 V V 523 +-----------+ 524 | Working | 525 | Directory | 526 +-----------+ 527============ 528 529More interestingly, you can also give 'git diff-tree' the `--pretty` flag, 530which tells it to also show the commit message and author and date of the 531commit, and you can tell it to show a whole series of diffs. 532Alternatively, you can tell it to be "silent", and not show the diffs at 533all, but just show the actual commit message. 534 535In fact, together with the 'git rev-list' program (which generates a 536list of revisions), 'git diff-tree' ends up being a veritable fount of 537changes. You can emulate `git log`, `git log -p`, etc. with a trivial 538script that pipes the output of `git rev-list` to `git diff-tree --stdin`, 539which was exactly how early versions of `git log` were implemented. 540 541 542Tagging a version 543----------------- 544 545In Git, there are two kinds of tags, a "light" one, and an "annotated tag". 546 547A "light" tag is technically nothing more than a branch, except we put 548it in the `.git/refs/tags/` subdirectory instead of calling it a `head`. 549So the simplest form of tag involves nothing more than 550 551------------------------------------------------ 552$ git tag my-first-tag 553------------------------------------------------ 554 555which just writes the current `HEAD` into the `.git/refs/tags/my-first-tag` 556file, after which point you can then use this symbolic name for that 557particular state. You can, for example, do 558 559---------------- 560$ git diff my-first-tag 561---------------- 562 563to diff your current state against that tag which at this point will 564obviously be an empty diff, but if you continue to develop and commit 565stuff, you can use your tag as an "anchor-point" to see what has changed 566since you tagged it. 567 568An "annotated tag" is actually a real Git object, and contains not only a 569pointer to the state you want to tag, but also a small tag name and 570message, along with optionally a PGP signature that says that yes, 571you really did 572that tag. You create these annotated tags with either the `-a` or 573`-s` flag to 'git tag': 574 575---------------- 576$ git tag -s <tagname> 577---------------- 578 579which will sign the current `HEAD` (but you can also give it another 580argument that specifies the thing to tag, e.g., you could have tagged the 581current `mybranch` point by using `git tag <tagname> mybranch`). 582 583You normally only do signed tags for major releases or things 584like that, while the light-weight tags are useful for any marking you 585want to do -- any time you decide that you want to remember a certain 586point, just create a private tag for it, and you have a nice symbolic 587name for the state at that point. 588 589 590Copying repositories 591-------------------- 592 593Git repositories are normally totally self-sufficient and relocatable. 594Unlike CVS, for example, there is no separate notion of 595"repository" and "working tree". A Git repository normally *is* the 596working tree, with the local Git information hidden in the `.git` 597subdirectory. There is nothing else. What you see is what you got. 598 599[NOTE] 600You can tell Git to split the Git internal information from 601the directory that it tracks, but we'll ignore that for now: it's not 602how normal projects work, and it's really only meant for special uses. 603So the mental model of "the Git information is always tied directly to 604the working tree that it describes" may not be technically 100% 605accurate, but it's a good model for all normal use. 606 607This has two implications: 608 609 - if you grow bored with the tutorial repository you created (or you've 610 made a mistake and want to start all over), you can just do simple 611+ 612---------------- 613$ rm -rf git-tutorial 614---------------- 615+ 616and it will be gone. There's no external repository, and there's no 617history outside the project you created. 618 619 - if you want to move or duplicate a Git repository, you can do so. There 620 is 'git clone' command, but if all you want to do is just to 621 create a copy of your repository (with all the full history that 622 went along with it), you can do so with a regular 623 `cp -a git-tutorial new-git-tutorial`. 624+ 625Note that when you've moved or copied a Git repository, your Git index 626file (which caches various information, notably some of the "stat" 627information for the files involved) will likely need to be refreshed. 628So after you do a `cp -a` to create a new copy, you'll want to do 629+ 630---------------- 631$ git update-index --refresh 632---------------- 633+ 634in the new repository to make sure that the index file is up-to-date. 635 636Note that the second point is true even across machines. You can 637duplicate a remote Git repository with *any* regular copy mechanism, be it 638'scp', 'rsync' or 'wget'. 639 640When copying a remote repository, you'll want to at a minimum update the 641index cache when you do this, and especially with other peoples' 642repositories you often want to make sure that the index cache is in some 643known state (you don't know *what* they've done and not yet checked in), 644so usually you'll precede the 'git update-index' with a 645 646---------------- 647$ git read-tree --reset HEAD 648$ git update-index --refresh 649---------------- 650 651which will force a total index re-build from the tree pointed to by `HEAD`. 652It resets the index contents to `HEAD`, and then the 'git update-index' 653makes sure to match up all index entries with the checked-out files. 654If the original repository had uncommitted changes in its 655working tree, `git update-index --refresh` notices them and 656tells you they need to be updated. 657 658The above can also be written as simply 659 660---------------- 661$ git reset 662---------------- 663 664and in fact a lot of the common Git command combinations can be scripted 665with the `git xyz` interfaces. You can learn things by just looking 666at what the various git scripts do. For example, `git reset` used to be 667the above two lines implemented in 'git reset', but some things like 668'git status' and 'git commit' are slightly more complex scripts around 669the basic Git commands. 670 671Many (most?) public remote repositories will not contain any of 672the checked out files or even an index file, and will *only* contain the 673actual core Git files. Such a repository usually doesn't even have the 674`.git` subdirectory, but has all the Git files directly in the 675repository. 676 677To create your own local live copy of such a "raw" Git repository, you'd 678first create your own subdirectory for the project, and then copy the 679raw repository contents into the `.git` directory. For example, to 680create your own copy of the Git repository, you'd do the following 681 682---------------- 683$ mkdir my-git 684$ cd my-git 685$ rsync -rL rsync://rsync.kernel.org/pub/scm/git/git.git/ .git 686---------------- 687 688followed by 689 690---------------- 691$ git read-tree HEAD 692---------------- 693 694to populate the index. However, now you have populated the index, and 695you have all the Git internal files, but you will notice that you don't 696actually have any of the working tree files to work on. To get 697those, you'd check them out with 698 699---------------- 700$ git checkout-index -u -a 701---------------- 702 703where the `-u` flag means that you want the checkout to keep the index 704up-to-date (so that you don't have to refresh it afterward), and the 705`-a` flag means "check out all files" (if you have a stale copy or an 706older version of a checked out tree you may also need to add the `-f` 707flag first, to tell 'git checkout-index' to *force* overwriting of any old 708files). 709 710Again, this can all be simplified with 711 712---------------- 713$ git clone rsync://rsync.kernel.org/pub/scm/git/git.git/ my-git 714$ cd my-git 715$ git checkout 716---------------- 717 718which will end up doing all of the above for you. 719 720You have now successfully copied somebody else's (mine) remote 721repository, and checked it out. 722 723 724Creating a new branch 725--------------------- 726 727Branches in Git are really nothing more than pointers into the Git 728object database from within the `.git/refs/` subdirectory, and as we 729already discussed, the `HEAD` branch is nothing but a symlink to one of 730these object pointers. 731 732You can at any time create a new branch by just picking an arbitrary 733point in the project history, and just writing the SHA-1 name of that 734object into a file under `.git/refs/heads/`. You can use any filename you 735want (and indeed, subdirectories), but the convention is that the 736"normal" branch is called `master`. That's just a convention, though, 737and nothing enforces it. 738 739To show that as an example, let's go back to the git-tutorial repository we 740used earlier, and create a branch in it. You do that by simply just 741saying that you want to check out a new branch: 742 743------------ 744$ git checkout -b mybranch 745------------ 746 747will create a new branch based at the current `HEAD` position, and switch 748to it. 749 750[NOTE] 751================================================ 752If you make the decision to start your new branch at some 753other point in the history than the current `HEAD`, you can do so by 754just telling 'git checkout' what the base of the checkout would be. 755In other words, if you have an earlier tag or branch, you'd just do 756 757------------ 758$ git checkout -b mybranch earlier-commit 759------------ 760 761and it would create the new branch `mybranch` at the earlier commit, 762and check out the state at that time. 763================================================ 764 765You can always just jump back to your original `master` branch by doing 766 767------------ 768$ git checkout master 769------------ 770 771(or any other branch-name, for that matter) and if you forget which 772branch you happen to be on, a simple 773 774------------ 775$ cat .git/HEAD 776------------ 777 778will tell you where it's pointing. To get the list of branches 779you have, you can say 780 781------------ 782$ git branch 783------------ 784 785which used to be nothing more than a simple script around `ls .git/refs/heads`. 786There will be an asterisk in front of the branch you are currently on. 787 788Sometimes you may wish to create a new branch _without_ actually 789checking it out and switching to it. If so, just use the command 790 791------------ 792$ git branch <branchname> [startingpoint] 793------------ 794 795which will simply _create_ the branch, but will not do anything further. 796You can then later -- once you decide that you want to actually develop 797on that branch -- switch to that branch with a regular 'git checkout' 798with the branchname as the argument. 799 800 801Merging two branches 802-------------------- 803 804One of the ideas of having a branch is that you do some (possibly 805experimental) work in it, and eventually merge it back to the main 806branch. So assuming you created the above `mybranch` that started out 807being the same as the original `master` branch, let's make sure we're in 808that branch, and do some work there. 809 810------------------------------------------------ 811$ git checkout mybranch 812$ echo "Work, work, work" >>hello 813$ git commit -m "Some work." -i hello 814------------------------------------------------ 815 816Here, we just added another line to `hello`, and we used a shorthand for 817doing both `git update-index hello` and `git commit` by just giving the 818filename directly to `git commit`, with an `-i` flag (it tells 819Git to 'include' that file in addition to what you have done to 820the index file so far when making the commit). The `-m` flag is to give the 821commit log message from the command line. 822 823Now, to make it a bit more interesting, let's assume that somebody else 824does some work in the original branch, and simulate that by going back 825to the master branch, and editing the same file differently there: 826 827------------ 828$ git checkout master 829------------ 830 831Here, take a moment to look at the contents of `hello`, and notice how they 832don't contain the work we just did in `mybranch` -- because that work 833hasn't happened in the `master` branch at all. Then do 834 835------------ 836$ echo "Play, play, play" >>hello 837$ echo "Lots of fun" >>example 838$ git commit -m "Some fun." -i hello example 839------------ 840 841since the master branch is obviously in a much better mood. 842 843Now, you've got two branches, and you decide that you want to merge the 844work done. Before we do that, let's introduce a cool graphical tool that 845helps you view what's going on: 846 847---------------- 848$ gitk --all 849---------------- 850 851will show you graphically both of your branches (that's what the `--all` 852means: normally it will just show you your current `HEAD`) and their 853histories. You can also see exactly how they came to be from a common 854source. 855 856Anyway, let's exit 'gitk' (`^Q` or the File menu), and decide that we want 857to merge the work we did on the `mybranch` branch into the `master` 858branch (which is currently our `HEAD` too). To do that, there's a nice 859script called 'git merge', which wants to know which branches you want 860to resolve and what the merge is all about: 861 862------------ 863$ git merge -m "Merge work in mybranch" mybranch 864------------ 865 866where the first argument is going to be used as the commit message if 867the merge can be resolved automatically. 868 869Now, in this case we've intentionally created a situation where the 870merge will need to be fixed up by hand, though, so Git will do as much 871of it as it can automatically (which in this case is just merge the `example` 872file, which had no differences in the `mybranch` branch), and say: 873 874---------------- 875 Auto-merging hello 876 CONFLICT (content): Merge conflict in hello 877 Automatic merge failed; fix conflicts and then commit the result. 878---------------- 879 880It tells you that it did an "Automatic merge", which 881failed due to conflicts in `hello`. 882 883Not to worry. It left the (trivial) conflict in `hello` in the same form you 884should already be well used to if you've ever used CVS, so let's just 885open `hello` in our editor (whatever that may be), and fix it up somehow. 886I'd suggest just making it so that `hello` contains all four lines: 887 888------------ 889Hello World 890It's a new day for git 891Play, play, play 892Work, work, work 893------------ 894 895and once you're happy with your manual merge, just do a 896 897------------ 898$ git commit -i hello 899------------ 900 901which will very loudly warn you that you're now committing a merge 902(which is correct, so never mind), and you can write a small merge 903message about your adventures in 'git merge'-land. 904 905After you're done, start up `gitk --all` to see graphically what the 906history looks like. Notice that `mybranch` still exists, and you can 907switch to it, and continue to work with it if you want to. The 908`mybranch` branch will not contain the merge, but next time you merge it 909from the `master` branch, Git will know how you merged it, so you'll not 910have to do _that_ merge again. 911 912Another useful tool, especially if you do not always work in X-Window 913environment, is `git show-branch`. 914 915------------------------------------------------ 916$ git show-branch --topo-order --more=1 master mybranch 917* [master] Merge work in mybranch 918 ! [mybranch] Some work. 919-- 920- [master] Merge work in mybranch 921*+ [mybranch] Some work. 922* [master^] Some fun. 923------------------------------------------------ 924 925The first two lines indicate that it is showing the two branches 926with the titles of their top-of-the-tree commits, you are currently on 927`master` branch (notice the asterisk `*` character), and the first 928column for the later output lines is used to show commits contained in the 929`master` branch, and the second column for the `mybranch` 930branch. Three commits are shown along with their titles. 931All of them have non blank characters in the first column (`*` 932shows an ordinary commit on the current branch, `-` is a merge commit), which 933means they are now part of the `master` branch. Only the "Some 934work" commit has the plus `+` character in the second column, 935because `mybranch` has not been merged to incorporate these 936commits from the master branch. The string inside brackets 937before the commit log message is a short name you can use to 938name the commit. In the above example, 'master' and 'mybranch' 939are branch heads. 'master^' is the first parent of 'master' 940branch head. Please see linkgit:gitrevisions[7] if you want to 941see more complex cases. 942 943[NOTE] 944Without the '--more=1' option, 'git show-branch' would not output the 945'[master^]' commit, as '[mybranch]' commit is a common ancestor of 946both 'master' and 'mybranch' tips. Please see linkgit:git-show-branch[1] 947for details. 948 949[NOTE] 950If there were more commits on the 'master' branch after the merge, the 951merge commit itself would not be shown by 'git show-branch' by 952default. You would need to provide '--sparse' option to make the 953merge commit visible in this case. 954 955Now, let's pretend you are the one who did all the work in 956`mybranch`, and the fruit of your hard work has finally been merged 957to the `master` branch. Let's go back to `mybranch`, and run 958'git merge' to get the "upstream changes" back to your branch. 959 960------------ 961$ git checkout mybranch 962$ git merge -m "Merge upstream changes." master 963------------ 964 965This outputs something like this (the actual commit object names 966would be different) 967 968---------------- 969Updating from ae3a2da... to a80b4aa.... 970Fast-forward (no commit created; -m option ignored) 971 example | 1 + 972 hello | 1 + 973 2 files changed, 2 insertions(+) 974---------------- 975 976Because your branch did not contain anything more than what had 977already been merged into the `master` branch, the merge operation did 978not actually do a merge. Instead, it just updated the top of 979the tree of your branch to that of the `master` branch. This is 980often called 'fast-forward' merge. 981 982You can run `gitk --all` again to see how the commit ancestry 983looks like, or run 'show-branch', which tells you this. 984 985------------------------------------------------ 986$ git show-branch master mybranch 987! [master] Merge work in mybranch 988 * [mybranch] Merge work in mybranch 989-- 990-- [master] Merge work in mybranch 991------------------------------------------------ 992 993 994Merging external work 995--------------------- 996 997It's usually much more common that you merge with somebody else than 998merging with your own branches, so it's worth pointing out that Git 999makes that very easy too, and in fact, it's not that different from1000doing a 'git merge'. In fact, a remote merge ends up being nothing1001more than "fetch the work from a remote repository into a temporary tag"1002followed by a 'git merge'.10031004Fetching from a remote repository is done by, unsurprisingly,1005'git fetch':10061007----------------1008$ git fetch <remote-repository>1009----------------10101011One of the following transports can be used to name the1012repository to download from:10131014Rsync::1015 `rsync://remote.machine/path/to/repo.git/`1016+1017Rsync transport is usable for both uploading and downloading,1018but is completely unaware of what git does, and can produce1019unexpected results when you download from the public repository1020while the repository owner is uploading into it via `rsync`1021transport. Most notably, it could update the files under1022`refs/` which holds the object name of the topmost commits1023before uploading the files in `objects/` -- the downloader would1024obtain head commit object name while that object itself is still1025not available in the repository. For this reason, it is1026considered deprecated.10271028SSH::1029 `remote.machine:/path/to/repo.git/` or1030+1031`ssh://remote.machine/path/to/repo.git/`1032+1033This transport can be used for both uploading and downloading,1034and requires you to have a log-in privilege over `ssh` to the1035remote machine. It finds out the set of objects the other side1036lacks by exchanging the head commits both ends have and1037transfers (close to) minimum set of objects. It is by far the1038most efficient way to exchange Git objects between repositories.10391040Local directory::1041 `/path/to/repo.git/`1042+1043This transport is the same as SSH transport but uses 'sh' to run1044both ends on the local machine instead of running other end on1045the remote machine via 'ssh'.10461047Git Native::1048 `git://remote.machine/path/to/repo.git/`1049+1050This transport was designed for anonymous downloading. Like SSH1051transport, it finds out the set of objects the downstream side1052lacks and transfers (close to) minimum set of objects.10531054HTTP(S)::1055 `http://remote.machine/path/to/repo.git/`1056+1057Downloader from http and https URL1058first obtains the topmost commit object name from the remote site1059by looking at the specified refname under `repo.git/refs/` directory,1060and then tries to obtain the1061commit object by downloading from `repo.git/objects/xx/xxx...`1062using the object name of that commit object. Then it reads the1063commit object to find out its parent commits and the associate1064tree object; it repeats this process until it gets all the1065necessary objects. Because of this behavior, they are1066sometimes also called 'commit walkers'.1067+1068The 'commit walkers' are sometimes also called 'dumb1069transports', because they do not require any Git aware smart1070server like Git Native transport does. Any stock HTTP server1071that does not even support directory index would suffice. But1072you must prepare your repository with 'git update-server-info'1073to help dumb transport downloaders.10741075Once you fetch from the remote repository, you `merge` that1076with your current branch.10771078However -- it's such a common thing to `fetch` and then1079immediately `merge`, that it's called `git pull`, and you can1080simply do10811082----------------1083$ git pull <remote-repository>1084----------------10851086and optionally give a branch-name for the remote end as a second1087argument.10881089[NOTE]1090You could do without using any branches at all, by1091keeping as many local repositories as you would like to have1092branches, and merging between them with 'git pull', just like1093you merge between branches. The advantage of this approach is1094that it lets you keep a set of files for each `branch` checked1095out and you may find it easier to switch back and forth if you1096juggle multiple lines of development simultaneously. Of1097course, you will pay the price of more disk usage to hold1098multiple working trees, but disk space is cheap these days.10991100It is likely that you will be pulling from the same remote1101repository from time to time. As a short hand, you can store1102the remote repository URL in the local repository's config file1103like this:11041105------------------------------------------------1106$ git config remote.linus.url http://www.kernel.org/pub/scm/git/git.git/1107------------------------------------------------11081109and use the "linus" keyword with 'git pull' instead of the full URL.11101111Examples.11121113. `git pull linus`1114. `git pull linus tag v0.99.1`11151116the above are equivalent to:11171118. `git pull http://www.kernel.org/pub/scm/git/git.git/ HEAD`1119. `git pull http://www.kernel.org/pub/scm/git/git.git/ tag v0.99.1`112011211122How does the merge work?1123------------------------11241125We said this tutorial shows what plumbing does to help you cope1126with the porcelain that isn't flushing, but we so far did not1127talk about how the merge really works. If you are following1128this tutorial the first time, I'd suggest to skip to "Publishing1129your work" section and come back here later.11301131OK, still with me? To give us an example to look at, let's go1132back to the earlier repository with "hello" and "example" file,1133and bring ourselves back to the pre-merge state:11341135------------1136$ git show-branch --more=2 master mybranch1137! [master] Merge work in mybranch1138 * [mybranch] Merge work in mybranch1139--1140-- [master] Merge work in mybranch1141+* [master^2] Some work.1142+* [master^] Some fun.1143------------11441145Remember, before running 'git merge', our `master` head was at1146"Some fun." commit, while our `mybranch` head was at "Some1147work." commit.11481149------------1150$ git checkout mybranch1151$ git reset --hard master^21152$ git checkout master1153$ git reset --hard master^1154------------11551156After rewinding, the commit structure should look like this:11571158------------1159$ git show-branch1160* [master] Some fun.1161 ! [mybranch] Some work.1162--1163* [master] Some fun.1164 + [mybranch] Some work.1165*+ [master^] Initial commit1166------------11671168Now we are ready to experiment with the merge by hand.11691170`git merge` command, when merging two branches, uses 3-way merge1171algorithm. First, it finds the common ancestor between them.1172The command it uses is 'git merge-base':11731174------------1175$ mb=$(git merge-base HEAD mybranch)1176------------11771178The command writes the commit object name of the common ancestor1179to the standard output, so we captured its output to a variable,1180because we will be using it in the next step. By the way, the common1181ancestor commit is the "Initial commit" commit in this case. You can1182tell it by:11831184------------1185$ git name-rev --name-only --tags $mb1186my-first-tag1187------------11881189After finding out a common ancestor commit, the second step is1190this:11911192------------1193$ git read-tree -m -u $mb HEAD mybranch1194------------11951196This is the same 'git read-tree' command we have already seen,1197but it takes three trees, unlike previous examples. This reads1198the contents of each tree into different 'stage' in the index1199file (the first tree goes to stage 1, the second to stage 2,1200etc.). After reading three trees into three stages, the paths1201that are the same in all three stages are 'collapsed' into stage12020. Also paths that are the same in two of three stages are1203collapsed into stage 0, taking the SHA-1 from either stage 2 or1204stage 3, whichever is different from stage 1 (i.e. only one side1205changed from the common ancestor).12061207After 'collapsing' operation, paths that are different in three1208trees are left in non-zero stages. At this point, you can1209inspect the index file with this command:12101211------------1212$ git ls-files --stage1213100644 7f8b141b65fdcee47321e399a2598a235a032422 0 example1214100644 557db03de997c86a4a028e1ebd3a1ceb225be238 1 hello1215100644 ba42a2a96e3027f3333e13ede4ccf4498c3ae942 2 hello1216100644 cc44c73eb783565da5831b4d820c962954019b69 3 hello1217------------12181219In our example of only two files, we did not have unchanged1220files so only 'example' resulted in collapsing. But in real-life1221large projects, when only a small number of files change in one commit,1222this 'collapsing' tends to trivially merge most of the paths1223fairly quickly, leaving only a handful of real changes in non-zero1224stages.12251226To look at only non-zero stages, use `--unmerged` flag:12271228------------1229$ git ls-files --unmerged1230100644 557db03de997c86a4a028e1ebd3a1ceb225be238 1 hello1231100644 ba42a2a96e3027f3333e13ede4ccf4498c3ae942 2 hello1232100644 cc44c73eb783565da5831b4d820c962954019b69 3 hello1233------------12341235The next step of merging is to merge these three versions of the1236file, using 3-way merge. This is done by giving1237'git merge-one-file' command as one of the arguments to1238'git merge-index' command:12391240------------1241$ git merge-index git-merge-one-file hello1242Auto-merging hello1243ERROR: Merge conflict in hello1244fatal: merge program failed1245------------12461247'git merge-one-file' script is called with parameters to1248describe those three versions, and is responsible to leave the1249merge results in the working tree.1250It is a fairly straightforward shell script, and1251eventually calls 'merge' program from RCS suite to perform a1252file-level 3-way merge. In this case, 'merge' detects1253conflicts, and the merge result with conflict marks is left in1254the working tree.. This can be seen if you run `ls-files1255--stage` again at this point:12561257------------1258$ git ls-files --stage1259100644 7f8b141b65fdcee47321e399a2598a235a032422 0 example1260100644 557db03de997c86a4a028e1ebd3a1ceb225be238 1 hello1261100644 ba42a2a96e3027f3333e13ede4ccf4498c3ae942 2 hello1262100644 cc44c73eb783565da5831b4d820c962954019b69 3 hello1263------------12641265This is the state of the index file and the working file after1266'git merge' returns control back to you, leaving the conflicting1267merge for you to resolve. Notice that the path `hello` is still1268unmerged, and what you see with 'git diff' at this point is1269differences since stage 2 (i.e. your version).127012711272Publishing your work1273--------------------12741275So, we can use somebody else's work from a remote repository, but1276how can *you* prepare a repository to let other people pull from1277it?12781279You do your real work in your working tree that has your1280primary repository hanging under it as its `.git` subdirectory.1281You *could* make that repository accessible remotely and ask1282people to pull from it, but in practice that is not the way1283things are usually done. A recommended way is to have a public1284repository, make it reachable by other people, and when the1285changes you made in your primary working tree are in good shape,1286update the public repository from it. This is often called1287'pushing'.12881289[NOTE]1290This public repository could further be mirrored, and that is1291how Git repositories at `kernel.org` are managed.12921293Publishing the changes from your local (private) repository to1294your remote (public) repository requires a write privilege on1295the remote machine. You need to have an SSH account there to1296run a single command, 'git-receive-pack'.12971298First, you need to create an empty repository on the remote1299machine that will house your public repository. This empty1300repository will be populated and be kept up-to-date by pushing1301into it later. Obviously, this repository creation needs to be1302done only once.13031304[NOTE]1305'git push' uses a pair of commands,1306'git send-pack' on your local machine, and 'git-receive-pack'1307on the remote machine. The communication between the two over1308the network internally uses an SSH connection.13091310Your private repository's Git directory is usually `.git`, but1311your public repository is often named after the project name,1312i.e. `<project>.git`. Let's create such a public repository for1313project `my-git`. After logging into the remote machine, create1314an empty directory:13151316------------1317$ mkdir my-git.git1318------------13191320Then, make that directory into a Git repository by running1321'git init', but this time, since its name is not the usual1322`.git`, we do things slightly differently:13231324------------1325$ GIT_DIR=my-git.git git init1326------------13271328Make sure this directory is available for others you want your1329changes to be pulled via the transport of your choice. Also1330you need to make sure that you have the 'git-receive-pack'1331program on the `$PATH`.13321333[NOTE]1334Many installations of sshd do not invoke your shell as the login1335shell when you directly run programs; what this means is that if1336your login shell is 'bash', only `.bashrc` is read and not1337`.bash_profile`. As a workaround, make sure `.bashrc` sets up1338`$PATH` so that you can run 'git-receive-pack' program.13391340[NOTE]1341If you plan to publish this repository to be accessed over http,1342you should do `mv my-git.git/hooks/post-update.sample1343my-git.git/hooks/post-update` at this point.1344This makes sure that every time you push into this1345repository, `git update-server-info` is run.13461347Your "public repository" is now ready to accept your changes.1348Come back to the machine you have your private repository. From1349there, run this command:13501351------------1352$ git push <public-host>:/path/to/my-git.git master1353------------13541355This synchronizes your public repository to match the named1356branch head (i.e. `master` in this case) and objects reachable1357from them in your current repository.13581359As a real example, this is how I update my public Git1360repository. Kernel.org mirror network takes care of the1361propagation to other publicly visible machines:13621363------------1364$ git push master.kernel.org:/pub/scm/git/git.git/1365------------136613671368Packing your repository1369-----------------------13701371Earlier, we saw that one file under `.git/objects/??/` directory1372is stored for each Git object you create. This representation1373is efficient to create atomically and safely, but1374not so convenient to transport over the network. Since Git objects are1375immutable once they are created, there is a way to optimize the1376storage by "packing them together". The command13771378------------1379$ git repack1380------------13811382will do it for you. If you followed the tutorial examples, you1383would have accumulated about 17 objects in `.git/objects/??/`1384directories by now. 'git repack' tells you how many objects it1385packed, and stores the packed file in `.git/objects/pack`1386directory.13871388[NOTE]1389You will see two files, `pack-*.pack` and `pack-*.idx`,1390in `.git/objects/pack` directory. They are closely related to1391each other, and if you ever copy them by hand to a different1392repository for whatever reason, you should make sure you copy1393them together. The former holds all the data from the objects1394in the pack, and the latter holds the index for random1395access.13961397If you are paranoid, running 'git verify-pack' command would1398detect if you have a corrupt pack, but do not worry too much.1399Our programs are always perfect ;-).14001401Once you have packed objects, you do not need to leave the1402unpacked objects that are contained in the pack file anymore.14031404------------1405$ git prune-packed1406------------14071408would remove them for you.14091410You can try running `find .git/objects -type f` before and after1411you run `git prune-packed` if you are curious. Also `git1412count-objects` would tell you how many unpacked objects are in1413your repository and how much space they are consuming.14141415[NOTE]1416`git pull` is slightly cumbersome for HTTP transport, as a1417packed repository may contain relatively few objects in a1418relatively large pack. If you expect many HTTP pulls from your1419public repository you might want to repack & prune often, or1420never.14211422If you run `git repack` again at this point, it will say1423"Nothing new to pack.". Once you continue your development and1424accumulate the changes, running `git repack` again will create a1425new pack, that contains objects created since you packed your1426repository the last time. We recommend that you pack your project1427soon after the initial import (unless you are starting your1428project from scratch), and then run `git repack` every once in a1429while, depending on how active your project is.14301431When a repository is synchronized via `git push` and `git pull`1432objects packed in the source repository are usually stored1433unpacked in the destination, unless rsync transport is used.1434While this allows you to use different packing strategies on1435both ends, it also means you may need to repack both1436repositories every once in a while.143714381439Working with Others1440-------------------14411442Although Git is a truly distributed system, it is often1443convenient to organize your project with an informal hierarchy1444of developers. Linux kernel development is run this way. There1445is a nice illustration (page 17, "Merges to Mainline") in1446http://www.xenotime.net/linux/mentor/linux-mentoring-2006.pdf[Randy Dunlap's presentation].14471448It should be stressed that this hierarchy is purely *informal*.1449There is nothing fundamental in Git that enforces the "chain of1450patch flow" this hierarchy implies. You do not have to pull1451from only one remote repository.14521453A recommended workflow for a "project lead" goes like this:145414551. Prepare your primary repository on your local machine. Your1456 work is done there.145714582. Prepare a public repository accessible to others.1459+1460If other people are pulling from your repository over dumb1461transport protocols (HTTP), you need to keep this repository1462'dumb transport friendly'. After `git init`,1463`$GIT_DIR/hooks/post-update.sample` copied from the standard templates1464would contain a call to 'git update-server-info'1465but you need to manually enable the hook with1466`mv post-update.sample post-update`. This makes sure1467'git update-server-info' keeps the necessary files up-to-date.146814693. Push into the public repository from your primary1470 repository.147114724. 'git repack' the public repository. This establishes a big1473 pack that contains the initial set of objects as the1474 baseline, and possibly 'git prune' if the transport1475 used for pulling from your repository supports packed1476 repositories.147714785. Keep working in your primary repository. Your changes1479 include modifications of your own, patches you receive via1480 e-mails, and merges resulting from pulling the "public"1481 repositories of your "subsystem maintainers".1482+1483You can repack this private repository whenever you feel like.148414856. Push your changes to the public repository, and announce it1486 to the public.148714887. Every once in a while, 'git repack' the public repository.1489 Go back to step 5. and continue working.149014911492A recommended work cycle for a "subsystem maintainer" who works1493on that project and has an own "public repository" goes like this:149414951. Prepare your work repository, by 'git clone' the public1496 repository of the "project lead". The URL used for the1497 initial cloning is stored in the remote.origin.url1498 configuration variable.149915002. Prepare a public repository accessible to others, just like1501 the "project lead" person does.150215033. Copy over the packed files from "project lead" public1504 repository to your public repository, unless the "project1505 lead" repository lives on the same machine as yours. In the1506 latter case, you can use `objects/info/alternates` file to1507 point at the repository you are borrowing from.150815094. Push into the public repository from your primary1510 repository. Run 'git repack', and possibly 'git prune' if the1511 transport used for pulling from your repository supports1512 packed repositories.151315145. Keep working in your primary repository. Your changes1515 include modifications of your own, patches you receive via1516 e-mails, and merges resulting from pulling the "public"1517 repositories of your "project lead" and possibly your1518 "sub-subsystem maintainers".1519+1520You can repack this private repository whenever you feel1521like.152215236. Push your changes to your public repository, and ask your1524 "project lead" and possibly your "sub-subsystem1525 maintainers" to pull from it.152615277. Every once in a while, 'git repack' the public repository.1528 Go back to step 5. and continue working.152915301531A recommended work cycle for an "individual developer" who does1532not have a "public" repository is somewhat different. It goes1533like this:153415351. Prepare your work repository, by 'git clone' the public1536 repository of the "project lead" (or a "subsystem1537 maintainer", if you work on a subsystem). The URL used for1538 the initial cloning is stored in the remote.origin.url1539 configuration variable.154015412. Do your work in your repository on 'master' branch.154215433. Run `git fetch origin` from the public repository of your1544 upstream every once in a while. This does only the first1545 half of `git pull` but does not merge. The head of the1546 public repository is stored in `.git/refs/remotes/origin/master`.154715484. Use `git cherry origin` to see which ones of your patches1549 were accepted, and/or use `git rebase origin` to port your1550 unmerged changes forward to the updated upstream.155115525. Use `git format-patch origin` to prepare patches for e-mail1553 submission to your upstream and send it out. Go back to1554 step 2. and continue.155515561557Working with Others, Shared Repository Style1558--------------------------------------------15591560If you are coming from CVS background, the style of cooperation1561suggested in the previous section may be new to you. You do not1562have to worry. Git supports "shared public repository" style of1563cooperation you are probably more familiar with as well.15641565See linkgit:gitcvs-migration[7] for the details.15661567Bundling your work together1568---------------------------15691570It is likely that you will be working on more than one thing at1571a time. It is easy to manage those more-or-less independent tasks1572using branches with Git.15731574We have already seen how branches work previously,1575with "fun and work" example using two branches. The idea is the1576same if there are more than two branches. Let's say you started1577out from "master" head, and have some new code in the "master"1578branch, and two independent fixes in the "commit-fix" and1579"diff-fix" branches:15801581------------1582$ git show-branch1583! [commit-fix] Fix commit message normalization.1584 ! [diff-fix] Fix rename detection.1585 * [master] Release candidate #11586---1587 + [diff-fix] Fix rename detection.1588 + [diff-fix~1] Better common substring algorithm.1589+ [commit-fix] Fix commit message normalization.1590 * [master] Release candidate #11591++* [diff-fix~2] Pretty-print messages.1592------------15931594Both fixes are tested well, and at this point, you want to merge1595in both of them. You could merge in 'diff-fix' first and then1596'commit-fix' next, like this:15971598------------1599$ git merge -m "Merge fix in diff-fix" diff-fix1600$ git merge -m "Merge fix in commit-fix" commit-fix1601------------16021603Which would result in:16041605------------1606$ git show-branch1607! [commit-fix] Fix commit message normalization.1608 ! [diff-fix] Fix rename detection.1609 * [master] Merge fix in commit-fix1610---1611 - [master] Merge fix in commit-fix1612+ * [commit-fix] Fix commit message normalization.1613 - [master~1] Merge fix in diff-fix1614 +* [diff-fix] Fix rename detection.1615 +* [diff-fix~1] Better common substring algorithm.1616 * [master~2] Release candidate #11617++* [master~3] Pretty-print messages.1618------------16191620However, there is no particular reason to merge in one branch1621first and the other next, when what you have are a set of truly1622independent changes (if the order mattered, then they are not1623independent by definition). You could instead merge those two1624branches into the current branch at once. First let's undo what1625we just did and start over. We would want to get the master1626branch before these two merges by resetting it to 'master~2':16271628------------1629$ git reset --hard master~21630------------16311632You can make sure `git show-branch` matches the state before1633those two 'git merge' you just did. Then, instead of running1634two 'git merge' commands in a row, you would merge these two1635branch heads (this is known as 'making an Octopus'):16361637------------1638$ git merge commit-fix diff-fix1639$ git show-branch1640! [commit-fix] Fix commit message normalization.1641 ! [diff-fix] Fix rename detection.1642 * [master] Octopus merge of branches 'diff-fix' and 'commit-fix'1643---1644 - [master] Octopus merge of branches 'diff-fix' and 'commit-fix'1645+ * [commit-fix] Fix commit message normalization.1646 +* [diff-fix] Fix rename detection.1647 +* [diff-fix~1] Better common substring algorithm.1648 * [master~1] Release candidate #11649++* [master~2] Pretty-print messages.1650------------16511652Note that you should not do Octopus because you can. An octopus1653is a valid thing to do and often makes it easier to view the1654commit history if you are merging more than two independent1655changes at the same time. However, if you have merge conflicts1656with any of the branches you are merging in and need to hand1657resolve, that is an indication that the development happened in1658those branches were not independent after all, and you should1659merge two at a time, documenting how you resolved the conflicts,1660and the reason why you preferred changes made in one side over1661the other. Otherwise it would make the project history harder1662to follow, not easier.16631664SEE ALSO1665--------1666linkgit:gittutorial[7],1667linkgit:gittutorial-2[7],1668linkgit:gitcvs-migration[7],1669linkgit:git-help[1],1670link:everyday.html[Everyday git],1671link:user-manual.html[The Git User's Manual]16721673GIT1674---1675Part of the linkgit:git[1] suite.