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