Merge branch 'jc/maint-combine-diff-pre-context' into maint
[git/dscho.git] / Documentation / user-manual.txt
blob64a820bf60ae5da8aaaac5fd72c169b8dd381c89
1 Git User's Manual (for version 1.5.3 or newer)
2 ______________________________________________
5 Git is a fast distributed revision control system.
7 This manual is designed to be readable by someone with basic UNIX
8 command-line skills, but no previous knowledge of git.
10 <<repositories-and-branches>> and <<exploring-git-history>> explain how
11 to fetch and study a project using git--read these chapters to learn how
12 to build and test a particular version of a software project, search for
13 regressions, and so on.
15 People needing to do actual development will also want to read
16 <<Developing-with-git>> and <<sharing-development>>.
18 Further chapters cover more specialized topics.
20 Comprehensive reference documentation is available through the man
21 pages.  For a command such as "git clone", just use
23 ------------------------------------------------
24 $ man git-clone
25 ------------------------------------------------
27 See also <<git-quick-start>> for a brief overview of git commands,
28 without any explanation.
30 Finally, see <<todo>> for ways that you can help make this manual more
31 complete.
34 [[repositories-and-branches]]
35 Repositories and Branches
36 =========================
38 [[how-to-get-a-git-repository]]
39 How to get a git repository
40 ---------------------------
42 It will be useful to have a git repository to experiment with as you
43 read this manual.
45 The best way to get one is by using the linkgit:git-clone[1] command to
46 download a copy of an existing repository.  If you don't already have a
47 project in mind, here are some interesting examples:
49 ------------------------------------------------
50         # git itself (approx. 10MB download):
51 $ git clone git://git.kernel.org/pub/scm/git/git.git
52         # the linux kernel (approx. 150MB download):
53 $ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git
54 ------------------------------------------------
56 The initial clone may be time-consuming for a large project, but you
57 will only need to clone once.
59 The clone command creates a new directory named after the project ("git"
60 or "linux-2.6" in the examples above).  After you cd into this
61 directory, you will see that it contains a copy of the project files,
62 called the <<def_working_tree,working tree>>, together with a special
63 top-level directory named ".git", which contains all the information
64 about the history of the project.
66 [[how-to-check-out]]
67 How to check out a different version of a project
68 -------------------------------------------------
70 Git is best thought of as a tool for storing the history of a collection
71 of files.  It stores the history as a compressed collection of
72 interrelated snapshots of the project's contents.  In git each such
73 version is called a <<def_commit,commit>>.
75 Those snapshots aren't necessarily all arranged in a single line from
76 oldest to newest; instead, work may simultaneously proceed along
77 parallel lines of development, called <<def_branch,branches>>, which may
78 merge and diverge.
80 A single git repository can track development on multiple branches.  It
81 does this by keeping a list of <<def_head,heads>> which reference the
82 latest commit on each branch; the linkgit:git-branch[1] command shows
83 you the list of branch heads:
85 ------------------------------------------------
86 $ git branch
87 * master
88 ------------------------------------------------
90 A freshly cloned repository contains a single branch head, by default
91 named "master", with the working directory initialized to the state of
92 the project referred to by that branch head.
94 Most projects also use <<def_tag,tags>>.  Tags, like heads, are
95 references into the project's history, and can be listed using the
96 linkgit:git-tag[1] command:
98 ------------------------------------------------
99 $ git tag -l
100 v2.6.11
101 v2.6.11-tree
102 v2.6.12
103 v2.6.12-rc2
104 v2.6.12-rc3
105 v2.6.12-rc4
106 v2.6.12-rc5
107 v2.6.12-rc6
108 v2.6.13
110 ------------------------------------------------
112 Tags are expected to always point at the same version of a project,
113 while heads are expected to advance as development progresses.
115 Create a new branch head pointing to one of these versions and check it
116 out using linkgit:git-checkout[1]:
118 ------------------------------------------------
119 $ git checkout -b new v2.6.13
120 ------------------------------------------------
122 The working directory then reflects the contents that the project had
123 when it was tagged v2.6.13, and linkgit:git-branch[1] shows two
124 branches, with an asterisk marking the currently checked-out branch:
126 ------------------------------------------------
127 $ git branch
128   master
129 * new
130 ------------------------------------------------
132 If you decide that you'd rather see version 2.6.17, you can modify
133 the current branch to point at v2.6.17 instead, with
135 ------------------------------------------------
136 $ git reset --hard v2.6.17
137 ------------------------------------------------
139 Note that if the current branch head was your only reference to a
140 particular point in history, then resetting that branch may leave you
141 with no way to find the history it used to point to; so use this command
142 carefully.
144 [[understanding-commits]]
145 Understanding History: Commits
146 ------------------------------
148 Every change in the history of a project is represented by a commit.
149 The linkgit:git-show[1] command shows the most recent commit on the
150 current branch:
152 ------------------------------------------------
153 $ git show
154 commit 17cf781661e6d38f737f15f53ab552f1e95960d7
155 Author: Linus Torvalds <torvalds@ppc970.osdl.org.(none)>
156 Date:   Tue Apr 19 14:11:06 2005 -0700
158     Remove duplicate getenv(DB_ENVIRONMENT) call
160     Noted by Tony Luck.
162 diff --git a/init-db.c b/init-db.c
163 index 65898fa..b002dc6 100644
164 --- a/init-db.c
165 +++ b/init-db.c
166 @@ -7,7 +7,7 @@
168  int main(int argc, char **argv)
170 -       char *sha1_dir = getenv(DB_ENVIRONMENT), *path;
171 +       char *sha1_dir, *path;
172         int len, i;
174         if (mkdir(".git", 0755) < 0) {
175 ------------------------------------------------
177 As you can see, a commit shows who made the latest change, what they
178 did, and why.
180 Every commit has a 40-hexdigit id, sometimes called the "object name" or the
181 "SHA1 id", shown on the first line of the "git show" output.  You can usually
182 refer to a commit by a shorter name, such as a tag or a branch name, but this
183 longer name can also be useful.  Most importantly, it is a globally unique
184 name for this commit: so if you tell somebody else the object name (for
185 example in email), then you are guaranteed that name will refer to the same
186 commit in their repository that it does in yours (assuming their repository
187 has that commit at all).  Since the object name is computed as a hash over the
188 contents of the commit, you are guaranteed that the commit can never change
189 without its name also changing.
191 In fact, in <<git-concepts>> we shall see that everything stored in git
192 history, including file data and directory contents, is stored in an object
193 with a name that is a hash of its contents.
195 [[understanding-reachability]]
196 Understanding history: commits, parents, and reachability
197 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
199 Every commit (except the very first commit in a project) also has a
200 parent commit which shows what happened before this commit.
201 Following the chain of parents will eventually take you back to the
202 beginning of the project.
204 However, the commits do not form a simple list; git allows lines of
205 development to diverge and then reconverge, and the point where two
206 lines of development reconverge is called a "merge".  The commit
207 representing a merge can therefore have more than one parent, with
208 each parent representing the most recent commit on one of the lines
209 of development leading to that point.
211 The best way to see how this works is using the linkgit:gitk[1]
212 command; running gitk now on a git repository and looking for merge
213 commits will help understand how the git organizes history.
215 In the following, we say that commit X is "reachable" from commit Y
216 if commit X is an ancestor of commit Y.  Equivalently, you could say
217 that Y is a descendant of X, or that there is a chain of parents
218 leading from commit Y to commit X.
220 [[history-diagrams]]
221 Understanding history: History diagrams
222 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
224 We will sometimes represent git history using diagrams like the one
225 below.  Commits are shown as "o", and the links between them with
226 lines drawn with - / and \.  Time goes left to right:
229 ................................................
230          o--o--o <-- Branch A
231         /
232  o--o--o <-- master
233         \
234          o--o--o <-- Branch B
235 ................................................
237 If we need to talk about a particular commit, the character "o" may
238 be replaced with another letter or number.
240 [[what-is-a-branch]]
241 Understanding history: What is a branch?
242 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
244 When we need to be precise, we will use the word "branch" to mean a line
245 of development, and "branch head" (or just "head") to mean a reference
246 to the most recent commit on a branch.  In the example above, the branch
247 head named "A" is a pointer to one particular commit, but we refer to
248 the line of three commits leading up to that point as all being part of
249 "branch A".
251 However, when no confusion will result, we often just use the term
252 "branch" both for branches and for branch heads.
254 [[manipulating-branches]]
255 Manipulating branches
256 ---------------------
258 Creating, deleting, and modifying branches is quick and easy; here's
259 a summary of the commands:
261 git branch::
262         list all branches
263 git branch <branch>::
264         create a new branch named <branch>, referencing the same
265         point in history as the current branch
266 git branch <branch> <start-point>::
267         create a new branch named <branch>, referencing
268         <start-point>, which may be specified any way you like,
269         including using a branch name or a tag name
270 git branch -d <branch>::
271         delete the branch <branch>; if the branch you are deleting
272         points to a commit which is not reachable from the current
273         branch, this command will fail with a warning.
274 git branch -D <branch>::
275         even if the branch points to a commit not reachable
276         from the current branch, you may know that that commit
277         is still reachable from some other branch or tag.  In that
278         case it is safe to use this command to force git to delete
279         the branch.
280 git checkout <branch>::
281         make the current branch <branch>, updating the working
282         directory to reflect the version referenced by <branch>
283 git checkout -b <new> <start-point>::
284         create a new branch <new> referencing <start-point>, and
285         check it out.
287 The special symbol "HEAD" can always be used to refer to the current
288 branch.  In fact, git uses a file named "HEAD" in the .git directory to
289 remember which branch is current:
291 ------------------------------------------------
292 $ cat .git/HEAD
293 ref: refs/heads/master
294 ------------------------------------------------
296 [[detached-head]]
297 Examining an old version without creating a new branch
298 ------------------------------------------------------
300 The git-checkout command normally expects a branch head, but will also
301 accept an arbitrary commit; for example, you can check out the commit
302 referenced by a tag:
304 ------------------------------------------------
305 $ git checkout v2.6.17
306 Note: moving to "v2.6.17" which isn't a local branch
307 If you want to create a new branch from this checkout, you may do so
308 (now or later) by using -b with the checkout command again. Example:
309   git checkout -b <new_branch_name>
310 HEAD is now at 427abfa... Linux v2.6.17
311 ------------------------------------------------
313 The HEAD then refers to the SHA1 of the commit instead of to a branch,
314 and git branch shows that you are no longer on a branch:
316 ------------------------------------------------
317 $ cat .git/HEAD
318 427abfa28afedffadfca9dd8b067eb6d36bac53f
319 $ git branch
320 * (no branch)
321   master
322 ------------------------------------------------
324 In this case we say that the HEAD is "detached".
326 This is an easy way to check out a particular version without having to
327 make up a name for the new branch.   You can still create a new branch
328 (or tag) for this version later if you decide to.
330 [[examining-remote-branches]]
331 Examining branches from a remote repository
332 -------------------------------------------
334 The "master" branch that was created at the time you cloned is a copy
335 of the HEAD in the repository that you cloned from.  That repository
336 may also have had other branches, though, and your local repository
337 keeps branches which track each of those remote branches, which you
338 can view using the "-r" option to linkgit:git-branch[1]:
340 ------------------------------------------------
341 $ git branch -r
342   origin/HEAD
343   origin/html
344   origin/maint
345   origin/man
346   origin/master
347   origin/next
348   origin/pu
349   origin/todo
350 ------------------------------------------------
352 You cannot check out these remote-tracking branches, but you can
353 examine them on a branch of your own, just as you would a tag:
355 ------------------------------------------------
356 $ git checkout -b my-todo-copy origin/todo
357 ------------------------------------------------
359 Note that the name "origin" is just the name that git uses by default
360 to refer to the repository that you cloned from.
362 [[how-git-stores-references]]
363 Naming branches, tags, and other references
364 -------------------------------------------
366 Branches, remote-tracking branches, and tags are all references to
367 commits.  All references are named with a slash-separated path name
368 starting with "refs"; the names we've been using so far are actually
369 shorthand:
371         - The branch "test" is short for "refs/heads/test".
372         - The tag "v2.6.18" is short for "refs/tags/v2.6.18".
373         - "origin/master" is short for "refs/remotes/origin/master".
375 The full name is occasionally useful if, for example, there ever
376 exists a tag and a branch with the same name.
378 (Newly created refs are actually stored in the .git/refs directory,
379 under the path given by their name.  However, for efficiency reasons
380 they may also be packed together in a single file; see
381 linkgit:git-pack-refs[1]).
383 As another useful shortcut, the "HEAD" of a repository can be referred
384 to just using the name of that repository.  So, for example, "origin"
385 is usually a shortcut for the HEAD branch in the repository "origin".
387 For the complete list of paths which git checks for references, and
388 the order it uses to decide which to choose when there are multiple
389 references with the same shorthand name, see the "SPECIFYING
390 REVISIONS" section of linkgit:git-rev-parse[1].
392 [[Updating-a-repository-with-git-fetch]]
393 Updating a repository with git fetch
394 ------------------------------------
396 Eventually the developer cloned from will do additional work in her
397 repository, creating new commits and advancing the branches to point
398 at the new commits.
400 The command "git fetch", with no arguments, will update all of the
401 remote-tracking branches to the latest version found in her
402 repository.  It will not touch any of your own branches--not even the
403 "master" branch that was created for you on clone.
405 [[fetching-branches]]
406 Fetching branches from other repositories
407 -----------------------------------------
409 You can also track branches from repositories other than the one you
410 cloned from, using linkgit:git-remote[1]:
412 -------------------------------------------------
413 $ git remote add linux-nfs git://linux-nfs.org/pub/nfs-2.6.git
414 $ git fetch linux-nfs
415 * refs/remotes/linux-nfs/master: storing branch 'master' ...
416   commit: bf81b46
417 -------------------------------------------------
419 New remote-tracking branches will be stored under the shorthand name
420 that you gave "git remote add", in this case linux-nfs:
422 -------------------------------------------------
423 $ git branch -r
424 linux-nfs/master
425 origin/master
426 -------------------------------------------------
428 If you run "git fetch <remote>" later, the tracking branches for the
429 named <remote> will be updated.
431 If you examine the file .git/config, you will see that git has added
432 a new stanza:
434 -------------------------------------------------
435 $ cat .git/config
437 [remote "linux-nfs"]
438         url = git://linux-nfs.org/pub/nfs-2.6.git
439         fetch = +refs/heads/*:refs/remotes/linux-nfs/*
441 -------------------------------------------------
443 This is what causes git to track the remote's branches; you may modify
444 or delete these configuration options by editing .git/config with a
445 text editor.  (See the "CONFIGURATION FILE" section of
446 linkgit:git-config[1] for details.)
448 [[exploring-git-history]]
449 Exploring git history
450 =====================
452 Git is best thought of as a tool for storing the history of a
453 collection of files.  It does this by storing compressed snapshots of
454 the contents of a file hierarchy, together with "commits" which show
455 the relationships between these snapshots.
457 Git provides extremely flexible and fast tools for exploring the
458 history of a project.
460 We start with one specialized tool that is useful for finding the
461 commit that introduced a bug into a project.
463 [[using-bisect]]
464 How to use bisect to find a regression
465 --------------------------------------
467 Suppose version 2.6.18 of your project worked, but the version at
468 "master" crashes.  Sometimes the best way to find the cause of such a
469 regression is to perform a brute-force search through the project's
470 history to find the particular commit that caused the problem.  The
471 linkgit:git-bisect[1] command can help you do this:
473 -------------------------------------------------
474 $ git bisect start
475 $ git bisect good v2.6.18
476 $ git bisect bad master
477 Bisecting: 3537 revisions left to test after this
478 [65934a9a028b88e83e2b0f8b36618fe503349f8e] BLOCK: Make USB storage depend on SCSI rather than selecting it [try #6]
479 -------------------------------------------------
481 If you run "git branch" at this point, you'll see that git has
482 temporarily moved you to a new branch named "bisect".  This branch
483 points to a commit (with commit id 65934...) that is reachable from
484 "master" but not from v2.6.18.  Compile and test it, and see whether
485 it crashes.  Assume it does crash.  Then:
487 -------------------------------------------------
488 $ git bisect bad
489 Bisecting: 1769 revisions left to test after this
490 [7eff82c8b1511017ae605f0c99ac275a7e21b867] i2c-core: Drop useless bitmaskings
491 -------------------------------------------------
493 checks out an older version.  Continue like this, telling git at each
494 stage whether the version it gives you is good or bad, and notice
495 that the number of revisions left to test is cut approximately in
496 half each time.
498 After about 13 tests (in this case), it will output the commit id of
499 the guilty commit.  You can then examine the commit with
500 linkgit:git-show[1], find out who wrote it, and mail them your bug
501 report with the commit id.  Finally, run
503 -------------------------------------------------
504 $ git bisect reset
505 -------------------------------------------------
507 to return you to the branch you were on before and delete the
508 temporary "bisect" branch.
510 Note that the version which git-bisect checks out for you at each
511 point is just a suggestion, and you're free to try a different
512 version if you think it would be a good idea.  For example,
513 occasionally you may land on a commit that broke something unrelated;
516 -------------------------------------------------
517 $ git bisect visualize
518 -------------------------------------------------
520 which will run gitk and label the commit it chose with a marker that
521 says "bisect".  Chose a safe-looking commit nearby, note its commit
522 id, and check it out with:
524 -------------------------------------------------
525 $ git reset --hard fb47ddb2db...
526 -------------------------------------------------
528 then test, run "bisect good" or "bisect bad" as appropriate, and
529 continue.
531 [[naming-commits]]
532 Naming commits
533 --------------
535 We have seen several ways of naming commits already:
537         - 40-hexdigit object name
538         - branch name: refers to the commit at the head of the given
539           branch
540         - tag name: refers to the commit pointed to by the given tag
541           (we've seen branches and tags are special cases of
542           <<how-git-stores-references,references>>).
543         - HEAD: refers to the head of the current branch
545 There are many more; see the "SPECIFYING REVISIONS" section of the
546 linkgit:git-rev-parse[1] man page for the complete list of ways to
547 name revisions.  Some examples:
549 -------------------------------------------------
550 $ git show fb47ddb2 # the first few characters of the object name
551                     # are usually enough to specify it uniquely
552 $ git show HEAD^    # the parent of the HEAD commit
553 $ git show HEAD^^   # the grandparent
554 $ git show HEAD~4   # the great-great-grandparent
555 -------------------------------------------------
557 Recall that merge commits may have more than one parent; by default,
558 ^ and ~ follow the first parent listed in the commit, but you can
559 also choose:
561 -------------------------------------------------
562 $ git show HEAD^1   # show the first parent of HEAD
563 $ git show HEAD^2   # show the second parent of HEAD
564 -------------------------------------------------
566 In addition to HEAD, there are several other special names for
567 commits:
569 Merges (to be discussed later), as well as operations such as
570 git-reset, which change the currently checked-out commit, generally
571 set ORIG_HEAD to the value HEAD had before the current operation.
573 The git-fetch operation always stores the head of the last fetched
574 branch in FETCH_HEAD.  For example, if you run git fetch without
575 specifying a local branch as the target of the operation
577 -------------------------------------------------
578 $ git fetch git://example.com/proj.git theirbranch
579 -------------------------------------------------
581 the fetched commits will still be available from FETCH_HEAD.
583 When we discuss merges we'll also see the special name MERGE_HEAD,
584 which refers to the other branch that we're merging in to the current
585 branch.
587 The linkgit:git-rev-parse[1] command is a low-level command that is
588 occasionally useful for translating some name for a commit to the object
589 name for that commit:
591 -------------------------------------------------
592 $ git rev-parse origin
593 e05db0fd4f31dde7005f075a84f96b360d05984b
594 -------------------------------------------------
596 [[creating-tags]]
597 Creating tags
598 -------------
600 We can also create a tag to refer to a particular commit; after
601 running
603 -------------------------------------------------
604 $ git tag stable-1 1b2e1d63ff
605 -------------------------------------------------
607 You can use stable-1 to refer to the commit 1b2e1d63ff.
609 This creates a "lightweight" tag.  If you would also like to include a
610 comment with the tag, and possibly sign it cryptographically, then you
611 should create a tag object instead; see the linkgit:git-tag[1] man page
612 for details.
614 [[browsing-revisions]]
615 Browsing revisions
616 ------------------
618 The linkgit:git-log[1] command can show lists of commits.  On its
619 own, it shows all commits reachable from the parent commit; but you
620 can also make more specific requests:
622 -------------------------------------------------
623 $ git log v2.5..        # commits since (not reachable from) v2.5
624 $ git log test..master  # commits reachable from master but not test
625 $ git log master..test  # ...reachable from test but not master
626 $ git log master...test # ...reachable from either test or master,
627                         #    but not both
628 $ git log --since="2 weeks ago" # commits from the last 2 weeks
629 $ git log Makefile      # commits which modify Makefile
630 $ git log fs/           # ... which modify any file under fs/
631 $ git log -S'foo()'     # commits which add or remove any file data
632                         # matching the string 'foo()'
633 -------------------------------------------------
635 And of course you can combine all of these; the following finds
636 commits since v2.5 which touch the Makefile or any file under fs:
638 -------------------------------------------------
639 $ git log v2.5.. Makefile fs/
640 -------------------------------------------------
642 You can also ask git log to show patches:
644 -------------------------------------------------
645 $ git log -p
646 -------------------------------------------------
648 See the "--pretty" option in the linkgit:git-log[1] man page for more
649 display options.
651 Note that git log starts with the most recent commit and works
652 backwards through the parents; however, since git history can contain
653 multiple independent lines of development, the particular order that
654 commits are listed in may be somewhat arbitrary.
656 [[generating-diffs]]
657 Generating diffs
658 ----------------
660 You can generate diffs between any two versions using
661 linkgit:git-diff[1]:
663 -------------------------------------------------
664 $ git diff master..test
665 -------------------------------------------------
667 That will produce the diff between the tips of the two branches.  If
668 you'd prefer to find the diff from their common ancestor to test, you
669 can use three dots instead of two:
671 -------------------------------------------------
672 $ git diff master...test
673 -------------------------------------------------
675 Sometimes what you want instead is a set of patches; for this you can
676 use linkgit:git-format-patch[1]:
678 -------------------------------------------------
679 $ git format-patch master..test
680 -------------------------------------------------
682 will generate a file with a patch for each commit reachable from test
683 but not from master.
685 [[viewing-old-file-versions]]
686 Viewing old file versions
687 -------------------------
689 You can always view an old version of a file by just checking out the
690 correct revision first.  But sometimes it is more convenient to be
691 able to view an old version of a single file without checking
692 anything out; this command does that:
694 -------------------------------------------------
695 $ git show v2.5:fs/locks.c
696 -------------------------------------------------
698 Before the colon may be anything that names a commit, and after it
699 may be any path to a file tracked by git.
701 [[history-examples]]
702 Examples
703 --------
705 [[counting-commits-on-a-branch]]
706 Counting the number of commits on a branch
707 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
709 Suppose you want to know how many commits you've made on "mybranch"
710 since it diverged from "origin":
712 -------------------------------------------------
713 $ git log --pretty=oneline origin..mybranch | wc -l
714 -------------------------------------------------
716 Alternatively, you may often see this sort of thing done with the
717 lower-level command linkgit:git-rev-list[1], which just lists the SHA1's
718 of all the given commits:
720 -------------------------------------------------
721 $ git rev-list origin..mybranch | wc -l
722 -------------------------------------------------
724 [[checking-for-equal-branches]]
725 Check whether two branches point at the same history
726 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
728 Suppose you want to check whether two branches point at the same point
729 in history.
731 -------------------------------------------------
732 $ git diff origin..master
733 -------------------------------------------------
735 will tell you whether the contents of the project are the same at the
736 two branches; in theory, however, it's possible that the same project
737 contents could have been arrived at by two different historical
738 routes.  You could compare the object names:
740 -------------------------------------------------
741 $ git rev-list origin
742 e05db0fd4f31dde7005f075a84f96b360d05984b
743 $ git rev-list master
744 e05db0fd4f31dde7005f075a84f96b360d05984b
745 -------------------------------------------------
747 Or you could recall that the ... operator selects all commits
748 contained reachable from either one reference or the other but not
749 both: so
751 -------------------------------------------------
752 $ git log origin...master
753 -------------------------------------------------
755 will return no commits when the two branches are equal.
757 [[finding-tagged-descendants]]
758 Find first tagged version including a given fix
759 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
761 Suppose you know that the commit e05db0fd fixed a certain problem.
762 You'd like to find the earliest tagged release that contains that
763 fix.
765 Of course, there may be more than one answer--if the history branched
766 after commit e05db0fd, then there could be multiple "earliest" tagged
767 releases.
769 You could just visually inspect the commits since e05db0fd:
771 -------------------------------------------------
772 $ gitk e05db0fd..
773 -------------------------------------------------
775 Or you can use linkgit:git-name-rev[1], which will give the commit a
776 name based on any tag it finds pointing to one of the commit's
777 descendants:
779 -------------------------------------------------
780 $ git name-rev --tags e05db0fd
781 e05db0fd tags/v1.5.0-rc1^0~23
782 -------------------------------------------------
784 The linkgit:git-describe[1] command does the opposite, naming the
785 revision using a tag on which the given commit is based:
787 -------------------------------------------------
788 $ git describe e05db0fd
789 v1.5.0-rc0-260-ge05db0f
790 -------------------------------------------------
792 but that may sometimes help you guess which tags might come after the
793 given commit.
795 If you just want to verify whether a given tagged version contains a
796 given commit, you could use linkgit:git-merge-base[1]:
798 -------------------------------------------------
799 $ git merge-base e05db0fd v1.5.0-rc1
800 e05db0fd4f31dde7005f075a84f96b360d05984b
801 -------------------------------------------------
803 The merge-base command finds a common ancestor of the given commits,
804 and always returns one or the other in the case where one is a
805 descendant of the other; so the above output shows that e05db0fd
806 actually is an ancestor of v1.5.0-rc1.
808 Alternatively, note that
810 -------------------------------------------------
811 $ git log v1.5.0-rc1..e05db0fd
812 -------------------------------------------------
814 will produce empty output if and only if v1.5.0-rc1 includes e05db0fd,
815 because it outputs only commits that are not reachable from v1.5.0-rc1.
817 As yet another alternative, the linkgit:git-show-branch[1] command lists
818 the commits reachable from its arguments with a display on the left-hand
819 side that indicates which arguments that commit is reachable from.  So,
820 you can run something like
822 -------------------------------------------------
823 $ git show-branch e05db0fd v1.5.0-rc0 v1.5.0-rc1 v1.5.0-rc2
824 ! [e05db0fd] Fix warnings in sha1_file.c - use C99 printf format if
825 available
826  ! [v1.5.0-rc0] GIT v1.5.0 preview
827   ! [v1.5.0-rc1] GIT v1.5.0-rc1
828    ! [v1.5.0-rc2] GIT v1.5.0-rc2
830 -------------------------------------------------
832 then search for a line that looks like
834 -------------------------------------------------
835 + ++ [e05db0fd] Fix warnings in sha1_file.c - use C99 printf format if
836 available
837 -------------------------------------------------
839 Which shows that e05db0fd is reachable from itself, from v1.5.0-rc1, and
840 from v1.5.0-rc2, but not from v1.5.0-rc0.
842 [[showing-commits-unique-to-a-branch]]
843 Showing commits unique to a given branch
844 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
846 Suppose you would like to see all the commits reachable from the branch
847 head named "master" but not from any other head in your repository.
849 We can list all the heads in this repository with
850 linkgit:git-show-ref[1]:
852 -------------------------------------------------
853 $ git show-ref --heads
854 bf62196b5e363d73353a9dcf094c59595f3153b7 refs/heads/core-tutorial
855 db768d5504c1bb46f63ee9d6e1772bd047e05bf9 refs/heads/maint
856 a07157ac624b2524a059a3414e99f6f44bebc1e7 refs/heads/master
857 24dbc180ea14dc1aebe09f14c8ecf32010690627 refs/heads/tutorial-2
858 1e87486ae06626c2f31eaa63d26fc0fd646c8af2 refs/heads/tutorial-fixes
859 -------------------------------------------------
861 We can get just the branch-head names, and remove "master", with
862 the help of the standard utilities cut and grep:
864 -------------------------------------------------
865 $ git show-ref --heads | cut -d' ' -f2 | grep -v '^refs/heads/master'
866 refs/heads/core-tutorial
867 refs/heads/maint
868 refs/heads/tutorial-2
869 refs/heads/tutorial-fixes
870 -------------------------------------------------
872 And then we can ask to see all the commits reachable from master
873 but not from these other heads:
875 -------------------------------------------------
876 $ gitk master --not $( git show-ref --heads | cut -d' ' -f2 |
877                                 grep -v '^refs/heads/master' )
878 -------------------------------------------------
880 Obviously, endless variations are possible; for example, to see all
881 commits reachable from some head but not from any tag in the repository:
883 -------------------------------------------------
884 $ gitk $( git show-ref --heads ) --not  $( git show-ref --tags )
885 -------------------------------------------------
887 (See linkgit:git-rev-parse[1] for explanations of commit-selecting
888 syntax such as `--not`.)
890 [[making-a-release]]
891 Creating a changelog and tarball for a software release
892 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
894 The linkgit:git-archive[1] command can create a tar or zip archive from
895 any version of a project; for example:
897 -------------------------------------------------
898 $ git archive --format=tar --prefix=project/ HEAD | gzip >latest.tar.gz
899 -------------------------------------------------
901 will use HEAD to produce a tar archive in which each filename is
902 preceded by "project/".
904 If you're releasing a new version of a software project, you may want
905 to simultaneously make a changelog to include in the release
906 announcement.
908 Linus Torvalds, for example, makes new kernel releases by tagging them,
909 then running:
911 -------------------------------------------------
912 $ release-script 2.6.12 2.6.13-rc6 2.6.13-rc7
913 -------------------------------------------------
915 where release-script is a shell script that looks like:
917 -------------------------------------------------
918 #!/bin/sh
919 stable="$1"
920 last="$2"
921 new="$3"
922 echo "# git tag v$new"
923 echo "git archive --prefix=linux-$new/ v$new | gzip -9 > ../linux-$new.tar.gz"
924 echo "git diff v$stable v$new | gzip -9 > ../patch-$new.gz"
925 echo "git log --no-merges v$new ^v$last > ../ChangeLog-$new"
926 echo "git shortlog --no-merges v$new ^v$last > ../ShortLog"
927 echo "git diff --stat --summary -M v$last v$new > ../diffstat-$new"
928 -------------------------------------------------
930 and then he just cut-and-pastes the output commands after verifying that
931 they look OK.
933 [[Finding-comments-with-given-content]]
934 Finding commits referencing a file with given content
935 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
937 Somebody hands you a copy of a file, and asks which commits modified a
938 file such that it contained the given content either before or after the
939 commit.  You can find out with this:
941 -------------------------------------------------
942 $  git log --raw --abbrev=40 --pretty=oneline |
943         grep -B 1 `git hash-object filename`
944 -------------------------------------------------
946 Figuring out why this works is left as an exercise to the (advanced)
947 student.  The linkgit:git-log[1], linkgit:git-diff-tree[1], and
948 linkgit:git-hash-object[1] man pages may prove helpful.
950 [[Developing-with-git]]
951 Developing with git
952 ===================
954 [[telling-git-your-name]]
955 Telling git your name
956 ---------------------
958 Before creating any commits, you should introduce yourself to git.  The
959 easiest way to do so is to make sure the following lines appear in a
960 file named .gitconfig in your home directory:
962 ------------------------------------------------
963 [user]
964         name = Your Name Comes Here
965         email = you@yourdomain.example.com
966 ------------------------------------------------
968 (See the "CONFIGURATION FILE" section of linkgit:git-config[1] for
969 details on the configuration file.)
972 [[creating-a-new-repository]]
973 Creating a new repository
974 -------------------------
976 Creating a new repository from scratch is very easy:
978 -------------------------------------------------
979 $ mkdir project
980 $ cd project
981 $ git init
982 -------------------------------------------------
984 If you have some initial content (say, a tarball):
986 -------------------------------------------------
987 $ tar -xzvf project.tar.gz
988 $ cd project
989 $ git init
990 $ git add . # include everything below ./ in the first commit:
991 $ git commit
992 -------------------------------------------------
994 [[how-to-make-a-commit]]
995 How to make a commit
996 --------------------
998 Creating a new commit takes three steps:
1000         1. Making some changes to the working directory using your
1001            favorite editor.
1002         2. Telling git about your changes.
1003         3. Creating the commit using the content you told git about
1004            in step 2.
1006 In practice, you can interleave and repeat steps 1 and 2 as many
1007 times as you want: in order to keep track of what you want committed
1008 at step 3, git maintains a snapshot of the tree's contents in a
1009 special staging area called "the index."
1011 At the beginning, the content of the index will be identical to
1012 that of the HEAD.  The command "git diff --cached", which shows
1013 the difference between the HEAD and the index, should therefore
1014 produce no output at that point.
1016 Modifying the index is easy:
1018 To update the index with the new contents of a modified file, use
1020 -------------------------------------------------
1021 $ git add path/to/file
1022 -------------------------------------------------
1024 To add the contents of a new file to the index, use
1026 -------------------------------------------------
1027 $ git add path/to/file
1028 -------------------------------------------------
1030 To remove a file from the index and from the working tree,
1032 -------------------------------------------------
1033 $ git rm path/to/file
1034 -------------------------------------------------
1036 After each step you can verify that
1038 -------------------------------------------------
1039 $ git diff --cached
1040 -------------------------------------------------
1042 always shows the difference between the HEAD and the index file--this
1043 is what you'd commit if you created the commit now--and that
1045 -------------------------------------------------
1046 $ git diff
1047 -------------------------------------------------
1049 shows the difference between the working tree and the index file.
1051 Note that "git add" always adds just the current contents of a file
1052 to the index; further changes to the same file will be ignored unless
1053 you run git-add on the file again.
1055 When you're ready, just run
1057 -------------------------------------------------
1058 $ git commit
1059 -------------------------------------------------
1061 and git will prompt you for a commit message and then create the new
1062 commit.  Check to make sure it looks like what you expected with
1064 -------------------------------------------------
1065 $ git show
1066 -------------------------------------------------
1068 As a special shortcut,
1070 -------------------------------------------------
1071 $ git commit -a
1072 -------------------------------------------------
1074 will update the index with any files that you've modified or removed
1075 and create a commit, all in one step.
1077 A number of commands are useful for keeping track of what you're
1078 about to commit:
1080 -------------------------------------------------
1081 $ git diff --cached # difference between HEAD and the index; what
1082                     # would be committed if you ran "commit" now.
1083 $ git diff          # difference between the index file and your
1084                     # working directory; changes that would not
1085                     # be included if you ran "commit" now.
1086 $ git diff HEAD     # difference between HEAD and working tree; what
1087                     # would be committed if you ran "commit -a" now.
1088 $ git status        # a brief per-file summary of the above.
1089 -------------------------------------------------
1091 You can also use linkgit:git-gui[1] to create commits, view changes in
1092 the index and the working tree files, and individually select diff hunks
1093 for inclusion in the index (by right-clicking on the diff hunk and
1094 choosing "Stage Hunk For Commit").
1096 [[creating-good-commit-messages]]
1097 Creating good commit messages
1098 -----------------------------
1100 Though not required, it's a good idea to begin the commit message
1101 with a single short (less than 50 character) line summarizing the
1102 change, followed by a blank line and then a more thorough
1103 description.  Tools that turn commits into email, for example, use
1104 the first line on the Subject line and the rest of the commit in the
1105 body.
1107 [[ignoring-files]]
1108 Ignoring files
1109 --------------
1111 A project will often generate files that you do 'not' want to track with git.
1112 This typically includes files generated by a build process or temporary
1113 backup files made by your editor. Of course, 'not' tracking files with git
1114 is just a matter of 'not' calling "`git add`" on them. But it quickly becomes
1115 annoying to have these untracked files lying around; e.g. they make
1116 "`git add .`" and "`git commit -a`" practically useless, and they keep
1117 showing up in the output of "`git status`".
1119 You can tell git to ignore certain files by creating a file called .gitignore
1120 in the top level of your working directory, with contents such as:
1122 -------------------------------------------------
1123 # Lines starting with '#' are considered comments.
1124 # Ignore any file named foo.txt.
1125 foo.txt
1126 # Ignore (generated) html files,
1127 *.html
1128 # except foo.html which is maintained by hand.
1129 !foo.html
1130 # Ignore objects and archives.
1131 *.[oa]
1132 -------------------------------------------------
1134 See linkgit:gitignore[5] for a detailed explanation of the syntax.  You can
1135 also place .gitignore files in other directories in your working tree, and they
1136 will apply to those directories and their subdirectories.  The `.gitignore`
1137 files can be added to your repository like any other files (just run `git add
1138 .gitignore` and `git commit`, as usual), which is convenient when the exclude
1139 patterns (such as patterns matching build output files) would also make sense
1140 for other users who clone your repository.
1142 If you wish the exclude patterns to affect only certain repositories
1143 (instead of every repository for a given project), you may instead put
1144 them in a file in your repository named .git/info/exclude, or in any file
1145 specified by the `core.excludesfile` configuration variable.  Some git
1146 commands can also take exclude patterns directly on the command line.
1147 See linkgit:gitignore[5] for the details.
1149 [[how-to-merge]]
1150 How to merge
1151 ------------
1153 You can rejoin two diverging branches of development using
1154 linkgit:git-merge[1]:
1156 -------------------------------------------------
1157 $ git merge branchname
1158 -------------------------------------------------
1160 merges the development in the branch "branchname" into the current
1161 branch.  If there are conflicts--for example, if the same file is
1162 modified in two different ways in the remote branch and the local
1163 branch--then you are warned; the output may look something like this:
1165 -------------------------------------------------
1166 $ git merge next
1167  100% (4/4) done
1168 Auto-merged file.txt
1169 CONFLICT (content): Merge conflict in file.txt
1170 Automatic merge failed; fix conflicts and then commit the result.
1171 -------------------------------------------------
1173 Conflict markers are left in the problematic files, and after
1174 you resolve the conflicts manually, you can update the index
1175 with the contents and run git commit, as you normally would when
1176 creating a new file.
1178 If you examine the resulting commit using gitk, you will see that it
1179 has two parents, one pointing to the top of the current branch, and
1180 one to the top of the other branch.
1182 [[resolving-a-merge]]
1183 Resolving a merge
1184 -----------------
1186 When a merge isn't resolved automatically, git leaves the index and
1187 the working tree in a special state that gives you all the
1188 information you need to help resolve the merge.
1190 Files with conflicts are marked specially in the index, so until you
1191 resolve the problem and update the index, linkgit:git-commit[1] will
1192 fail:
1194 -------------------------------------------------
1195 $ git commit
1196 file.txt: needs merge
1197 -------------------------------------------------
1199 Also, linkgit:git-status[1] will list those files as "unmerged", and the
1200 files with conflicts will have conflict markers added, like this:
1202 -------------------------------------------------
1203 <<<<<<< HEAD:file.txt
1204 Hello world
1205 =======
1206 Goodbye
1207 >>>>>>> 77976da35a11db4580b80ae27e8d65caf5208086:file.txt
1208 -------------------------------------------------
1210 All you need to do is edit the files to resolve the conflicts, and then
1212 -------------------------------------------------
1213 $ git add file.txt
1214 $ git commit
1215 -------------------------------------------------
1217 Note that the commit message will already be filled in for you with
1218 some information about the merge.  Normally you can just use this
1219 default message unchanged, but you may add additional commentary of
1220 your own if desired.
1222 The above is all you need to know to resolve a simple merge.  But git
1223 also provides more information to help resolve conflicts:
1225 [[conflict-resolution]]
1226 Getting conflict-resolution help during a merge
1227 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1229 All of the changes that git was able to merge automatically are
1230 already added to the index file, so linkgit:git-diff[1] shows only
1231 the conflicts.  It uses an unusual syntax:
1233 -------------------------------------------------
1234 $ git diff
1235 diff --cc file.txt
1236 index 802992c,2b60207..0000000
1237 --- a/file.txt
1238 +++ b/file.txt
1239 @@@ -1,1 -1,1 +1,5 @@@
1240 ++<<<<<<< HEAD:file.txt
1241  +Hello world
1242 ++=======
1243 + Goodbye
1244 ++>>>>>>> 77976da35a11db4580b80ae27e8d65caf5208086:file.txt
1245 -------------------------------------------------
1247 Recall that the commit which will be committed after we resolve this
1248 conflict will have two parents instead of the usual one: one parent
1249 will be HEAD, the tip of the current branch; the other will be the
1250 tip of the other branch, which is stored temporarily in MERGE_HEAD.
1252 During the merge, the index holds three versions of each file.  Each of
1253 these three "file stages" represents a different version of the file:
1255 -------------------------------------------------
1256 $ git show :1:file.txt  # the file in a common ancestor of both branches
1257 $ git show :2:file.txt  # the version from HEAD.
1258 $ git show :3:file.txt  # the version from MERGE_HEAD.
1259 -------------------------------------------------
1261 When you ask linkgit:git-diff[1] to show the conflicts, it runs a
1262 three-way diff between the conflicted merge results in the work tree with
1263 stages 2 and 3 to show only hunks whose contents come from both sides,
1264 mixed (in other words, when a hunk's merge results come only from stage 2,
1265 that part is not conflicting and is not shown.  Same for stage 3).
1267 The diff above shows the differences between the working-tree version of
1268 file.txt and the stage 2 and stage 3 versions.  So instead of preceding
1269 each line by a single "+" or "-", it now uses two columns: the first
1270 column is used for differences between the first parent and the working
1271 directory copy, and the second for differences between the second parent
1272 and the working directory copy.  (See the "COMBINED DIFF FORMAT" section
1273 of linkgit:git-diff-files[1] for a details of the format.)
1275 After resolving the conflict in the obvious way (but before updating the
1276 index), the diff will look like:
1278 -------------------------------------------------
1279 $ git diff
1280 diff --cc file.txt
1281 index 802992c,2b60207..0000000
1282 --- a/file.txt
1283 +++ b/file.txt
1284 @@@ -1,1 -1,1 +1,1 @@@
1285 - Hello world
1286  -Goodbye
1287 ++Goodbye world
1288 -------------------------------------------------
1290 This shows that our resolved version deleted "Hello world" from the
1291 first parent, deleted "Goodbye" from the second parent, and added
1292 "Goodbye world", which was previously absent from both.
1294 Some special diff options allow diffing the working directory against
1295 any of these stages:
1297 -------------------------------------------------
1298 $ git diff -1 file.txt          # diff against stage 1
1299 $ git diff --base file.txt      # same as the above
1300 $ git diff -2 file.txt          # diff against stage 2
1301 $ git diff --ours file.txt      # same as the above
1302 $ git diff -3 file.txt          # diff against stage 3
1303 $ git diff --theirs file.txt    # same as the above.
1304 -------------------------------------------------
1306 The linkgit:git-log[1] and gitk[1] commands also provide special help
1307 for merges:
1309 -------------------------------------------------
1310 $ git log --merge
1311 $ gitk --merge
1312 -------------------------------------------------
1314 These will display all commits which exist only on HEAD or on
1315 MERGE_HEAD, and which touch an unmerged file.
1317 You may also use linkgit:git-mergetool[1], which lets you merge the
1318 unmerged files using external tools such as emacs or kdiff3.
1320 Each time you resolve the conflicts in a file and update the index:
1322 -------------------------------------------------
1323 $ git add file.txt
1324 -------------------------------------------------
1326 the different stages of that file will be "collapsed", after which
1327 git-diff will (by default) no longer show diffs for that file.
1329 [[undoing-a-merge]]
1330 Undoing a merge
1331 ---------------
1333 If you get stuck and decide to just give up and throw the whole mess
1334 away, you can always return to the pre-merge state with
1336 -------------------------------------------------
1337 $ git reset --hard HEAD
1338 -------------------------------------------------
1340 Or, if you've already committed the merge that you want to throw away,
1342 -------------------------------------------------
1343 $ git reset --hard ORIG_HEAD
1344 -------------------------------------------------
1346 However, this last command can be dangerous in some cases--never
1347 throw away a commit you have already committed if that commit may
1348 itself have been merged into another branch, as doing so may confuse
1349 further merges.
1351 [[fast-forwards]]
1352 Fast-forward merges
1353 -------------------
1355 There is one special case not mentioned above, which is treated
1356 differently.  Normally, a merge results in a merge commit, with two
1357 parents, one pointing at each of the two lines of development that
1358 were merged.
1360 However, if the current branch is a descendant of the other--so every
1361 commit present in the one is already contained in the other--then git
1362 just performs a "fast forward"; the head of the current branch is moved
1363 forward to point at the head of the merged-in branch, without any new
1364 commits being created.
1366 [[fixing-mistakes]]
1367 Fixing mistakes
1368 ---------------
1370 If you've messed up the working tree, but haven't yet committed your
1371 mistake, you can return the entire working tree to the last committed
1372 state with
1374 -------------------------------------------------
1375 $ git reset --hard HEAD
1376 -------------------------------------------------
1378 If you make a commit that you later wish you hadn't, there are two
1379 fundamentally different ways to fix the problem:
1381         1. You can create a new commit that undoes whatever was done
1382         by the old commit.  This is the correct thing if your
1383         mistake has already been made public.
1385         2. You can go back and modify the old commit.  You should
1386         never do this if you have already made the history public;
1387         git does not normally expect the "history" of a project to
1388         change, and cannot correctly perform repeated merges from
1389         a branch that has had its history changed.
1391 [[reverting-a-commit]]
1392 Fixing a mistake with a new commit
1393 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1395 Creating a new commit that reverts an earlier change is very easy;
1396 just pass the linkgit:git-revert[1] command a reference to the bad
1397 commit; for example, to revert the most recent commit:
1399 -------------------------------------------------
1400 $ git revert HEAD
1401 -------------------------------------------------
1403 This will create a new commit which undoes the change in HEAD.  You
1404 will be given a chance to edit the commit message for the new commit.
1406 You can also revert an earlier change, for example, the next-to-last:
1408 -------------------------------------------------
1409 $ git revert HEAD^
1410 -------------------------------------------------
1412 In this case git will attempt to undo the old change while leaving
1413 intact any changes made since then.  If more recent changes overlap
1414 with the changes to be reverted, then you will be asked to fix
1415 conflicts manually, just as in the case of <<resolving-a-merge,
1416 resolving a merge>>.
1418 [[fixing-a-mistake-by-rewriting-history]]
1419 Fixing a mistake by rewriting history
1420 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1422 If the problematic commit is the most recent commit, and you have not
1423 yet made that commit public, then you may just
1424 <<undoing-a-merge,destroy it using git-reset>>.
1426 Alternatively, you
1427 can edit the working directory and update the index to fix your
1428 mistake, just as if you were going to <<how-to-make-a-commit,create a
1429 new commit>>, then run
1431 -------------------------------------------------
1432 $ git commit --amend
1433 -------------------------------------------------
1435 which will replace the old commit by a new commit incorporating your
1436 changes, giving you a chance to edit the old commit message first.
1438 Again, you should never do this to a commit that may already have
1439 been merged into another branch; use linkgit:git-revert[1] instead in
1440 that case.
1442 It is also possible to replace commits further back in the history, but
1443 this is an advanced topic to be left for
1444 <<cleaning-up-history,another chapter>>.
1446 [[checkout-of-path]]
1447 Checking out an old version of a file
1448 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1450 In the process of undoing a previous bad change, you may find it
1451 useful to check out an older version of a particular file using
1452 linkgit:git-checkout[1].  We've used git checkout before to switch
1453 branches, but it has quite different behavior if it is given a path
1454 name: the command
1456 -------------------------------------------------
1457 $ git checkout HEAD^ path/to/file
1458 -------------------------------------------------
1460 replaces path/to/file by the contents it had in the commit HEAD^, and
1461 also updates the index to match.  It does not change branches.
1463 If you just want to look at an old version of the file, without
1464 modifying the working directory, you can do that with
1465 linkgit:git-show[1]:
1467 -------------------------------------------------
1468 $ git show HEAD^:path/to/file
1469 -------------------------------------------------
1471 which will display the given version of the file.
1473 [[interrupted-work]]
1474 Temporarily setting aside work in progress
1475 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1477 While you are in the middle of working on something complicated, you
1478 find an unrelated but obvious and trivial bug.  You would like to fix it
1479 before continuing.  You can use linkgit:git-stash[1] to save the current
1480 state of your work, and after fixing the bug (or, optionally after doing
1481 so on a different branch and then coming back), unstash the
1482 work-in-progress changes.
1484 ------------------------------------------------
1485 $ git stash "work in progress for foo feature"
1486 ------------------------------------------------
1488 This command will save your changes away to the `stash`, and
1489 reset your working tree and the index to match the tip of your
1490 current branch.  Then you can make your fix as usual.
1492 ------------------------------------------------
1493 ... edit and test ...
1494 $ git commit -a -m "blorpl: typofix"
1495 ------------------------------------------------
1497 After that, you can go back to what you were working on with
1498 `git stash apply`:
1500 ------------------------------------------------
1501 $ git stash apply
1502 ------------------------------------------------
1505 [[ensuring-good-performance]]
1506 Ensuring good performance
1507 -------------------------
1509 On large repositories, git depends on compression to keep the history
1510 information from taking up too much space on disk or in memory.
1512 This compression is not performed automatically.  Therefore you
1513 should occasionally run linkgit:git-gc[1]:
1515 -------------------------------------------------
1516 $ git gc
1517 -------------------------------------------------
1519 to recompress the archive.  This can be very time-consuming, so
1520 you may prefer to run git-gc when you are not doing other work.
1523 [[ensuring-reliability]]
1524 Ensuring reliability
1525 --------------------
1527 [[checking-for-corruption]]
1528 Checking the repository for corruption
1529 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1531 The linkgit:git-fsck[1] command runs a number of self-consistency checks
1532 on the repository, and reports on any problems.  This may take some
1533 time.  The most common warning by far is about "dangling" objects:
1535 -------------------------------------------------
1536 $ git fsck
1537 dangling commit 7281251ddd2a61e38657c827739c57015671a6b3
1538 dangling commit 2706a059f258c6b245f298dc4ff2ccd30ec21a63
1539 dangling commit 13472b7c4b80851a1bc551779171dcb03655e9b5
1540 dangling blob 218761f9d90712d37a9c5e36f406f92202db07eb
1541 dangling commit bf093535a34a4d35731aa2bd90fe6b176302f14f
1542 dangling commit 8e4bec7f2ddaa268bef999853c25755452100f8e
1543 dangling tree d50bb86186bf27b681d25af89d3b5b68382e4085
1544 dangling tree b24c2473f1fd3d91352a624795be026d64c8841f
1546 -------------------------------------------------
1548 Dangling objects are not a problem.  At worst they may take up a little
1549 extra disk space.  They can sometimes provide a last-resort method for
1550 recovering lost work--see <<dangling-objects>> for details.
1552 [[recovering-lost-changes]]
1553 Recovering lost changes
1554 ~~~~~~~~~~~~~~~~~~~~~~~
1556 [[reflogs]]
1557 Reflogs
1558 ^^^^^^^
1560 Say you modify a branch with `linkgit:git-reset[1] --hard`, and then
1561 realize that the branch was the only reference you had to that point in
1562 history.
1564 Fortunately, git also keeps a log, called a "reflog", of all the
1565 previous values of each branch.  So in this case you can still find the
1566 old history using, for example,
1568 -------------------------------------------------
1569 $ git log master@{1}
1570 -------------------------------------------------
1572 This lists the commits reachable from the previous version of the
1573 "master" branch head.  This syntax can be used with any git command
1574 that accepts a commit, not just with git log.  Some other examples:
1576 -------------------------------------------------
1577 $ git show master@{2}           # See where the branch pointed 2,
1578 $ git show master@{3}           # 3, ... changes ago.
1579 $ gitk master@{yesterday}       # See where it pointed yesterday,
1580 $ gitk master@{"1 week ago"}    # ... or last week
1581 $ git log --walk-reflogs master # show reflog entries for master
1582 -------------------------------------------------
1584 A separate reflog is kept for the HEAD, so
1586 -------------------------------------------------
1587 $ git show HEAD@{"1 week ago"}
1588 -------------------------------------------------
1590 will show what HEAD pointed to one week ago, not what the current branch
1591 pointed to one week ago.  This allows you to see the history of what
1592 you've checked out.
1594 The reflogs are kept by default for 30 days, after which they may be
1595 pruned.  See linkgit:git-reflog[1] and linkgit:git-gc[1] to learn
1596 how to control this pruning, and see the "SPECIFYING REVISIONS"
1597 section of linkgit:git-rev-parse[1] for details.
1599 Note that the reflog history is very different from normal git history.
1600 While normal history is shared by every repository that works on the
1601 same project, the reflog history is not shared: it tells you only about
1602 how the branches in your local repository have changed over time.
1604 [[dangling-object-recovery]]
1605 Examining dangling objects
1606 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1608 In some situations the reflog may not be able to save you.  For example,
1609 suppose you delete a branch, then realize you need the history it
1610 contained.  The reflog is also deleted; however, if you have not yet
1611 pruned the repository, then you may still be able to find the lost
1612 commits in the dangling objects that git-fsck reports.  See
1613 <<dangling-objects>> for the details.
1615 -------------------------------------------------
1616 $ git fsck
1617 dangling commit 7281251ddd2a61e38657c827739c57015671a6b3
1618 dangling commit 2706a059f258c6b245f298dc4ff2ccd30ec21a63
1619 dangling commit 13472b7c4b80851a1bc551779171dcb03655e9b5
1621 -------------------------------------------------
1623 You can examine
1624 one of those dangling commits with, for example,
1626 ------------------------------------------------
1627 $ gitk 7281251ddd --not --all
1628 ------------------------------------------------
1630 which does what it sounds like: it says that you want to see the commit
1631 history that is described by the dangling commit(s), but not the
1632 history that is described by all your existing branches and tags.  Thus
1633 you get exactly the history reachable from that commit that is lost.
1634 (And notice that it might not be just one commit: we only report the
1635 "tip of the line" as being dangling, but there might be a whole deep
1636 and complex commit history that was dropped.)
1638 If you decide you want the history back, you can always create a new
1639 reference pointing to it, for example, a new branch:
1641 ------------------------------------------------
1642 $ git branch recovered-branch 7281251ddd
1643 ------------------------------------------------
1645 Other types of dangling objects (blobs and trees) are also possible, and
1646 dangling objects can arise in other situations.
1649 [[sharing-development]]
1650 Sharing development with others
1651 ===============================
1653 [[getting-updates-with-git-pull]]
1654 Getting updates with git pull
1655 -----------------------------
1657 After you clone a repository and make a few changes of your own, you
1658 may wish to check the original repository for updates and merge them
1659 into your own work.
1661 We have already seen <<Updating-a-repository-with-git-fetch,how to
1662 keep remote tracking branches up to date>> with linkgit:git-fetch[1],
1663 and how to merge two branches.  So you can merge in changes from the
1664 original repository's master branch with:
1666 -------------------------------------------------
1667 $ git fetch
1668 $ git merge origin/master
1669 -------------------------------------------------
1671 However, the linkgit:git-pull[1] command provides a way to do this in
1672 one step:
1674 -------------------------------------------------
1675 $ git pull origin master
1676 -------------------------------------------------
1678 In fact, if you have "master" checked out, then by default "git pull"
1679 merges from the HEAD branch of the origin repository.  So often you can
1680 accomplish the above with just a simple
1682 -------------------------------------------------
1683 $ git pull
1684 -------------------------------------------------
1686 More generally, a branch that is created from a remote branch will pull
1687 by default from that branch.  See the descriptions of the
1688 branch.<name>.remote and branch.<name>.merge options in
1689 linkgit:git-config[1], and the discussion of the `--track` option in
1690 linkgit:git-checkout[1], to learn how to control these defaults.
1692 In addition to saving you keystrokes, "git pull" also helps you by
1693 producing a default commit message documenting the branch and
1694 repository that you pulled from.
1696 (But note that no such commit will be created in the case of a
1697 <<fast-forwards,fast forward>>; instead, your branch will just be
1698 updated to point to the latest commit from the upstream branch.)
1700 The git-pull command can also be given "." as the "remote" repository,
1701 in which case it just merges in a branch from the current repository; so
1702 the commands
1704 -------------------------------------------------
1705 $ git pull . branch
1706 $ git merge branch
1707 -------------------------------------------------
1709 are roughly equivalent.  The former is actually very commonly used.
1711 [[submitting-patches]]
1712 Submitting patches to a project
1713 -------------------------------
1715 If you just have a few changes, the simplest way to submit them may
1716 just be to send them as patches in email:
1718 First, use linkgit:git-format-patch[1]; for example:
1720 -------------------------------------------------
1721 $ git format-patch origin
1722 -------------------------------------------------
1724 will produce a numbered series of files in the current directory, one
1725 for each patch in the current branch but not in origin/HEAD.
1727 You can then import these into your mail client and send them by
1728 hand.  However, if you have a lot to send at once, you may prefer to
1729 use the linkgit:git-send-email[1] script to automate the process.
1730 Consult the mailing list for your project first to determine how they
1731 prefer such patches be handled.
1733 [[importing-patches]]
1734 Importing patches to a project
1735 ------------------------------
1737 Git also provides a tool called linkgit:git-am[1] (am stands for
1738 "apply mailbox"), for importing such an emailed series of patches.
1739 Just save all of the patch-containing messages, in order, into a
1740 single mailbox file, say "patches.mbox", then run
1742 -------------------------------------------------
1743 $ git am -3 patches.mbox
1744 -------------------------------------------------
1746 Git will apply each patch in order; if any conflicts are found, it
1747 will stop, and you can fix the conflicts as described in
1748 "<<resolving-a-merge,Resolving a merge>>".  (The "-3" option tells
1749 git to perform a merge; if you would prefer it just to abort and
1750 leave your tree and index untouched, you may omit that option.)
1752 Once the index is updated with the results of the conflict
1753 resolution, instead of creating a new commit, just run
1755 -------------------------------------------------
1756 $ git am --resolved
1757 -------------------------------------------------
1759 and git will create the commit for you and continue applying the
1760 remaining patches from the mailbox.
1762 The final result will be a series of commits, one for each patch in
1763 the original mailbox, with authorship and commit log message each
1764 taken from the message containing each patch.
1766 [[public-repositories]]
1767 Public git repositories
1768 -----------------------
1770 Another way to submit changes to a project is to tell the maintainer
1771 of that project to pull the changes from your repository using
1772 linkgit:git-pull[1].  In the section "<<getting-updates-with-git-pull,
1773 Getting updates with git pull>>" we described this as a way to get
1774 updates from the "main" repository, but it works just as well in the
1775 other direction.
1777 If you and the maintainer both have accounts on the same machine, then
1778 you can just pull changes from each other's repositories directly;
1779 commands that accept repository URLs as arguments will also accept a
1780 local directory name:
1782 -------------------------------------------------
1783 $ git clone /path/to/repository
1784 $ git pull /path/to/other/repository
1785 -------------------------------------------------
1787 or an ssh URL:
1789 -------------------------------------------------
1790 $ git clone ssh://yourhost/~you/repository
1791 -------------------------------------------------
1793 For projects with few developers, or for synchronizing a few private
1794 repositories, this may be all you need.
1796 However, the more common way to do this is to maintain a separate public
1797 repository (usually on a different host) for others to pull changes
1798 from.  This is usually more convenient, and allows you to cleanly
1799 separate private work in progress from publicly visible work.
1801 You will continue to do your day-to-day work in your personal
1802 repository, but periodically "push" changes from your personal
1803 repository into your public repository, allowing other developers to
1804 pull from that repository.  So the flow of changes, in a situation
1805 where there is one other developer with a public repository, looks
1806 like this:
1808                         you push
1809   your personal repo ------------------> your public repo
1810         ^                                     |
1811         |                                     |
1812         | you pull                            | they pull
1813         |                                     |
1814         |                                     |
1815         |               they push             V
1816   their public repo <------------------- their repo
1818 We explain how to do this in the following sections.
1820 [[setting-up-a-public-repository]]
1821 Setting up a public repository
1822 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1824 Assume your personal repository is in the directory ~/proj.  We
1825 first create a new clone of the repository and tell git-daemon that it
1826 is meant to be public:
1828 -------------------------------------------------
1829 $ git clone --bare ~/proj proj.git
1830 $ touch proj.git/git-daemon-export-ok
1831 -------------------------------------------------
1833 The resulting directory proj.git contains a "bare" git repository--it is
1834 just the contents of the ".git" directory, without any files checked out
1835 around it.
1837 Next, copy proj.git to the server where you plan to host the
1838 public repository.  You can use scp, rsync, or whatever is most
1839 convenient.
1841 [[exporting-via-git]]
1842 Exporting a git repository via the git protocol
1843 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1845 This is the preferred method.
1847 If someone else administers the server, they should tell you what
1848 directory to put the repository in, and what git:// URL it will appear
1849 at.  You can then skip to the section
1850 "<<pushing-changes-to-a-public-repository,Pushing changes to a public
1851 repository>>", below.
1853 Otherwise, all you need to do is start linkgit:git-daemon[1]; it will
1854 listen on port 9418.  By default, it will allow access to any directory
1855 that looks like a git directory and contains the magic file
1856 git-daemon-export-ok.  Passing some directory paths as git-daemon
1857 arguments will further restrict the exports to those paths.
1859 You can also run git-daemon as an inetd service; see the
1860 linkgit:git-daemon[1] man page for details.  (See especially the
1861 examples section.)
1863 [[exporting-via-http]]
1864 Exporting a git repository via http
1865 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1867 The git protocol gives better performance and reliability, but on a
1868 host with a web server set up, http exports may be simpler to set up.
1870 All you need to do is place the newly created bare git repository in
1871 a directory that is exported by the web server, and make some
1872 adjustments to give web clients some extra information they need:
1874 -------------------------------------------------
1875 $ mv proj.git /home/you/public_html/proj.git
1876 $ cd proj.git
1877 $ git --bare update-server-info
1878 $ chmod a+x hooks/post-update
1879 -------------------------------------------------
1881 (For an explanation of the last two lines, see
1882 linkgit:git-update-server-info[1], and the documentation
1883 linkgit:githooks[5][Hooks used by git].)
1885 Advertise the URL of proj.git.  Anybody else should then be able to
1886 clone or pull from that URL, for example with a command line like:
1888 -------------------------------------------------
1889 $ git clone http://yourserver.com/~you/proj.git
1890 -------------------------------------------------
1892 (See also
1893 link:howto/setup-git-server-over-http.txt[setup-git-server-over-http]
1894 for a slightly more sophisticated setup using WebDAV which also
1895 allows pushing over http.)
1897 [[pushing-changes-to-a-public-repository]]
1898 Pushing changes to a public repository
1899 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1901 Note that the two techniques outlined above (exporting via
1902 <<exporting-via-http,http>> or <<exporting-via-git,git>>) allow other
1903 maintainers to fetch your latest changes, but they do not allow write
1904 access, which you will need to update the public repository with the
1905 latest changes created in your private repository.
1907 The simplest way to do this is using linkgit:git-push[1] and ssh; to
1908 update the remote branch named "master" with the latest state of your
1909 branch named "master", run
1911 -------------------------------------------------
1912 $ git push ssh://yourserver.com/~you/proj.git master:master
1913 -------------------------------------------------
1915 or just
1917 -------------------------------------------------
1918 $ git push ssh://yourserver.com/~you/proj.git master
1919 -------------------------------------------------
1921 As with git-fetch, git-push will complain if this does not result in a
1922 <<fast-forwards,fast forward>>; see the following section for details on
1923 handling this case.
1925 Note that the target of a "push" is normally a
1926 <<def_bare_repository,bare>> repository.  You can also push to a
1927 repository that has a checked-out working tree, but the working tree
1928 will not be updated by the push.  This may lead to unexpected results if
1929 the branch you push to is the currently checked-out branch!
1931 As with git-fetch, you may also set up configuration options to
1932 save typing; so, for example, after
1934 -------------------------------------------------
1935 $ cat >>.git/config <<EOF
1936 [remote "public-repo"]
1937         url = ssh://yourserver.com/~you/proj.git
1939 -------------------------------------------------
1941 you should be able to perform the above push with just
1943 -------------------------------------------------
1944 $ git push public-repo master
1945 -------------------------------------------------
1947 See the explanations of the remote.<name>.url, branch.<name>.remote,
1948 and remote.<name>.push options in linkgit:git-config[1] for
1949 details.
1951 [[forcing-push]]
1952 What to do when a push fails
1953 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1955 If a push would not result in a <<fast-forwards,fast forward>> of the
1956 remote branch, then it will fail with an error like:
1958 -------------------------------------------------
1959 error: remote 'refs/heads/master' is not an ancestor of
1960  local  'refs/heads/master'.
1961  Maybe you are not up-to-date and need to pull first?
1962 error: failed to push to 'ssh://yourserver.com/~you/proj.git'
1963 -------------------------------------------------
1965 This can happen, for example, if you:
1967         - use `git reset --hard` to remove already-published commits, or
1968         - use `git commit --amend` to replace already-published commits
1969           (as in <<fixing-a-mistake-by-rewriting-history>>), or
1970         - use `git rebase` to rebase any already-published commits (as
1971           in <<using-git-rebase>>).
1973 You may force git-push to perform the update anyway by preceding the
1974 branch name with a plus sign:
1976 -------------------------------------------------
1977 $ git push ssh://yourserver.com/~you/proj.git +master
1978 -------------------------------------------------
1980 Normally whenever a branch head in a public repository is modified, it
1981 is modified to point to a descendant of the commit that it pointed to
1982 before.  By forcing a push in this situation, you break that convention.
1983 (See <<problems-with-rewriting-history>>.)
1985 Nevertheless, this is a common practice for people that need a simple
1986 way to publish a work-in-progress patch series, and it is an acceptable
1987 compromise as long as you warn other developers that this is how you
1988 intend to manage the branch.
1990 It's also possible for a push to fail in this way when other people have
1991 the right to push to the same repository.  In that case, the correct
1992 solution is to retry the push after first updating your work by either a
1993 pull or a fetch followed by a rebase; see the
1994 <<setting-up-a-shared-repository,next section>> and
1995 linkgit:gitcvs-migration[7][git for CVS users] for more.
1997 [[setting-up-a-shared-repository]]
1998 Setting up a shared repository
1999 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2001 Another way to collaborate is by using a model similar to that
2002 commonly used in CVS, where several developers with special rights
2003 all push to and pull from a single shared repository.  See
2004 linkgit:gitcvs-migration[7][git for CVS users] for instructions on how to
2005 set this up.
2007 However, while there is nothing wrong with git's support for shared
2008 repositories, this mode of operation is not generally recommended,
2009 simply because the mode of collaboration that git supports--by
2010 exchanging patches and pulling from public repositories--has so many
2011 advantages over the central shared repository:
2013         - Git's ability to quickly import and merge patches allows a
2014           single maintainer to process incoming changes even at very
2015           high rates.  And when that becomes too much, git-pull provides
2016           an easy way for that maintainer to delegate this job to other
2017           maintainers while still allowing optional review of incoming
2018           changes.
2019         - Since every developer's repository has the same complete copy
2020           of the project history, no repository is special, and it is
2021           trivial for another developer to take over maintenance of a
2022           project, either by mutual agreement, or because a maintainer
2023           becomes unresponsive or difficult to work with.
2024         - The lack of a central group of "committers" means there is
2025           less need for formal decisions about who is "in" and who is
2026           "out".
2028 [[setting-up-gitweb]]
2029 Allowing web browsing of a repository
2030 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2032 The gitweb cgi script provides users an easy way to browse your
2033 project's files and history without having to install git; see the file
2034 gitweb/INSTALL in the git source tree for instructions on setting it up.
2036 [[sharing-development-examples]]
2037 Examples
2038 --------
2040 [[maintaining-topic-branches]]
2041 Maintaining topic branches for a Linux subsystem maintainer
2042 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2044 This describes how Tony Luck uses git in his role as maintainer of the
2045 IA64 architecture for the Linux kernel.
2047 He uses two public branches:
2049  - A "test" tree into which patches are initially placed so that they
2050    can get some exposure when integrated with other ongoing development.
2051    This tree is available to Andrew for pulling into -mm whenever he
2052    wants.
2054  - A "release" tree into which tested patches are moved for final sanity
2055    checking, and as a vehicle to send them upstream to Linus (by sending
2056    him a "please pull" request.)
2058 He also uses a set of temporary branches ("topic branches"), each
2059 containing a logical grouping of patches.
2061 To set this up, first create your work tree by cloning Linus's public
2062 tree:
2064 -------------------------------------------------
2065 $ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git work
2066 $ cd work
2067 -------------------------------------------------
2069 Linus's tree will be stored in the remote branch named origin/master,
2070 and can be updated using linkgit:git-fetch[1]; you can track other
2071 public trees using linkgit:git-remote[1] to set up a "remote" and
2072 linkgit:git-fetch[1] to keep them up-to-date; see
2073 <<repositories-and-branches>>.
2075 Now create the branches in which you are going to work; these start out
2076 at the current tip of origin/master branch, and should be set up (using
2077 the --track option to linkgit:git-branch[1]) to merge changes in from
2078 Linus by default.
2080 -------------------------------------------------
2081 $ git branch --track test origin/master
2082 $ git branch --track release origin/master
2083 -------------------------------------------------
2085 These can be easily kept up to date using linkgit:git-pull[1].
2087 -------------------------------------------------
2088 $ git checkout test && git pull
2089 $ git checkout release && git pull
2090 -------------------------------------------------
2092 Important note!  If you have any local changes in these branches, then
2093 this merge will create a commit object in the history (with no local
2094 changes git will simply do a "Fast forward" merge).  Many people dislike
2095 the "noise" that this creates in the Linux history, so you should avoid
2096 doing this capriciously in the "release" branch, as these noisy commits
2097 will become part of the permanent history when you ask Linus to pull
2098 from the release branch.
2100 A few configuration variables (see linkgit:git-config[1]) can
2101 make it easy to push both branches to your public tree.  (See
2102 <<setting-up-a-public-repository>>.)
2104 -------------------------------------------------
2105 $ cat >> .git/config <<EOF
2106 [remote "mytree"]
2107         url =  master.kernel.org:/pub/scm/linux/kernel/git/aegl/linux-2.6.git
2108         push = release
2109         push = test
2111 -------------------------------------------------
2113 Then you can push both the test and release trees using
2114 linkgit:git-push[1]:
2116 -------------------------------------------------
2117 $ git push mytree
2118 -------------------------------------------------
2120 or push just one of the test and release branches using:
2122 -------------------------------------------------
2123 $ git push mytree test
2124 -------------------------------------------------
2128 -------------------------------------------------
2129 $ git push mytree release
2130 -------------------------------------------------
2132 Now to apply some patches from the community.  Think of a short
2133 snappy name for a branch to hold this patch (or related group of
2134 patches), and create a new branch from the current tip of Linus's
2135 branch:
2137 -------------------------------------------------
2138 $ git checkout -b speed-up-spinlocks origin
2139 -------------------------------------------------
2141 Now you apply the patch(es), run some tests, and commit the change(s).  If
2142 the patch is a multi-part series, then you should apply each as a separate
2143 commit to this branch.
2145 -------------------------------------------------
2146 $ ... patch ... test  ... commit [ ... patch ... test ... commit ]*
2147 -------------------------------------------------
2149 When you are happy with the state of this change, you can pull it into the
2150 "test" branch in preparation to make it public:
2152 -------------------------------------------------
2153 $ git checkout test && git pull . speed-up-spinlocks
2154 -------------------------------------------------
2156 It is unlikely that you would have any conflicts here ... but you might if you
2157 spent a while on this step and had also pulled new versions from upstream.
2159 Some time later when enough time has passed and testing done, you can pull the
2160 same branch into the "release" tree ready to go upstream.  This is where you
2161 see the value of keeping each patch (or patch series) in its own branch.  It
2162 means that the patches can be moved into the "release" tree in any order.
2164 -------------------------------------------------
2165 $ git checkout release && git pull . speed-up-spinlocks
2166 -------------------------------------------------
2168 After a while, you will have a number of branches, and despite the
2169 well chosen names you picked for each of them, you may forget what
2170 they are for, or what status they are in.  To get a reminder of what
2171 changes are in a specific branch, use:
2173 -------------------------------------------------
2174 $ git log linux..branchname | git-shortlog
2175 -------------------------------------------------
2177 To see whether it has already been merged into the test or release branches,
2178 use:
2180 -------------------------------------------------
2181 $ git log test..branchname
2182 -------------------------------------------------
2186 -------------------------------------------------
2187 $ git log release..branchname
2188 -------------------------------------------------
2190 (If this branch has not yet been merged, you will see some log entries.
2191 If it has been merged, then there will be no output.)
2193 Once a patch completes the great cycle (moving from test to release,
2194 then pulled by Linus, and finally coming back into your local
2195 "origin/master" branch), the branch for this change is no longer needed.
2196 You detect this when the output from:
2198 -------------------------------------------------
2199 $ git log origin..branchname
2200 -------------------------------------------------
2202 is empty.  At this point the branch can be deleted:
2204 -------------------------------------------------
2205 $ git branch -d branchname
2206 -------------------------------------------------
2208 Some changes are so trivial that it is not necessary to create a separate
2209 branch and then merge into each of the test and release branches.  For
2210 these changes, just apply directly to the "release" branch, and then
2211 merge that into the "test" branch.
2213 To create diffstat and shortlog summaries of changes to include in a "please
2214 pull" request to Linus you can use:
2216 -------------------------------------------------
2217 $ git diff --stat origin..release
2218 -------------------------------------------------
2222 -------------------------------------------------
2223 $ git log -p origin..release | git shortlog
2224 -------------------------------------------------
2226 Here are some of the scripts that simplify all this even further.
2228 -------------------------------------------------
2229 ==== update script ====
2230 # Update a branch in my GIT tree.  If the branch to be updated
2231 # is origin, then pull from kernel.org.  Otherwise merge
2232 # origin/master branch into test|release branch
2234 case "$1" in
2235 test|release)
2236         git checkout $1 && git pull . origin
2237         ;;
2238 origin)
2239         before=$(git rev-parse refs/remotes/origin/master)
2240         git fetch origin
2241         after=$(git rev-parse refs/remotes/origin/master)
2242         if [ $before != $after ]
2243         then
2244                 git log $before..$after | git shortlog
2245         fi
2246         ;;
2248         echo "Usage: $0 origin|test|release" 1>&2
2249         exit 1
2250         ;;
2251 esac
2252 -------------------------------------------------
2254 -------------------------------------------------
2255 ==== merge script ====
2256 # Merge a branch into either the test or release branch
2258 pname=$0
2260 usage()
2262         echo "Usage: $pname branch test|release" 1>&2
2263         exit 1
2266 git show-ref -q --verify -- refs/heads/"$1" || {
2267         echo "Can't see branch <$1>" 1>&2
2268         usage
2271 case "$2" in
2272 test|release)
2273         if [ $(git log $2..$1 | wc -c) -eq 0 ]
2274         then
2275                 echo $1 already merged into $2 1>&2
2276                 exit 1
2277         fi
2278         git checkout $2 && git pull . $1
2279         ;;
2281         usage
2282         ;;
2283 esac
2284 -------------------------------------------------
2286 -------------------------------------------------
2287 ==== status script ====
2288 # report on status of my ia64 GIT tree
2290 gb=$(tput setab 2)
2291 rb=$(tput setab 1)
2292 restore=$(tput setab 9)
2294 if [ `git rev-list test..release | wc -c` -gt 0 ]
2295 then
2296         echo $rb Warning: commits in release that are not in test $restore
2297         git log test..release
2300 for branch in `git show-ref --heads | sed 's|^.*/||'`
2302         if [ $branch = test -o $branch = release ]
2303         then
2304                 continue
2305         fi
2307         echo -n $gb ======= $branch ====== $restore " "
2308         status=
2309         for ref in test release origin/master
2310         do
2311                 if [ `git rev-list $ref..$branch | wc -c` -gt 0 ]
2312                 then
2313                         status=$status${ref:0:1}
2314                 fi
2315         done
2316         case $status in
2317         trl)
2318                 echo $rb Need to pull into test $restore
2319                 ;;
2320         rl)
2321                 echo "In test"
2322                 ;;
2323         l)
2324                 echo "Waiting for linus"
2325                 ;;
2326         "")
2327                 echo $rb All done $restore
2328                 ;;
2329         *)
2330                 echo $rb "<$status>" $restore
2331                 ;;
2332         esac
2333         git log origin/master..$branch | git shortlog
2334 done
2335 -------------------------------------------------
2338 [[cleaning-up-history]]
2339 Rewriting history and maintaining patch series
2340 ==============================================
2342 Normally commits are only added to a project, never taken away or
2343 replaced.  Git is designed with this assumption, and violating it will
2344 cause git's merge machinery (for example) to do the wrong thing.
2346 However, there is a situation in which it can be useful to violate this
2347 assumption.
2349 [[patch-series]]
2350 Creating the perfect patch series
2351 ---------------------------------
2353 Suppose you are a contributor to a large project, and you want to add a
2354 complicated feature, and to present it to the other developers in a way
2355 that makes it easy for them to read your changes, verify that they are
2356 correct, and understand why you made each change.
2358 If you present all of your changes as a single patch (or commit), they
2359 may find that it is too much to digest all at once.
2361 If you present them with the entire history of your work, complete with
2362 mistakes, corrections, and dead ends, they may be overwhelmed.
2364 So the ideal is usually to produce a series of patches such that:
2366         1. Each patch can be applied in order.
2368         2. Each patch includes a single logical change, together with a
2369            message explaining the change.
2371         3. No patch introduces a regression: after applying any initial
2372            part of the series, the resulting project still compiles and
2373            works, and has no bugs that it didn't have before.
2375         4. The complete series produces the same end result as your own
2376            (probably much messier!) development process did.
2378 We will introduce some tools that can help you do this, explain how to
2379 use them, and then explain some of the problems that can arise because
2380 you are rewriting history.
2382 [[using-git-rebase]]
2383 Keeping a patch series up to date using git-rebase
2384 --------------------------------------------------
2386 Suppose that you create a branch "mywork" on a remote-tracking branch
2387 "origin", and create some commits on top of it:
2389 -------------------------------------------------
2390 $ git checkout -b mywork origin
2391 $ vi file.txt
2392 $ git commit
2393 $ vi otherfile.txt
2394 $ git commit
2396 -------------------------------------------------
2398 You have performed no merges into mywork, so it is just a simple linear
2399 sequence of patches on top of "origin":
2401 ................................................
2402  o--o--o <-- origin
2403         \
2404          o--o--o <-- mywork
2405 ................................................
2407 Some more interesting work has been done in the upstream project, and
2408 "origin" has advanced:
2410 ................................................
2411  o--o--O--o--o--o <-- origin
2412         \
2413          a--b--c <-- mywork
2414 ................................................
2416 At this point, you could use "pull" to merge your changes back in;
2417 the result would create a new merge commit, like this:
2419 ................................................
2420  o--o--O--o--o--o <-- origin
2421         \        \
2422          a--b--c--m <-- mywork
2423 ................................................
2425 However, if you prefer to keep the history in mywork a simple series of
2426 commits without any merges, you may instead choose to use
2427 linkgit:git-rebase[1]:
2429 -------------------------------------------------
2430 $ git checkout mywork
2431 $ git rebase origin
2432 -------------------------------------------------
2434 This will remove each of your commits from mywork, temporarily saving
2435 them as patches (in a directory named ".dotest"), update mywork to
2436 point at the latest version of origin, then apply each of the saved
2437 patches to the new mywork.  The result will look like:
2440 ................................................
2441  o--o--O--o--o--o <-- origin
2442                  \
2443                   a'--b'--c' <-- mywork
2444 ................................................
2446 In the process, it may discover conflicts.  In that case it will stop
2447 and allow you to fix the conflicts; after fixing conflicts, use "git
2448 add" to update the index with those contents, and then, instead of
2449 running git-commit, just run
2451 -------------------------------------------------
2452 $ git rebase --continue
2453 -------------------------------------------------
2455 and git will continue applying the rest of the patches.
2457 At any point you may use the `--abort` option to abort this process and
2458 return mywork to the state it had before you started the rebase:
2460 -------------------------------------------------
2461 $ git rebase --abort
2462 -------------------------------------------------
2464 [[rewriting-one-commit]]
2465 Rewriting a single commit
2466 -------------------------
2468 We saw in <<fixing-a-mistake-by-rewriting-history>> that you can replace the
2469 most recent commit using
2471 -------------------------------------------------
2472 $ git commit --amend
2473 -------------------------------------------------
2475 which will replace the old commit by a new commit incorporating your
2476 changes, giving you a chance to edit the old commit message first.
2478 You can also use a combination of this and linkgit:git-rebase[1] to
2479 replace a commit further back in your history and recreate the
2480 intervening changes on top of it.  First, tag the problematic commit
2481 with
2483 -------------------------------------------------
2484 $ git tag bad mywork~5
2485 -------------------------------------------------
2487 (Either gitk or git-log may be useful for finding the commit.)
2489 Then check out that commit, edit it, and rebase the rest of the series
2490 on top of it (note that we could check out the commit on a temporary
2491 branch, but instead we're using a <<detached-head,detached head>>):
2493 -------------------------------------------------
2494 $ git checkout bad
2495 $ # make changes here and update the index
2496 $ git commit --amend
2497 $ git rebase --onto HEAD bad mywork
2498 -------------------------------------------------
2500 When you're done, you'll be left with mywork checked out, with the top
2501 patches on mywork reapplied on top of your modified commit.  You can
2502 then clean up with
2504 -------------------------------------------------
2505 $ git tag -d bad
2506 -------------------------------------------------
2508 Note that the immutable nature of git history means that you haven't really
2509 "modified" existing commits; instead, you have replaced the old commits with
2510 new commits having new object names.
2512 [[reordering-patch-series]]
2513 Reordering or selecting from a patch series
2514 -------------------------------------------
2516 Given one existing commit, the linkgit:git-cherry-pick[1] command
2517 allows you to apply the change introduced by that commit and create a
2518 new commit that records it.  So, for example, if "mywork" points to a
2519 series of patches on top of "origin", you might do something like:
2521 -------------------------------------------------
2522 $ git checkout -b mywork-new origin
2523 $ gitk origin..mywork &
2524 -------------------------------------------------
2526 and browse through the list of patches in the mywork branch using gitk,
2527 applying them (possibly in a different order) to mywork-new using
2528 cherry-pick, and possibly modifying them as you go using `commit --amend`.
2529 The linkgit:git-gui[1] command may also help as it allows you to
2530 individually select diff hunks for inclusion in the index (by
2531 right-clicking on the diff hunk and choosing "Stage Hunk for Commit").
2533 Another technique is to use git-format-patch to create a series of
2534 patches, then reset the state to before the patches:
2536 -------------------------------------------------
2537 $ git format-patch origin
2538 $ git reset --hard origin
2539 -------------------------------------------------
2541 Then modify, reorder, or eliminate patches as preferred before applying
2542 them again with linkgit:git-am[1].
2544 [[patch-series-tools]]
2545 Other tools
2546 -----------
2548 There are numerous other tools, such as StGIT, which exist for the
2549 purpose of maintaining a patch series.  These are outside of the scope of
2550 this manual.
2552 [[problems-with-rewriting-history]]
2553 Problems with rewriting history
2554 -------------------------------
2556 The primary problem with rewriting the history of a branch has to do
2557 with merging.  Suppose somebody fetches your branch and merges it into
2558 their branch, with a result something like this:
2560 ................................................
2561  o--o--O--o--o--o <-- origin
2562         \        \
2563          t--t--t--m <-- their branch:
2564 ................................................
2566 Then suppose you modify the last three commits:
2568 ................................................
2569          o--o--o <-- new head of origin
2570         /
2571  o--o--O--o--o--o <-- old head of origin
2572 ................................................
2574 If we examined all this history together in one repository, it will
2575 look like:
2577 ................................................
2578          o--o--o <-- new head of origin
2579         /
2580  o--o--O--o--o--o <-- old head of origin
2581         \        \
2582          t--t--t--m <-- their branch:
2583 ................................................
2585 Git has no way of knowing that the new head is an updated version of
2586 the old head; it treats this situation exactly the same as it would if
2587 two developers had independently done the work on the old and new heads
2588 in parallel.  At this point, if someone attempts to merge the new head
2589 in to their branch, git will attempt to merge together the two (old and
2590 new) lines of development, instead of trying to replace the old by the
2591 new.  The results are likely to be unexpected.
2593 You may still choose to publish branches whose history is rewritten,
2594 and it may be useful for others to be able to fetch those branches in
2595 order to examine or test them, but they should not attempt to pull such
2596 branches into their own work.
2598 For true distributed development that supports proper merging,
2599 published branches should never be rewritten.
2601 [[bisect-merges]]
2602 Why bisecting merge commits can be harder than bisecting linear history
2603 -----------------------------------------------------------------------
2605 The linkgit:git-bisect[1] command correctly handles history that
2606 includes merge commits.  However, when the commit that it finds is a
2607 merge commit, the user may need to work harder than usual to figure out
2608 why that commit introduced a problem.
2610 Imagine this history:
2612 ................................................
2613       ---Z---o---X---...---o---A---C---D
2614           \                       /
2615            o---o---Y---...---o---B
2616 ................................................
2618 Suppose that on the upper line of development, the meaning of one
2619 of the functions that exists at Z is changed at commit X.  The
2620 commits from Z leading to A change both the function's
2621 implementation and all calling sites that exist at Z, as well
2622 as new calling sites they add, to be consistent.  There is no
2623 bug at A.
2625 Suppose that in the meantime on the lower line of development somebody
2626 adds a new calling site for that function at commit Y.  The
2627 commits from Z leading to B all assume the old semantics of that
2628 function and the callers and the callee are consistent with each
2629 other.  There is no bug at B, either.
2631 Suppose further that the two development lines merge cleanly at C,
2632 so no conflict resolution is required.
2634 Nevertheless, the code at C is broken, because the callers added
2635 on the lower line of development have not been converted to the new
2636 semantics introduced on the upper line of development.  So if all
2637 you know is that D is bad, that Z is good, and that
2638 linkgit:git-bisect[1] identifies C as the culprit, how will you
2639 figure out that the problem is due to this change in semantics?
2641 When the result of a git-bisect is a non-merge commit, you should
2642 normally be able to discover the problem by examining just that commit.
2643 Developers can make this easy by breaking their changes into small
2644 self-contained commits.  That won't help in the case above, however,
2645 because the problem isn't obvious from examination of any single
2646 commit; instead, a global view of the development is required.  To
2647 make matters worse, the change in semantics in the problematic
2648 function may be just one small part of the changes in the upper
2649 line of development.
2651 On the other hand, if instead of merging at C you had rebased the
2652 history between Z to B on top of A, you would have gotten this
2653 linear history:
2655 ................................................................
2656     ---Z---o---X--...---o---A---o---o---Y*--...---o---B*--D*
2657 ................................................................
2659 Bisecting between Z and D* would hit a single culprit commit Y*,
2660 and understanding why Y* was broken would probably be easier.
2662 Partly for this reason, many experienced git users, even when
2663 working on an otherwise merge-heavy project, keep the history
2664 linear by rebasing against the latest upstream version before
2665 publishing.
2667 [[advanced-branch-management]]
2668 Advanced branch management
2669 ==========================
2671 [[fetching-individual-branches]]
2672 Fetching individual branches
2673 ----------------------------
2675 Instead of using linkgit:git-remote[1], you can also choose just
2676 to update one branch at a time, and to store it locally under an
2677 arbitrary name:
2679 -------------------------------------------------
2680 $ git fetch origin todo:my-todo-work
2681 -------------------------------------------------
2683 The first argument, "origin", just tells git to fetch from the
2684 repository you originally cloned from.  The second argument tells git
2685 to fetch the branch named "todo" from the remote repository, and to
2686 store it locally under the name refs/heads/my-todo-work.
2688 You can also fetch branches from other repositories; so
2690 -------------------------------------------------
2691 $ git fetch git://example.com/proj.git master:example-master
2692 -------------------------------------------------
2694 will create a new branch named "example-master" and store in it the
2695 branch named "master" from the repository at the given URL.  If you
2696 already have a branch named example-master, it will attempt to
2697 <<fast-forwards,fast-forward>> to the commit given by example.com's
2698 master branch.  In more detail:
2700 [[fetch-fast-forwards]]
2701 git fetch and fast-forwards
2702 ---------------------------
2704 In the previous example, when updating an existing branch, "git
2705 fetch" checks to make sure that the most recent commit on the remote
2706 branch is a descendant of the most recent commit on your copy of the
2707 branch before updating your copy of the branch to point at the new
2708 commit.  Git calls this process a <<fast-forwards,fast forward>>.
2710 A fast forward looks something like this:
2712 ................................................
2713  o--o--o--o <-- old head of the branch
2714            \
2715             o--o--o <-- new head of the branch
2716 ................................................
2719 In some cases it is possible that the new head will *not* actually be
2720 a descendant of the old head.  For example, the developer may have
2721 realized she made a serious mistake, and decided to backtrack,
2722 resulting in a situation like:
2724 ................................................
2725  o--o--o--o--a--b <-- old head of the branch
2726            \
2727             o--o--o <-- new head of the branch
2728 ................................................
2730 In this case, "git fetch" will fail, and print out a warning.
2732 In that case, you can still force git to update to the new head, as
2733 described in the following section.  However, note that in the
2734 situation above this may mean losing the commits labeled "a" and "b",
2735 unless you've already created a reference of your own pointing to
2736 them.
2738 [[forcing-fetch]]
2739 Forcing git fetch to do non-fast-forward updates
2740 ------------------------------------------------
2742 If git fetch fails because the new head of a branch is not a
2743 descendant of the old head, you may force the update with:
2745 -------------------------------------------------
2746 $ git fetch git://example.com/proj.git +master:refs/remotes/example/master
2747 -------------------------------------------------
2749 Note the addition of the "+" sign.  Alternatively, you can use the "-f"
2750 flag to force updates of all the fetched branches, as in:
2752 -------------------------------------------------
2753 $ git fetch -f origin
2754 -------------------------------------------------
2756 Be aware that commits that the old version of example/master pointed at
2757 may be lost, as we saw in the previous section.
2759 [[remote-branch-configuration]]
2760 Configuring remote branches
2761 ---------------------------
2763 We saw above that "origin" is just a shortcut to refer to the
2764 repository that you originally cloned from.  This information is
2765 stored in git configuration variables, which you can see using
2766 linkgit:git-config[1]:
2768 -------------------------------------------------
2769 $ git config -l
2770 core.repositoryformatversion=0
2771 core.filemode=true
2772 core.logallrefupdates=true
2773 remote.origin.url=git://git.kernel.org/pub/scm/git/git.git
2774 remote.origin.fetch=+refs/heads/*:refs/remotes/origin/*
2775 branch.master.remote=origin
2776 branch.master.merge=refs/heads/master
2777 -------------------------------------------------
2779 If there are other repositories that you also use frequently, you can
2780 create similar configuration options to save typing; for example,
2781 after
2783 -------------------------------------------------
2784 $ git config remote.example.url git://example.com/proj.git
2785 -------------------------------------------------
2787 then the following two commands will do the same thing:
2789 -------------------------------------------------
2790 $ git fetch git://example.com/proj.git master:refs/remotes/example/master
2791 $ git fetch example master:refs/remotes/example/master
2792 -------------------------------------------------
2794 Even better, if you add one more option:
2796 -------------------------------------------------
2797 $ git config remote.example.fetch master:refs/remotes/example/master
2798 -------------------------------------------------
2800 then the following commands will all do the same thing:
2802 -------------------------------------------------
2803 $ git fetch git://example.com/proj.git master:refs/remotes/example/master
2804 $ git fetch example master:refs/remotes/example/master
2805 $ git fetch example
2806 -------------------------------------------------
2808 You can also add a "+" to force the update each time:
2810 -------------------------------------------------
2811 $ git config remote.example.fetch +master:ref/remotes/example/master
2812 -------------------------------------------------
2814 Don't do this unless you're sure you won't mind "git fetch" possibly
2815 throwing away commits on mybranch.
2817 Also note that all of the above configuration can be performed by
2818 directly editing the file .git/config instead of using
2819 linkgit:git-config[1].
2821 See linkgit:git-config[1] for more details on the configuration
2822 options mentioned above.
2825 [[git-concepts]]
2826 Git concepts
2827 ============
2829 Git is built on a small number of simple but powerful ideas.  While it
2830 is possible to get things done without understanding them, you will find
2831 git much more intuitive if you do.
2833 We start with the most important, the  <<def_object_database,object
2834 database>> and the <<def_index,index>>.
2836 [[the-object-database]]
2837 The Object Database
2838 -------------------
2841 We already saw in <<understanding-commits>> that all commits are stored
2842 under a 40-digit "object name".  In fact, all the information needed to
2843 represent the history of a project is stored in objects with such names.
2844 In each case the name is calculated by taking the SHA1 hash of the
2845 contents of the object.  The SHA1 hash is a cryptographic hash function.
2846 What that means to us is that it is impossible to find two different
2847 objects with the same name.  This has a number of advantages; among
2848 others:
2850 - Git can quickly determine whether two objects are identical or not,
2851   just by comparing names.
2852 - Since object names are computed the same way in every repository, the
2853   same content stored in two repositories will always be stored under
2854   the same name.
2855 - Git can detect errors when it reads an object, by checking that the
2856   object's name is still the SHA1 hash of its contents.
2858 (See <<object-details>> for the details of the object formatting and
2859 SHA1 calculation.)
2861 There are four different types of objects: "blob", "tree", "commit", and
2862 "tag".
2864 - A <<def_blob_object,"blob" object>> is used to store file data.
2865 - A <<def_tree_object,"tree" object>> is an object that ties one or more
2866   "blob" objects into a directory structure. In addition, a tree object
2867   can refer to other tree objects, thus creating a directory hierarchy.
2868 - A <<def_commit_object,"commit" object>> ties such directory hierarchies
2869   together into a <<def_DAG,directed acyclic graph>> of revisions--each
2870   commit contains the object name of exactly one tree designating the
2871   directory hierarchy at the time of the commit. In addition, a commit
2872   refers to "parent" commit objects that describe the history of how we
2873   arrived at that directory hierarchy.
2874 - A <<def_tag_object,"tag" object>> symbolically identifies and can be
2875   used to sign other objects. It contains the object name and type of
2876   another object, a symbolic name (of course!) and, optionally, a
2877   signature.
2879 The object types in some more detail:
2881 [[commit-object]]
2882 Commit Object
2883 ~~~~~~~~~~~~~
2885 The "commit" object links a physical state of a tree with a description
2886 of how we got there and why.  Use the --pretty=raw option to
2887 linkgit:git-show[1] or linkgit:git-log[1] to examine your favorite
2888 commit:
2890 ------------------------------------------------
2891 $ git show -s --pretty=raw 2be7fcb476
2892 commit 2be7fcb4764f2dbcee52635b91fedb1b3dcf7ab4
2893 tree fb3a8bdd0ceddd019615af4d57a53f43d8cee2bf
2894 parent 257a84d9d02e90447b149af58b271c19405edb6a
2895 author Dave Watson <dwatson@mimvista.com> 1187576872 -0400
2896 committer Junio C Hamano <gitster@pobox.com> 1187591163 -0700
2898     Fix misspelling of 'suppress' in docs
2900     Signed-off-by: Junio C Hamano <gitster@pobox.com>
2901 ------------------------------------------------
2903 As you can see, a commit is defined by:
2905 - a tree: The SHA1 name of a tree object (as defined below), representing
2906   the contents of a directory at a certain point in time.
2907 - parent(s): The SHA1 name of some number of commits which represent the
2908   immediately previous step(s) in the history of the project.  The
2909   example above has one parent; merge commits may have more than
2910   one.  A commit with no parents is called a "root" commit, and
2911   represents the initial revision of a project.  Each project must have
2912   at least one root.  A project can also have multiple roots, though
2913   that isn't common (or necessarily a good idea).
2914 - an author: The name of the person responsible for this change, together
2915   with its date.
2916 - a committer: The name of the person who actually created the commit,
2917   with the date it was done.  This may be different from the author, for
2918   example, if the author was someone who wrote a patch and emailed it
2919   to the person who used it to create the commit.
2920 - a comment describing this commit.
2922 Note that a commit does not itself contain any information about what
2923 actually changed; all changes are calculated by comparing the contents
2924 of the tree referred to by this commit with the trees associated with
2925 its parents.  In particular, git does not attempt to record file renames
2926 explicitly, though it can identify cases where the existence of the same
2927 file data at changing paths suggests a rename.  (See, for example, the
2928 -M option to linkgit:git-diff[1]).
2930 A commit is usually created by linkgit:git-commit[1], which creates a
2931 commit whose parent is normally the current HEAD, and whose tree is
2932 taken from the content currently stored in the index.
2934 [[tree-object]]
2935 Tree Object
2936 ~~~~~~~~~~~
2938 The ever-versatile linkgit:git-show[1] command can also be used to
2939 examine tree objects, but linkgit:git-ls-tree[1] will give you more
2940 details:
2942 ------------------------------------------------
2943 $ git ls-tree fb3a8bdd0ce
2944 100644 blob 63c918c667fa005ff12ad89437f2fdc80926e21c    .gitignore
2945 100644 blob 5529b198e8d14decbe4ad99db3f7fb632de0439d    .mailmap
2946 100644 blob 6ff87c4664981e4397625791c8ea3bbb5f2279a3    COPYING
2947 040000 tree 2fb783e477100ce076f6bf57e4a6f026013dc745    Documentation
2948 100755 blob 3c0032cec592a765692234f1cba47dfdcc3a9200    GIT-VERSION-GEN
2949 100644 blob 289b046a443c0647624607d471289b2c7dcd470b    INSTALL
2950 100644 blob 4eb463797adc693dc168b926b6932ff53f17d0b1    Makefile
2951 100644 blob 548142c327a6790ff8821d67c2ee1eff7a656b52    README
2953 ------------------------------------------------
2955 As you can see, a tree object contains a list of entries, each with a
2956 mode, object type, SHA1 name, and name, sorted by name.  It represents
2957 the contents of a single directory tree.
2959 The object type may be a blob, representing the contents of a file, or
2960 another tree, representing the contents of a subdirectory.  Since trees
2961 and blobs, like all other objects, are named by the SHA1 hash of their
2962 contents, two trees have the same SHA1 name if and only if their
2963 contents (including, recursively, the contents of all subdirectories)
2964 are identical.  This allows git to quickly determine the differences
2965 between two related tree objects, since it can ignore any entries with
2966 identical object names.
2968 (Note: in the presence of submodules, trees may also have commits as
2969 entries.  See <<submodules>> for documentation.)
2971 Note that the files all have mode 644 or 755: git actually only pays
2972 attention to the executable bit.
2974 [[blob-object]]
2975 Blob Object
2976 ~~~~~~~~~~~
2978 You can use linkgit:git-show[1] to examine the contents of a blob; take,
2979 for example, the blob in the entry for "COPYING" from the tree above:
2981 ------------------------------------------------
2982 $ git show 6ff87c4664
2984  Note that the only valid version of the GPL as far as this project
2985  is concerned is _this_ particular version of the license (ie v2, not
2986  v2.2 or v3.x or whatever), unless explicitly otherwise stated.
2988 ------------------------------------------------
2990 A "blob" object is nothing but a binary blob of data.  It doesn't refer
2991 to anything else or have attributes of any kind.
2993 Since the blob is entirely defined by its data, if two files in a
2994 directory tree (or in multiple different versions of the repository)
2995 have the same contents, they will share the same blob object. The object
2996 is totally independent of its location in the directory tree, and
2997 renaming a file does not change the object that file is associated with.
2999 Note that any tree or blob object can be examined using
3000 linkgit:git-show[1] with the <revision>:<path> syntax.  This can
3001 sometimes be useful for browsing the contents of a tree that is not
3002 currently checked out.
3004 [[trust]]
3005 Trust
3006 ~~~~~
3008 If you receive the SHA1 name of a blob from one source, and its contents
3009 from another (possibly untrusted) source, you can still trust that those
3010 contents are correct as long as the SHA1 name agrees.  This is because
3011 the SHA1 is designed so that it is infeasible to find different contents
3012 that produce the same hash.
3014 Similarly, you need only trust the SHA1 name of a top-level tree object
3015 to trust the contents of the entire directory that it refers to, and if
3016 you receive the SHA1 name of a commit from a trusted source, then you
3017 can easily verify the entire history of commits reachable through
3018 parents of that commit, and all of those contents of the trees referred
3019 to by those commits.
3021 So to introduce some real trust in the system, the only thing you need
3022 to do is to digitally sign just 'one' special note, which includes the
3023 name of a top-level commit.  Your digital signature shows others
3024 that you trust that commit, and the immutability of the history of
3025 commits tells others that they can trust the whole history.
3027 In other words, you can easily validate a whole archive by just
3028 sending out a single email that tells the people the name (SHA1 hash)
3029 of the top commit, and digitally sign that email using something
3030 like GPG/PGP.
3032 To assist in this, git also provides the tag object...
3034 [[tag-object]]
3035 Tag Object
3036 ~~~~~~~~~~
3038 A tag object contains an object, object type, tag name, the name of the
3039 person ("tagger") who created the tag, and a message, which may contain
3040 a signature, as can be seen using the linkgit:git-cat-file[1]:
3042 ------------------------------------------------
3043 $ git cat-file tag v1.5.0
3044 object 437b1b20df4b356c9342dac8d38849f24ef44f27
3045 type commit
3046 tag v1.5.0
3047 tagger Junio C Hamano <junkio@cox.net> 1171411200 +0000
3049 GIT 1.5.0
3050 -----BEGIN PGP SIGNATURE-----
3051 Version: GnuPG v1.4.6 (GNU/Linux)
3053 iD8DBQBF0lGqwMbZpPMRm5oRAuRiAJ9ohBLd7s2kqjkKlq1qqC57SbnmzQCdG4ui
3054 nLE/L9aUXdWeTFPron96DLA=
3055 =2E+0
3056 -----END PGP SIGNATURE-----
3057 ------------------------------------------------
3059 See the linkgit:git-tag[1] command to learn how to create and verify tag
3060 objects.  (Note that linkgit:git-tag[1] can also be used to create
3061 "lightweight tags", which are not tag objects at all, but just simple
3062 references whose names begin with "refs/tags/").
3064 [[pack-files]]
3065 How git stores objects efficiently: pack files
3066 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3068 Newly created objects are initially created in a file named after the
3069 object's SHA1 hash (stored in .git/objects).
3071 Unfortunately this system becomes inefficient once a project has a
3072 lot of objects.  Try this on an old project:
3074 ------------------------------------------------
3075 $ git count-objects
3076 6930 objects, 47620 kilobytes
3077 ------------------------------------------------
3079 The first number is the number of objects which are kept in
3080 individual files.  The second is the amount of space taken up by
3081 those "loose" objects.
3083 You can save space and make git faster by moving these loose objects in
3084 to a "pack file", which stores a group of objects in an efficient
3085 compressed format; the details of how pack files are formatted can be
3086 found in link:technical/pack-format.txt[technical/pack-format.txt].
3088 To put the loose objects into a pack, just run git repack:
3090 ------------------------------------------------
3091 $ git repack
3092 Generating pack...
3093 Done counting 6020 objects.
3094 Deltifying 6020 objects.
3095  100% (6020/6020) done
3096 Writing 6020 objects.
3097  100% (6020/6020) done
3098 Total 6020, written 6020 (delta 4070), reused 0 (delta 0)
3099 Pack pack-3e54ad29d5b2e05838c75df582c65257b8d08e1c created.
3100 ------------------------------------------------
3102 You can then run
3104 ------------------------------------------------
3105 $ git prune
3106 ------------------------------------------------
3108 to remove any of the "loose" objects that are now contained in the
3109 pack.  This will also remove any unreferenced objects (which may be
3110 created when, for example, you use "git reset" to remove a commit).
3111 You can verify that the loose objects are gone by looking at the
3112 .git/objects directory or by running
3114 ------------------------------------------------
3115 $ git count-objects
3116 0 objects, 0 kilobytes
3117 ------------------------------------------------
3119 Although the object files are gone, any commands that refer to those
3120 objects will work exactly as they did before.
3122 The linkgit:git-gc[1] command performs packing, pruning, and more for
3123 you, so is normally the only high-level command you need.
3125 [[dangling-objects]]
3126 Dangling objects
3127 ~~~~~~~~~~~~~~~~
3129 The linkgit:git-fsck[1] command will sometimes complain about dangling
3130 objects.  They are not a problem.
3132 The most common cause of dangling objects is that you've rebased a
3133 branch, or you have pulled from somebody else who rebased a branch--see
3134 <<cleaning-up-history>>.  In that case, the old head of the original
3135 branch still exists, as does everything it pointed to. The branch
3136 pointer itself just doesn't, since you replaced it with another one.
3138 There are also other situations that cause dangling objects. For
3139 example, a "dangling blob" may arise because you did a "git add" of a
3140 file, but then, before you actually committed it and made it part of the
3141 bigger picture, you changed something else in that file and committed
3142 that *updated* thing--the old state that you added originally ends up
3143 not being pointed to by any commit or tree, so it's now a dangling blob
3144 object.
3146 Similarly, when the "recursive" merge strategy runs, and finds that
3147 there are criss-cross merges and thus more than one merge base (which is
3148 fairly unusual, but it does happen), it will generate one temporary
3149 midway tree (or possibly even more, if you had lots of criss-crossing
3150 merges and more than two merge bases) as a temporary internal merge
3151 base, and again, those are real objects, but the end result will not end
3152 up pointing to them, so they end up "dangling" in your repository.
3154 Generally, dangling objects aren't anything to worry about. They can
3155 even be very useful: if you screw something up, the dangling objects can
3156 be how you recover your old tree (say, you did a rebase, and realized
3157 that you really didn't want to--you can look at what dangling objects
3158 you have, and decide to reset your head to some old dangling state).
3160 For commits, you can just use:
3162 ------------------------------------------------
3163 $ gitk <dangling-commit-sha-goes-here> --not --all
3164 ------------------------------------------------
3166 This asks for all the history reachable from the given commit but not
3167 from any branch, tag, or other reference.  If you decide it's something
3168 you want, you can always create a new reference to it, e.g.,
3170 ------------------------------------------------
3171 $ git branch recovered-branch <dangling-commit-sha-goes-here>
3172 ------------------------------------------------
3174 For blobs and trees, you can't do the same, but you can still examine
3175 them.  You can just do
3177 ------------------------------------------------
3178 $ git show <dangling-blob/tree-sha-goes-here>
3179 ------------------------------------------------
3181 to show what the contents of the blob were (or, for a tree, basically
3182 what the "ls" for that directory was), and that may give you some idea
3183 of what the operation was that left that dangling object.
3185 Usually, dangling blobs and trees aren't very interesting. They're
3186 almost always the result of either being a half-way mergebase (the blob
3187 will often even have the conflict markers from a merge in it, if you
3188 have had conflicting merges that you fixed up by hand), or simply
3189 because you interrupted a "git fetch" with ^C or something like that,
3190 leaving _some_ of the new objects in the object database, but just
3191 dangling and useless.
3193 Anyway, once you are sure that you're not interested in any dangling
3194 state, you can just prune all unreachable objects:
3196 ------------------------------------------------
3197 $ git prune
3198 ------------------------------------------------
3200 and they'll be gone. But you should only run "git prune" on a quiescent
3201 repository--it's kind of like doing a filesystem fsck recovery: you
3202 don't want to do that while the filesystem is mounted.
3204 (The same is true of "git-fsck" itself, btw, but since
3205 git-fsck never actually *changes* the repository, it just reports
3206 on what it found, git-fsck itself is never "dangerous" to run.
3207 Running it while somebody is actually changing the repository can cause
3208 confusing and scary messages, but it won't actually do anything bad. In
3209 contrast, running "git prune" while somebody is actively changing the
3210 repository is a *BAD* idea).
3212 [[recovering-from-repository-corruption]]
3213 Recovering from repository corruption
3214 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3216 By design, git treats data trusted to it with caution.  However, even in
3217 the absence of bugs in git itself, it is still possible that hardware or
3218 operating system errors could corrupt data.
3220 The first defense against such problems is backups.  You can back up a
3221 git directory using clone, or just using cp, tar, or any other backup
3222 mechanism.
3224 As a last resort, you can search for the corrupted objects and attempt
3225 to replace them by hand.  Back up your repository before attempting this
3226 in case you corrupt things even more in the process.
3228 We'll assume that the problem is a single missing or corrupted blob,
3229 which is sometimes a solvable problem.  (Recovering missing trees and
3230 especially commits is *much* harder).
3232 Before starting, verify that there is corruption, and figure out where
3233 it is with linkgit:git-fsck[1]; this may be time-consuming.
3235 Assume the output looks like this:
3237 ------------------------------------------------
3238 $ git-fsck --full
3239 broken link from    tree 2d9263c6d23595e7cb2a21e5ebbb53655278dff8
3240               to    blob 4b9458b3786228369c63936db65827de3cc06200
3241 missing blob 4b9458b3786228369c63936db65827de3cc06200
3242 ------------------------------------------------
3244 (Typically there will be some "dangling object" messages too, but they
3245 aren't interesting.)
3247 Now you know that blob 4b9458b3 is missing, and that the tree 2d9263c6
3248 points to it.  If you could find just one copy of that missing blob
3249 object, possibly in some other repository, you could move it into
3250 .git/objects/4b/9458b3... and be done.  Suppose you can't.  You can
3251 still examine the tree that pointed to it with linkgit:git-ls-tree[1],
3252 which might output something like:
3254 ------------------------------------------------
3255 $ git ls-tree 2d9263c6d23595e7cb2a21e5ebbb53655278dff8
3256 100644 blob 8d14531846b95bfa3564b58ccfb7913a034323b8    .gitignore
3257 100644 blob ebf9bf84da0aab5ed944264a5db2a65fe3a3e883    .mailmap
3258 100644 blob ca442d313d86dc67e0a2e5d584b465bd382cbf5c    COPYING
3260 100644 blob 4b9458b3786228369c63936db65827de3cc06200    myfile
3262 ------------------------------------------------
3264 So now you know that the missing blob was the data for a file named
3265 "myfile".  And chances are you can also identify the directory--let's
3266 say it's in "somedirectory".  If you're lucky the missing copy might be
3267 the same as the copy you have checked out in your working tree at
3268 "somedirectory/myfile"; you can test whether that's right with
3269 linkgit:git-hash-object[1]:
3271 ------------------------------------------------
3272 $ git hash-object -w somedirectory/myfile
3273 ------------------------------------------------
3275 which will create and store a blob object with the contents of
3276 somedirectory/myfile, and output the sha1 of that object.  if you're
3277 extremely lucky it might be 4b9458b3786228369c63936db65827de3cc06200, in
3278 which case you've guessed right, and the corruption is fixed!
3280 Otherwise, you need more information.  How do you tell which version of
3281 the file has been lost?
3283 The easiest way to do this is with:
3285 ------------------------------------------------
3286 $ git log --raw --all --full-history -- somedirectory/myfile
3287 ------------------------------------------------
3289 Because you're asking for raw output, you'll now get something like
3291 ------------------------------------------------
3292 commit abc
3293 Author:
3294 Date:
3296 :100644 100644 4b9458b... newsha... M somedirectory/myfile
3299 commit xyz
3300 Author:
3301 Date:
3304 :100644 100644 oldsha... 4b9458b... M somedirectory/myfile
3305 ------------------------------------------------
3307 This tells you that the immediately preceding version of the file was
3308 "newsha", and that the immediately following version was "oldsha".
3309 You also know the commit messages that went with the change from oldsha
3310 to 4b9458b and with the change from 4b9458b to newsha.
3312 If you've been committing small enough changes, you may now have a good
3313 shot at reconstructing the contents of the in-between state 4b9458b.
3315 If you can do that, you can now recreate the missing object with
3317 ------------------------------------------------
3318 $ git hash-object -w <recreated-file>
3319 ------------------------------------------------
3321 and your repository is good again!
3323 (Btw, you could have ignored the fsck, and started with doing a
3325 ------------------------------------------------
3326 $ git log --raw --all
3327 ------------------------------------------------
3329 and just looked for the sha of the missing object (4b9458b..) in that
3330 whole thing. It's up to you - git does *have* a lot of information, it is
3331 just missing one particular blob version.
3333 [[the-index]]
3334 The index
3335 -----------
3337 The index is a binary file (generally kept in .git/index) containing a
3338 sorted list of path names, each with permissions and the SHA1 of a blob
3339 object; linkgit:git-ls-files[1] can show you the contents of the index:
3341 -------------------------------------------------
3342 $ git ls-files --stage
3343 100644 63c918c667fa005ff12ad89437f2fdc80926e21c 0       .gitignore
3344 100644 5529b198e8d14decbe4ad99db3f7fb632de0439d 0       .mailmap
3345 100644 6ff87c4664981e4397625791c8ea3bbb5f2279a3 0       COPYING
3346 100644 a37b2152bd26be2c2289e1f57a292534a51a93c7 0       Documentation/.gitignore
3347 100644 fbefe9a45b00a54b58d94d06eca48b03d40a50e0 0       Documentation/Makefile
3349 100644 2511aef8d89ab52be5ec6a5e46236b4b6bcd07ea 0       xdiff/xtypes.h
3350 100644 2ade97b2574a9f77e7ae4002a4e07a6a38e46d07 0       xdiff/xutils.c
3351 100644 d5de8292e05e7c36c4b68857c1cf9855e3d2f70a 0       xdiff/xutils.h
3352 -------------------------------------------------
3354 Note that in older documentation you may see the index called the
3355 "current directory cache" or just the "cache".  It has three important
3356 properties:
3358 1. The index contains all the information necessary to generate a single
3359 (uniquely determined) tree object.
3361 For example, running linkgit:git-commit[1] generates this tree object
3362 from the index, stores it in the object database, and uses it as the
3363 tree object associated with the new commit.
3365 2. The index enables fast comparisons between the tree object it defines
3366 and the working tree.
3368 It does this by storing some additional data for each entry (such as
3369 the last modified time).  This data is not displayed above, and is not
3370 stored in the created tree object, but it can be used to determine
3371 quickly which files in the working directory differ from what was
3372 stored in the index, and thus save git from having to read all of the
3373 data from such files to look for changes.
3375 3. It can efficiently represent information about merge conflicts
3376 between different tree objects, allowing each pathname to be
3377 associated with sufficient information about the trees involved that
3378 you can create a three-way merge between them.
3380 We saw in <<conflict-resolution>> that during a merge the index can
3381 store multiple versions of a single file (called "stages").  The third
3382 column in the linkgit:git-ls-files[1] output above is the stage
3383 number, and will take on values other than 0 for files with merge
3384 conflicts.
3386 The index is thus a sort of temporary staging area, which is filled with
3387 a tree which you are in the process of working on.
3389 If you blow the index away entirely, you generally haven't lost any
3390 information as long as you have the name of the tree that it described.
3392 [[submodules]]
3393 Submodules
3394 ==========
3396 Large projects are often composed of smaller, self-contained modules.  For
3397 example, an embedded Linux distribution's source tree would include every
3398 piece of software in the distribution with some local modifications; a movie
3399 player might need to build against a specific, known-working version of a
3400 decompression library; several independent programs might all share the same
3401 build scripts.
3403 With centralized revision control systems this is often accomplished by
3404 including every module in one single repository.  Developers can check out
3405 all modules or only the modules they need to work with.  They can even modify
3406 files across several modules in a single commit while moving things around
3407 or updating APIs and translations.
3409 Git does not allow partial checkouts, so duplicating this approach in Git
3410 would force developers to keep a local copy of modules they are not
3411 interested in touching.  Commits in an enormous checkout would be slower
3412 than you'd expect as Git would have to scan every directory for changes.
3413 If modules have a lot of local history, clones would take forever.
3415 On the plus side, distributed revision control systems can much better
3416 integrate with external sources.  In a centralized model, a single arbitrary
3417 snapshot of the external project is exported from its own revision control
3418 and then imported into the local revision control on a vendor branch.  All
3419 the history is hidden.  With distributed revision control you can clone the
3420 entire external history and much more easily follow development and re-merge
3421 local changes.
3423 Git's submodule support allows a repository to contain, as a subdirectory, a
3424 checkout of an external project.  Submodules maintain their own identity;
3425 the submodule support just stores the submodule repository location and
3426 commit ID, so other developers who clone the containing project
3427 ("superproject") can easily clone all the submodules at the same revision.
3428 Partial checkouts of the superproject are possible: you can tell Git to
3429 clone none, some or all of the submodules.
3431 The linkgit:git-submodule[1] command is available since Git 1.5.3.  Users
3432 with Git 1.5.2 can look up the submodule commits in the repository and
3433 manually check them out; earlier versions won't recognize the submodules at
3434 all.
3436 To see how submodule support works, create (for example) four example
3437 repositories that can be used later as a submodule:
3439 -------------------------------------------------
3440 $ mkdir ~/git
3441 $ cd ~/git
3442 $ for i in a b c d
3444         mkdir $i
3445         cd $i
3446         git init
3447         echo "module $i" > $i.txt
3448         git add $i.txt
3449         git commit -m "Initial commit, submodule $i"
3450         cd ..
3451 done
3452 -------------------------------------------------
3454 Now create the superproject and add all the submodules:
3456 -------------------------------------------------
3457 $ mkdir super
3458 $ cd super
3459 $ git init
3460 $ for i in a b c d
3462         git submodule add ~/git/$i
3463 done
3464 -------------------------------------------------
3466 NOTE: Do not use local URLs here if you plan to publish your superproject!
3468 See what files `git submodule` created:
3470 -------------------------------------------------
3471 $ ls -a
3472 .  ..  .git  .gitmodules  a  b  c  d
3473 -------------------------------------------------
3475 The `git submodule add` command does a couple of things:
3477 - It clones the submodule under the current directory and by default checks out
3478   the master branch.
3479 - It adds the submodule's clone path to the linkgit:gitmodules[5] file and
3480   adds this file to the index, ready to be committed.
3481 - It adds the submodule's current commit ID to the index, ready to be
3482   committed.
3484 Commit the superproject:
3486 -------------------------------------------------
3487 $ git commit -m "Add submodules a, b, c and d."
3488 -------------------------------------------------
3490 Now clone the superproject:
3492 -------------------------------------------------
3493 $ cd ..
3494 $ git clone super cloned
3495 $ cd cloned
3496 -------------------------------------------------
3498 The submodule directories are there, but they're empty:
3500 -------------------------------------------------
3501 $ ls -a a
3502 .  ..
3503 $ git submodule status
3504 -d266b9873ad50488163457f025db7cdd9683d88b a
3505 -e81d457da15309b4fef4249aba9b50187999670d b
3506 -c1536a972b9affea0f16e0680ba87332dc059146 c
3507 -d96249ff5d57de5de093e6baff9e0aafa5276a74 d
3508 -------------------------------------------------
3510 NOTE: The commit object names shown above would be different for you, but they
3511 should match the HEAD commit object names of your repositories.  You can check
3512 it by running `git ls-remote ../a`.
3514 Pulling down the submodules is a two-step process. First run `git submodule
3515 init` to add the submodule repository URLs to `.git/config`:
3517 -------------------------------------------------
3518 $ git submodule init
3519 -------------------------------------------------
3521 Now use `git submodule update` to clone the repositories and check out the
3522 commits specified in the superproject:
3524 -------------------------------------------------
3525 $ git submodule update
3526 $ cd a
3527 $ ls -a
3528 .  ..  .git  a.txt
3529 -------------------------------------------------
3531 One major difference between `git submodule update` and `git submodule add` is
3532 that `git submodule update` checks out a specific commit, rather than the tip
3533 of a branch. It's like checking out a tag: the head is detached, so you're not
3534 working on a branch.
3536 -------------------------------------------------
3537 $ git branch
3538 * (no branch)
3539   master
3540 -------------------------------------------------
3542 If you want to make a change within a submodule and you have a detached head,
3543 then you should create or checkout a branch, make your changes, publish the
3544 change within the submodule, and then update the superproject to reference the
3545 new commit:
3547 -------------------------------------------------
3548 $ git checkout master
3549 -------------------------------------------------
3553 -------------------------------------------------
3554 $ git checkout -b fix-up
3555 -------------------------------------------------
3557 then
3559 -------------------------------------------------
3560 $ echo "adding a line again" >> a.txt
3561 $ git commit -a -m "Updated the submodule from within the superproject."
3562 $ git push
3563 $ cd ..
3564 $ git diff
3565 diff --git a/a b/a
3566 index d266b98..261dfac 160000
3567 --- a/a
3568 +++ b/a
3569 @@ -1 +1 @@
3570 -Subproject commit d266b9873ad50488163457f025db7cdd9683d88b
3571 +Subproject commit 261dfac35cb99d380eb966e102c1197139f7fa24
3572 $ git add a
3573 $ git commit -m "Updated submodule a."
3574 $ git push
3575 -------------------------------------------------
3577 You have to run `git submodule update` after `git pull` if you want to update
3578 submodules, too.
3580 Pitfalls with submodules
3581 ------------------------
3583 Always publish the submodule change before publishing the change to the
3584 superproject that references it. If you forget to publish the submodule change,
3585 others won't be able to clone the repository:
3587 -------------------------------------------------
3588 $ cd ~/git/super/a
3589 $ echo i added another line to this file >> a.txt
3590 $ git commit -a -m "doing it wrong this time"
3591 $ cd ..
3592 $ git add a
3593 $ git commit -m "Updated submodule a again."
3594 $ git push
3595 $ cd ~/git/cloned
3596 $ git pull
3597 $ git submodule update
3598 error: pathspec '261dfac35cb99d380eb966e102c1197139f7fa24' did not match any file(s) known to git.
3599 Did you forget to 'git add'?
3600 Unable to checkout '261dfac35cb99d380eb966e102c1197139f7fa24' in submodule path 'a'
3601 -------------------------------------------------
3603 You also should not rewind branches in a submodule beyond commits that were
3604 ever recorded in any superproject.
3606 It's not safe to run `git submodule update` if you've made and committed
3607 changes within a submodule without checking out a branch first. They will be
3608 silently overwritten:
3610 -------------------------------------------------
3611 $ cat a.txt
3612 module a
3613 $ echo line added from private2 >> a.txt
3614 $ git commit -a -m "line added inside private2"
3615 $ cd ..
3616 $ git submodule update
3617 Submodule path 'a': checked out 'd266b9873ad50488163457f025db7cdd9683d88b'
3618 $ cd a
3619 $ cat a.txt
3620 module a
3621 -------------------------------------------------
3623 NOTE: The changes are still visible in the submodule's reflog.
3625 This is not the case if you did not commit your changes.
3627 [[low-level-operations]]
3628 Low-level git operations
3629 ========================
3631 Many of the higher-level commands were originally implemented as shell
3632 scripts using a smaller core of low-level git commands.  These can still
3633 be useful when doing unusual things with git, or just as a way to
3634 understand its inner workings.
3636 [[object-manipulation]]
3637 Object access and manipulation
3638 ------------------------------
3640 The linkgit:git-cat-file[1] command can show the contents of any object,
3641 though the higher-level linkgit:git-show[1] is usually more useful.
3643 The linkgit:git-commit-tree[1] command allows constructing commits with
3644 arbitrary parents and trees.
3646 A tree can be created with linkgit:git-write-tree[1] and its data can be
3647 accessed by linkgit:git-ls-tree[1].  Two trees can be compared with
3648 linkgit:git-diff-tree[1].
3650 A tag is created with linkgit:git-mktag[1], and the signature can be
3651 verified by linkgit:git-verify-tag[1], though it is normally simpler to
3652 use linkgit:git-tag[1] for both.
3654 [[the-workflow]]
3655 The Workflow
3656 ------------
3658 High-level operations such as linkgit:git-commit[1],
3659 linkgit:git-checkout[1] and linkgit:git-reset[1] work by moving data
3660 between the working tree, the index, and the object database.  Git
3661 provides low-level operations which perform each of these steps
3662 individually.
3664 Generally, all "git" operations work on the index file. Some operations
3665 work *purely* on the index file (showing the current state of the
3666 index), but most operations move data between the index file and either
3667 the database or the working directory. Thus there are four main
3668 combinations:
3670 [[working-directory-to-index]]
3671 working directory -> index
3672 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3674 The linkgit:git-update-index[1] command updates the index with
3675 information from the working directory.  You generally update the
3676 index information by just specifying the filename you want to update,
3677 like so:
3679 -------------------------------------------------
3680 $ git update-index filename
3681 -------------------------------------------------
3683 but to avoid common mistakes with filename globbing etc, the command
3684 will not normally add totally new entries or remove old entries,
3685 i.e. it will normally just update existing cache entries.
3687 To tell git that yes, you really do realize that certain files no
3688 longer exist, or that new files should be added, you
3689 should use the `--remove` and `--add` flags respectively.
3691 NOTE! A `--remove` flag does 'not' mean that subsequent filenames will
3692 necessarily be removed: if the files still exist in your directory
3693 structure, the index will be updated with their new status, not
3694 removed. The only thing `--remove` means is that update-index will be
3695 considering a removed file to be a valid thing, and if the file really
3696 does not exist any more, it will update the index accordingly.
3698 As a special case, you can also do `git-update-index --refresh`, which
3699 will refresh the "stat" information of each index to match the current
3700 stat information. It will 'not' update the object status itself, and
3701 it will only update the fields that are used to quickly test whether
3702 an object still matches its old backing store object.
3704 The previously introduced linkgit:git-add[1] is just a wrapper for
3705 linkgit:git-update-index[1].
3707 [[index-to-object-database]]
3708 index -> object database
3709 ~~~~~~~~~~~~~~~~~~~~~~~~
3711 You write your current index file to a "tree" object with the program
3713 -------------------------------------------------
3714 $ git write-tree
3715 -------------------------------------------------
3717 that doesn't come with any options--it will just write out the
3718 current index into the set of tree objects that describe that state,
3719 and it will return the name of the resulting top-level tree. You can
3720 use that tree to re-generate the index at any time by going in the
3721 other direction:
3723 [[object-database-to-index]]
3724 object database -> index
3725 ~~~~~~~~~~~~~~~~~~~~~~~~
3727 You read a "tree" file from the object database, and use that to
3728 populate (and overwrite--don't do this if your index contains any
3729 unsaved state that you might want to restore later!) your current
3730 index.  Normal operation is just
3732 -------------------------------------------------
3733 $ git-read-tree <sha1 of tree>
3734 -------------------------------------------------
3736 and your index file will now be equivalent to the tree that you saved
3737 earlier. However, that is only your 'index' file: your working
3738 directory contents have not been modified.
3740 [[index-to-working-directory]]
3741 index -> working directory
3742 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3744 You update your working directory from the index by "checking out"
3745 files. This is not a very common operation, since normally you'd just
3746 keep your files updated, and rather than write to your working
3747 directory, you'd tell the index files about the changes in your
3748 working directory (i.e. `git-update-index`).
3750 However, if you decide to jump to a new version, or check out somebody
3751 else's version, or just restore a previous tree, you'd populate your
3752 index file with read-tree, and then you need to check out the result
3753 with
3755 -------------------------------------------------
3756 $ git-checkout-index filename
3757 -------------------------------------------------
3759 or, if you want to check out all of the index, use `-a`.
3761 NOTE! git-checkout-index normally refuses to overwrite old files, so
3762 if you have an old version of the tree already checked out, you will
3763 need to use the "-f" flag ('before' the "-a" flag or the filename) to
3764 'force' the checkout.
3767 Finally, there are a few odds and ends which are not purely moving
3768 from one representation to the other:
3770 [[tying-it-all-together]]
3771 Tying it all together
3772 ~~~~~~~~~~~~~~~~~~~~~
3774 To commit a tree you have instantiated with "git-write-tree", you'd
3775 create a "commit" object that refers to that tree and the history
3776 behind it--most notably the "parent" commits that preceded it in
3777 history.
3779 Normally a "commit" has one parent: the previous state of the tree
3780 before a certain change was made. However, sometimes it can have two
3781 or more parent commits, in which case we call it a "merge", due to the
3782 fact that such a commit brings together ("merges") two or more
3783 previous states represented by other commits.
3785 In other words, while a "tree" represents a particular directory state
3786 of a working directory, a "commit" represents that state in "time",
3787 and explains how we got there.
3789 You create a commit object by giving it the tree that describes the
3790 state at the time of the commit, and a list of parents:
3792 -------------------------------------------------
3793 $ git-commit-tree <tree> -p <parent> [-p <parent2> ..]
3794 -------------------------------------------------
3796 and then giving the reason for the commit on stdin (either through
3797 redirection from a pipe or file, or by just typing it at the tty).
3799 git-commit-tree will return the name of the object that represents
3800 that commit, and you should save it away for later use. Normally,
3801 you'd commit a new `HEAD` state, and while git doesn't care where you
3802 save the note about that state, in practice we tend to just write the
3803 result to the file pointed at by `.git/HEAD`, so that we can always see
3804 what the last committed state was.
3806 Here is an ASCII art by Jon Loeliger that illustrates how
3807 various pieces fit together.
3809 ------------
3811                      commit-tree
3812                       commit obj
3813                        +----+
3814                        |    |
3815                        |    |
3816                        V    V
3817                     +-----------+
3818                     | Object DB |
3819                     |  Backing  |
3820                     |   Store   |
3821                     +-----------+
3822                        ^
3823            write-tree  |     |
3824              tree obj  |     |
3825                        |     |  read-tree
3826                        |     |  tree obj
3827                              V
3828                     +-----------+
3829                     |   Index   |
3830                     |  "cache"  |
3831                     +-----------+
3832          update-index  ^
3833              blob obj  |     |
3834                        |     |
3835     checkout-index -u  |     |  checkout-index
3836              stat      |     |  blob obj
3837                              V
3838                     +-----------+
3839                     |  Working  |
3840                     | Directory |
3841                     +-----------+
3843 ------------
3846 [[examining-the-data]]
3847 Examining the data
3848 ------------------
3850 You can examine the data represented in the object database and the
3851 index with various helper tools. For every object, you can use
3852 linkgit:git-cat-file[1] to examine details about the
3853 object:
3855 -------------------------------------------------
3856 $ git-cat-file -t <objectname>
3857 -------------------------------------------------
3859 shows the type of the object, and once you have the type (which is
3860 usually implicit in where you find the object), you can use
3862 -------------------------------------------------
3863 $ git-cat-file blob|tree|commit|tag <objectname>
3864 -------------------------------------------------
3866 to show its contents. NOTE! Trees have binary content, and as a result
3867 there is a special helper for showing that content, called
3868 `git-ls-tree`, which turns the binary content into a more easily
3869 readable form.
3871 It's especially instructive to look at "commit" objects, since those
3872 tend to be small and fairly self-explanatory. In particular, if you
3873 follow the convention of having the top commit name in `.git/HEAD`,
3874 you can do
3876 -------------------------------------------------
3877 $ git-cat-file commit HEAD
3878 -------------------------------------------------
3880 to see what the top commit was.
3882 [[merging-multiple-trees]]
3883 Merging multiple trees
3884 ----------------------
3886 Git helps you do a three-way merge, which you can expand to n-way by
3887 repeating the merge procedure arbitrary times until you finally
3888 "commit" the state.  The normal situation is that you'd only do one
3889 three-way merge (two parents), and commit it, but if you like to, you
3890 can do multiple parents in one go.
3892 To do a three-way merge, you need the two sets of "commit" objects
3893 that you want to merge, use those to find the closest common parent (a
3894 third "commit" object), and then use those commit objects to find the
3895 state of the directory ("tree" object) at these points.
3897 To get the "base" for the merge, you first look up the common parent
3898 of two commits with
3900 -------------------------------------------------
3901 $ git-merge-base <commit1> <commit2>
3902 -------------------------------------------------
3904 which will return you the commit they are both based on.  You should
3905 now look up the "tree" objects of those commits, which you can easily
3906 do with (for example)
3908 -------------------------------------------------
3909 $ git-cat-file commit <commitname> | head -1
3910 -------------------------------------------------
3912 since the tree object information is always the first line in a commit
3913 object.
3915 Once you know the three trees you are going to merge (the one "original"
3916 tree, aka the common tree, and the two "result" trees, aka the branches
3917 you want to merge), you do a "merge" read into the index. This will
3918 complain if it has to throw away your old index contents, so you should
3919 make sure that you've committed those--in fact you would normally
3920 always do a merge against your last commit (which should thus match what
3921 you have in your current index anyway).
3923 To do the merge, do
3925 -------------------------------------------------
3926 $ git-read-tree -m -u <origtree> <yourtree> <targettree>
3927 -------------------------------------------------
3929 which will do all trivial merge operations for you directly in the
3930 index file, and you can just write the result out with
3931 `git-write-tree`.
3934 [[merging-multiple-trees-2]]
3935 Merging multiple trees, continued
3936 ---------------------------------
3938 Sadly, many merges aren't trivial. If there are files that have
3939 been added, moved or removed, or if both branches have modified the
3940 same file, you will be left with an index tree that contains "merge
3941 entries" in it. Such an index tree can 'NOT' be written out to a tree
3942 object, and you will have to resolve any such merge clashes using
3943 other tools before you can write out the result.
3945 You can examine such index state with `git-ls-files --unmerged`
3946 command.  An example:
3948 ------------------------------------------------
3949 $ git-read-tree -m $orig HEAD $target
3950 $ git-ls-files --unmerged
3951 100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1       hello.c
3952 100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2       hello.c
3953 100644 cc44c73eb783565da5831b4d820c962954019b69 3       hello.c
3954 ------------------------------------------------
3956 Each line of the `git-ls-files --unmerged` output begins with
3957 the blob mode bits, blob SHA1, 'stage number', and the
3958 filename.  The 'stage number' is git's way to say which tree it
3959 came from: stage 1 corresponds to `$orig` tree, stage 2 `HEAD`
3960 tree, and stage3 `$target` tree.
3962 Earlier we said that trivial merges are done inside
3963 `git-read-tree -m`.  For example, if the file did not change
3964 from `$orig` to `HEAD` nor `$target`, or if the file changed
3965 from `$orig` to `HEAD` and `$orig` to `$target` the same way,
3966 obviously the final outcome is what is in `HEAD`.  What the
3967 above example shows is that file `hello.c` was changed from
3968 `$orig` to `HEAD` and `$orig` to `$target` in a different way.
3969 You could resolve this by running your favorite 3-way merge
3970 program, e.g.  `diff3`, `merge`, or git's own merge-file, on
3971 the blob objects from these three stages yourself, like this:
3973 ------------------------------------------------
3974 $ git-cat-file blob 263414f... >hello.c~1
3975 $ git-cat-file blob 06fa6a2... >hello.c~2
3976 $ git-cat-file blob cc44c73... >hello.c~3
3977 $ git merge-file hello.c~2 hello.c~1 hello.c~3
3978 ------------------------------------------------
3980 This would leave the merge result in `hello.c~2` file, along
3981 with conflict markers if there are conflicts.  After verifying
3982 the merge result makes sense, you can tell git what the final
3983 merge result for this file is by:
3985 -------------------------------------------------
3986 $ mv -f hello.c~2 hello.c
3987 $ git-update-index hello.c
3988 -------------------------------------------------
3990 When a path is in unmerged state, running `git-update-index` for
3991 that path tells git to mark the path resolved.
3993 The above is the description of a git merge at the lowest level,
3994 to help you understand what conceptually happens under the hood.
3995 In practice, nobody, not even git itself, uses three `git-cat-file`
3996 for this.  There is `git-merge-index` program that extracts the
3997 stages to temporary files and calls a "merge" script on it:
3999 -------------------------------------------------
4000 $ git-merge-index git-merge-one-file hello.c
4001 -------------------------------------------------
4003 and that is what higher level `git merge -s resolve` is implemented with.
4005 [[hacking-git]]
4006 Hacking git
4007 ===========
4009 This chapter covers internal details of the git implementation which
4010 probably only git developers need to understand.
4012 [[object-details]]
4013 Object storage format
4014 ---------------------
4016 All objects have a statically determined "type" which identifies the
4017 format of the object (i.e. how it is used, and how it can refer to other
4018 objects).  There are currently four different object types: "blob",
4019 "tree", "commit", and "tag".
4021 Regardless of object type, all objects share the following
4022 characteristics: they are all deflated with zlib, and have a header
4023 that not only specifies their type, but also provides size information
4024 about the data in the object.  It's worth noting that the SHA1 hash
4025 that is used to name the object is the hash of the original data
4026 plus this header, so `sha1sum` 'file' does not match the object name
4027 for 'file'.
4028 (Historical note: in the dawn of the age of git the hash
4029 was the sha1 of the 'compressed' object.)
4031 As a result, the general consistency of an object can always be tested
4032 independently of the contents or the type of the object: all objects can
4033 be validated by verifying that (a) their hashes match the content of the
4034 file and (b) the object successfully inflates to a stream of bytes that
4035 forms a sequence of <ascii type without space> {plus} <space> {plus} <ascii decimal
4036 size> {plus} <byte\0> {plus} <binary object data>.
4038 The structured objects can further have their structure and
4039 connectivity to other objects verified. This is generally done with
4040 the `git-fsck` program, which generates a full dependency graph
4041 of all objects, and verifies their internal consistency (in addition
4042 to just verifying their superficial consistency through the hash).
4044 [[birdview-on-the-source-code]]
4045 A birds-eye view of Git's source code
4046 -------------------------------------
4048 It is not always easy for new developers to find their way through Git's
4049 source code.  This section gives you a little guidance to show where to
4050 start.
4052 A good place to start is with the contents of the initial commit, with:
4054 ----------------------------------------------------
4055 $ git checkout e83c5163
4056 ----------------------------------------------------
4058 The initial revision lays the foundation for almost everything git has
4059 today, but is small enough to read in one sitting.
4061 Note that terminology has changed since that revision.  For example, the
4062 README in that revision uses the word "changeset" to describe what we
4063 now call a <<def_commit_object,commit>>.
4065 Also, we do not call it "cache" any more, but "index", however, the
4066 file is still called `cache.h`.  Remark: Not much reason to change it now,
4067 especially since there is no good single name for it anyway, because it is
4068 basically _the_ header file which is included by _all_ of Git's C sources.
4070 If you grasp the ideas in that initial commit, you should check out a
4071 more recent version and skim `cache.h`, `object.h` and `commit.h`.
4073 In the early days, Git (in the tradition of UNIX) was a bunch of programs
4074 which were extremely simple, and which you used in scripts, piping the
4075 output of one into another. This turned out to be good for initial
4076 development, since it was easier to test new things.  However, recently
4077 many of these parts have become builtins, and some of the core has been
4078 "libified", i.e. put into libgit.a for performance, portability reasons,
4079 and to avoid code duplication.
4081 By now, you know what the index is (and find the corresponding data
4082 structures in `cache.h`), and that there are just a couple of object types
4083 (blobs, trees, commits and tags) which inherit their common structure from
4084 `struct object`, which is their first member (and thus, you can cast e.g.
4085 `(struct object *)commit` to achieve the _same_ as `&commit->object`, i.e.
4086 get at the object name and flags).
4088 Now is a good point to take a break to let this information sink in.
4090 Next step: get familiar with the object naming.  Read <<naming-commits>>.
4091 There are quite a few ways to name an object (and not only revisions!).
4092 All of these are handled in `sha1_name.c`. Just have a quick look at
4093 the function `get_sha1()`. A lot of the special handling is done by
4094 functions like `get_sha1_basic()` or the likes.
4096 This is just to get you into the groove for the most libified part of Git:
4097 the revision walker.
4099 Basically, the initial version of `git log` was a shell script:
4101 ----------------------------------------------------------------
4102 $ git-rev-list --pretty $(git-rev-parse --default HEAD "$@") | \
4103         LESS=-S ${PAGER:-less}
4104 ----------------------------------------------------------------
4106 What does this mean?
4108 `git-rev-list` is the original version of the revision walker, which
4109 _always_ printed a list of revisions to stdout.  It is still functional,
4110 and needs to, since most new Git programs start out as scripts using
4111 `git-rev-list`.
4113 `git-rev-parse` is not as important any more; it was only used to filter out
4114 options that were relevant for the different plumbing commands that were
4115 called by the script.
4117 Most of what `git-rev-list` did is contained in `revision.c` and
4118 `revision.h`.  It wraps the options in a struct named `rev_info`, which
4119 controls how and what revisions are walked, and more.
4121 The original job of `git-rev-parse` is now taken by the function
4122 `setup_revisions()`, which parses the revisions and the common command line
4123 options for the revision walker. This information is stored in the struct
4124 `rev_info` for later consumption. You can do your own command line option
4125 parsing after calling `setup_revisions()`. After that, you have to call
4126 `prepare_revision_walk()` for initialization, and then you can get the
4127 commits one by one with the function `get_revision()`.
4129 If you are interested in more details of the revision walking process,
4130 just have a look at the first implementation of `cmd_log()`; call
4131 `git-show v1.3.0{tilde}155^2{tilde}4` and scroll down to that function (note that you
4132 no longer need to call `setup_pager()` directly).
4134 Nowadays, `git log` is a builtin, which means that it is _contained_ in the
4135 command `git`.  The source side of a builtin is
4137 - a function called `cmd_<bla>`, typically defined in `builtin-<bla>.c`,
4138   and declared in `builtin.h`,
4140 - an entry in the `commands[]` array in `git.c`, and
4142 - an entry in `BUILTIN_OBJECTS` in the `Makefile`.
4144 Sometimes, more than one builtin is contained in one source file.  For
4145 example, `cmd_whatchanged()` and `cmd_log()` both reside in `builtin-log.c`,
4146 since they share quite a bit of code.  In that case, the commands which are
4147 _not_ named like the `.c` file in which they live have to be listed in
4148 `BUILT_INS` in the `Makefile`.
4150 `git log` looks more complicated in C than it does in the original script,
4151 but that allows for a much greater flexibility and performance.
4153 Here again it is a good point to take a pause.
4155 Lesson three is: study the code.  Really, it is the best way to learn about
4156 the organization of Git (after you know the basic concepts).
4158 So, think about something which you are interested in, say, "how can I
4159 access a blob just knowing the object name of it?".  The first step is to
4160 find a Git command with which you can do it.  In this example, it is either
4161 `git show` or `git cat-file`.
4163 For the sake of clarity, let's stay with `git cat-file`, because it
4165 - is plumbing, and
4167 - was around even in the initial commit (it literally went only through
4168   some 20 revisions as `cat-file.c`, was renamed to `builtin-cat-file.c`
4169   when made a builtin, and then saw less than 10 versions).
4171 So, look into `builtin-cat-file.c`, search for `cmd_cat_file()` and look what
4172 it does.
4174 ------------------------------------------------------------------
4175         git_config(git_default_config);
4176         if (argc != 3)
4177                 usage("git-cat-file [-t|-s|-e|-p|<type>] <sha1>");
4178         if (get_sha1(argv[2], sha1))
4179                 die("Not a valid object name %s", argv[2]);
4180 ------------------------------------------------------------------
4182 Let's skip over the obvious details; the only really interesting part
4183 here is the call to `get_sha1()`.  It tries to interpret `argv[2]` as an
4184 object name, and if it refers to an object which is present in the current
4185 repository, it writes the resulting SHA-1 into the variable `sha1`.
4187 Two things are interesting here:
4189 - `get_sha1()` returns 0 on _success_.  This might surprise some new
4190   Git hackers, but there is a long tradition in UNIX to return different
4191   negative numbers in case of different errors--and 0 on success.
4193 - the variable `sha1` in the function signature of `get_sha1()` is `unsigned
4194   char \*`, but is actually expected to be a pointer to `unsigned
4195   char[20]`.  This variable will contain the 160-bit SHA-1 of the given
4196   commit.  Note that whenever a SHA-1 is passed as `unsigned char \*`, it
4197   is the binary representation, as opposed to the ASCII representation in
4198   hex characters, which is passed as `char *`.
4200 You will see both of these things throughout the code.
4202 Now, for the meat:
4204 -----------------------------------------------------------------------------
4205         case 0:
4206                 buf = read_object_with_reference(sha1, argv[1], &size, NULL);
4207 -----------------------------------------------------------------------------
4209 This is how you read a blob (actually, not only a blob, but any type of
4210 object).  To know how the function `read_object_with_reference()` actually
4211 works, find the source code for it (something like `git grep
4212 read_object_with | grep ":[a-z]"` in the git repository), and read
4213 the source.
4215 To find out how the result can be used, just read on in `cmd_cat_file()`:
4217 -----------------------------------
4218         write_or_die(1, buf, size);
4219 -----------------------------------
4221 Sometimes, you do not know where to look for a feature.  In many such cases,
4222 it helps to search through the output of `git log`, and then `git show` the
4223 corresponding commit.
4225 Example: If you know that there was some test case for `git bundle`, but
4226 do not remember where it was (yes, you _could_ `git grep bundle t/`, but that
4227 does not illustrate the point!):
4229 ------------------------
4230 $ git log --no-merges t/
4231 ------------------------
4233 In the pager (`less`), just search for "bundle", go a few lines back,
4234 and see that it is in commit 18449ab0...  Now just copy this object name,
4235 and paste it into the command line
4237 -------------------
4238 $ git show 18449ab0
4239 -------------------
4241 Voila.
4243 Another example: Find out what to do in order to make some script a
4244 builtin:
4246 -------------------------------------------------
4247 $ git log --no-merges --diff-filter=A builtin-*.c
4248 -------------------------------------------------
4250 You see, Git is actually the best tool to find out about the source of Git
4251 itself!
4253 [[glossary]]
4254 GIT Glossary
4255 ============
4257 include::glossary-content.txt[]
4259 [[git-quick-start]]
4260 Appendix A: Git Quick Reference
4261 ===============================
4263 This is a quick summary of the major commands; the previous chapters
4264 explain how these work in more detail.
4266 [[quick-creating-a-new-repository]]
4267 Creating a new repository
4268 -------------------------
4270 From a tarball:
4272 -----------------------------------------------
4273 $ tar xzf project.tar.gz
4274 $ cd project
4275 $ git init
4276 Initialized empty Git repository in .git/
4277 $ git add .
4278 $ git commit
4279 -----------------------------------------------
4281 From a remote repository:
4283 -----------------------------------------------
4284 $ git clone git://example.com/pub/project.git
4285 $ cd project
4286 -----------------------------------------------
4288 [[managing-branches]]
4289 Managing branches
4290 -----------------
4292 -----------------------------------------------
4293 $ git branch         # list all local branches in this repo
4294 $ git checkout test  # switch working directory to branch "test"
4295 $ git branch new     # create branch "new" starting at current HEAD
4296 $ git branch -d new  # delete branch "new"
4297 -----------------------------------------------
4299 Instead of basing a new branch on current HEAD (the default), use:
4301 -----------------------------------------------
4302 $ git branch new test    # branch named "test"
4303 $ git branch new v2.6.15 # tag named v2.6.15
4304 $ git branch new HEAD^   # commit before the most recent
4305 $ git branch new HEAD^^  # commit before that
4306 $ git branch new test~10 # ten commits before tip of branch "test"
4307 -----------------------------------------------
4309 Create and switch to a new branch at the same time:
4311 -----------------------------------------------
4312 $ git checkout -b new v2.6.15
4313 -----------------------------------------------
4315 Update and examine branches from the repository you cloned from:
4317 -----------------------------------------------
4318 $ git fetch             # update
4319 $ git branch -r         # list
4320   origin/master
4321   origin/next
4322   ...
4323 $ git checkout -b masterwork origin/master
4324 -----------------------------------------------
4326 Fetch a branch from a different repository, and give it a new
4327 name in your repository:
4329 -----------------------------------------------
4330 $ git fetch git://example.com/project.git theirbranch:mybranch
4331 $ git fetch git://example.com/project.git v2.6.15:mybranch
4332 -----------------------------------------------
4334 Keep a list of repositories you work with regularly:
4336 -----------------------------------------------
4337 $ git remote add example git://example.com/project.git
4338 $ git remote                    # list remote repositories
4339 example
4340 origin
4341 $ git remote show example       # get details
4342 * remote example
4343   URL: git://example.com/project.git
4344   Tracked remote branches
4345     master next ...
4346 $ git fetch example             # update branches from example
4347 $ git branch -r                 # list all remote branches
4348 -----------------------------------------------
4351 [[exploring-history]]
4352 Exploring history
4353 -----------------
4355 -----------------------------------------------
4356 $ gitk                      # visualize and browse history
4357 $ git log                   # list all commits
4358 $ git log src/              # ...modifying src/
4359 $ git log v2.6.15..v2.6.16  # ...in v2.6.16, not in v2.6.15
4360 $ git log master..test      # ...in branch test, not in branch master
4361 $ git log test..master      # ...in branch master, but not in test
4362 $ git log test...master     # ...in one branch, not in both
4363 $ git log -S'foo()'         # ...where difference contain "foo()"
4364 $ git log --since="2 weeks ago"
4365 $ git log -p                # show patches as well
4366 $ git show                  # most recent commit
4367 $ git diff v2.6.15..v2.6.16 # diff between two tagged versions
4368 $ git diff v2.6.15..HEAD    # diff with current head
4369 $ git grep "foo()"          # search working directory for "foo()"
4370 $ git grep v2.6.15 "foo()"  # search old tree for "foo()"
4371 $ git show v2.6.15:a.txt    # look at old version of a.txt
4372 -----------------------------------------------
4374 Search for regressions:
4376 -----------------------------------------------
4377 $ git bisect start
4378 $ git bisect bad                # current version is bad
4379 $ git bisect good v2.6.13-rc2   # last known good revision
4380 Bisecting: 675 revisions left to test after this
4381                                 # test here, then:
4382 $ git bisect good               # if this revision is good, or
4383 $ git bisect bad                # if this revision is bad.
4384                                 # repeat until done.
4385 -----------------------------------------------
4387 [[making-changes]]
4388 Making changes
4389 --------------
4391 Make sure git knows who to blame:
4393 ------------------------------------------------
4394 $ cat >>~/.gitconfig <<\EOF
4395 [user]
4396         name = Your Name Comes Here
4397         email = you@yourdomain.example.com
4399 ------------------------------------------------
4401 Select file contents to include in the next commit, then make the
4402 commit:
4404 -----------------------------------------------
4405 $ git add a.txt    # updated file
4406 $ git add b.txt    # new file
4407 $ git rm c.txt     # old file
4408 $ git commit
4409 -----------------------------------------------
4411 Or, prepare and create the commit in one step:
4413 -----------------------------------------------
4414 $ git commit d.txt # use latest content only of d.txt
4415 $ git commit -a    # use latest content of all tracked files
4416 -----------------------------------------------
4418 [[merging]]
4419 Merging
4420 -------
4422 -----------------------------------------------
4423 $ git merge test   # merge branch "test" into the current branch
4424 $ git pull git://example.com/project.git master
4425                    # fetch and merge in remote branch
4426 $ git pull . test  # equivalent to git merge test
4427 -----------------------------------------------
4429 [[sharing-your-changes]]
4430 Sharing your changes
4431 --------------------
4433 Importing or exporting patches:
4435 -----------------------------------------------
4436 $ git format-patch origin..HEAD # format a patch for each commit
4437                                 # in HEAD but not in origin
4438 $ git am mbox # import patches from the mailbox "mbox"
4439 -----------------------------------------------
4441 Fetch a branch in a different git repository, then merge into the
4442 current branch:
4444 -----------------------------------------------
4445 $ git pull git://example.com/project.git theirbranch
4446 -----------------------------------------------
4448 Store the fetched branch into a local branch before merging into the
4449 current branch:
4451 -----------------------------------------------
4452 $ git pull git://example.com/project.git theirbranch:mybranch
4453 -----------------------------------------------
4455 After creating commits on a local branch, update the remote
4456 branch with your commits:
4458 -----------------------------------------------
4459 $ git push ssh://example.com/project.git mybranch:theirbranch
4460 -----------------------------------------------
4462 When remote and local branch are both named "test":
4464 -----------------------------------------------
4465 $ git push ssh://example.com/project.git test
4466 -----------------------------------------------
4468 Shortcut version for a frequently used remote repository:
4470 -----------------------------------------------
4471 $ git remote add example ssh://example.com/project.git
4472 $ git push example test
4473 -----------------------------------------------
4475 [[repository-maintenance]]
4476 Repository maintenance
4477 ----------------------
4479 Check for corruption:
4481 -----------------------------------------------
4482 $ git fsck
4483 -----------------------------------------------
4485 Recompress, remove unused cruft:
4487 -----------------------------------------------
4488 $ git gc
4489 -----------------------------------------------
4492 [[todo]]
4493 Appendix B: Notes and todo list for this manual
4494 ===============================================
4496 This is a work in progress.
4498 The basic requirements:
4500 - It must be readable in order, from beginning to end, by someone
4501   intelligent with a basic grasp of the UNIX command line, but without
4502   any special knowledge of git.  If necessary, any other prerequisites
4503   should be specifically mentioned as they arise.
4504 - Whenever possible, section headings should clearly describe the task
4505   they explain how to do, in language that requires no more knowledge
4506   than necessary: for example, "importing patches into a project" rather
4507   than "the git-am command"
4509 Think about how to create a clear chapter dependency graph that will
4510 allow people to get to important topics without necessarily reading
4511 everything in between.
4513 Scan Documentation/ for other stuff left out; in particular:
4515 - howto's
4516 - some of technical/?
4517 - hooks
4518 - list of commands in linkgit:git[1]
4520 Scan email archives for other stuff left out
4522 Scan man pages to see if any assume more background than this manual
4523 provides.
4525 Simplify beginning by suggesting disconnected head instead of
4526 temporary branch creation?
4528 Add more good examples.  Entire sections of just cookbook examples
4529 might be a good idea; maybe make an "advanced examples" section a
4530 standard end-of-chapter section?
4532 Include cross-references to the glossary, where appropriate.
4534 Document shallow clones?  See draft 1.5.0 release notes for some
4535 documentation.
4537 Add a section on working with other version control systems, including
4538 CVS, Subversion, and just imports of series of release tarballs.
4540 More details on gitweb?
4542 Write a chapter on using plumbing and writing scripts.
4544 Alternates, clone -reference, etc.
4546 More on recovery from repository corruption.  See:
4547         http://marc.theaimsgroup.com/?l=git&m=117263864820799&w=2
4548         http://marc.theaimsgroup.com/?l=git&m=117147855503798&w=2
4549         http://marc.theaimsgroup.com/?l=git&m=117147855503798&w=2