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