Revert "MinGW: Add missing file mode bit defines"
[git/dscho.git] / Documentation / user-manual.txt
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, or linkgit:git-help[1] command.  For example, for the command
22 "git clone <repo>", you can either use:
24 ------------------------------------------------
25 $ man git-clone
26 ------------------------------------------------
28 or:
30 ------------------------------------------------
31 $ git help clone
32 ------------------------------------------------
34 With the latter, you can use the manual viewer of your choice; see
35 linkgit:git-help[1] for more information.
37 See also <<git-quick-start>> for a brief overview of git commands,
38 without any explanation.
40 Finally, see <<todo>> for ways that you can help make this manual more
41 complete.
44 [[repositories-and-branches]]
45 Repositories and Branches
46 =========================
48 [[how-to-get-a-git-repository]]
49 How to get a git repository
50 ---------------------------
52 It will be useful to have a git repository to experiment with as you
53 read this manual.
55 The best way to get one is by using the linkgit:git-clone[1] command to
56 download a copy of an existing repository.  If you don't already have a
57 project in mind, here are some interesting examples:
59 ------------------------------------------------
60         # git itself (approx. 10MB download):
61 $ git clone git://
62         # the Linux kernel (approx. 150MB download):
63 $ git clone git://
64 ------------------------------------------------
66 The initial clone may be time-consuming for a large project, but you
67 will only need to clone once.
69 The clone command creates a new directory named after the project ("git"
70 or "linux-2.6" in the examples above).  After you cd into this
71 directory, you will see that it contains a copy of the project files,
72 called the <<def_working_tree,working tree>>, together with a special
73 top-level directory named ".git", which contains all the information
74 about the history of the project.
76 [[how-to-check-out]]
77 How to check out a different version of a project
78 -------------------------------------------------
80 Git is best thought of as a tool for storing the history of a collection
81 of files.  It stores the history as a compressed collection of
82 interrelated snapshots of the project's contents.  In git each such
83 version is called a <<def_commit,commit>>.
85 Those snapshots aren't necessarily all arranged in a single line from
86 oldest to newest; instead, work may simultaneously proceed along
87 parallel lines of development, called <<def_branch,branches>>, which may
88 merge and diverge.
90 A single git repository can track development on multiple branches.  It
91 does this by keeping a list of <<def_head,heads>> which reference the
92 latest commit on each branch; the linkgit:git-branch[1] command shows
93 you the list of branch heads:
95 ------------------------------------------------
96 $ git branch
97 * master
98 ------------------------------------------------
100 A freshly cloned repository contains a single branch head, by default
101 named "master", with the working directory initialized to the state of
102 the project referred to by that branch head.
104 Most projects also use <<def_tag,tags>>.  Tags, like heads, are
105 references into the project's history, and can be listed using the
106 linkgit:git-tag[1] command:
108 ------------------------------------------------
109 $ git tag -l
110 v2.6.11
111 v2.6.11-tree
112 v2.6.12
113 v2.6.12-rc2
114 v2.6.12-rc3
115 v2.6.12-rc4
116 v2.6.12-rc5
117 v2.6.12-rc6
118 v2.6.13
120 ------------------------------------------------
122 Tags are expected to always point at the same version of a project,
123 while heads are expected to advance as development progresses.
125 Create a new branch head pointing to one of these versions and check it
126 out using linkgit:git-checkout[1]:
128 ------------------------------------------------
129 $ git checkout -b new v2.6.13
130 ------------------------------------------------
132 The working directory then reflects the contents that the project had
133 when it was tagged v2.6.13, and linkgit:git-branch[1] shows two
134 branches, with an asterisk marking the currently checked-out branch:
136 ------------------------------------------------
137 $ git branch
138   master
139 * new
140 ------------------------------------------------
142 If you decide that you'd rather see version 2.6.17, you can modify
143 the current branch to point at v2.6.17 instead, with
145 ------------------------------------------------
146 $ git reset --hard v2.6.17
147 ------------------------------------------------
149 Note that if the current branch head was your only reference to a
150 particular point in history, then resetting that branch may leave you
151 with no way to find the history it used to point to; so use this command
152 carefully.
154 [[understanding-commits]]
155 Understanding History: Commits
156 ------------------------------
158 Every change in the history of a project is represented by a commit.
159 The linkgit:git-show[1] command shows the most recent commit on the
160 current branch:
162 ------------------------------------------------
163 $ git show
164 commit 17cf781661e6d38f737f15f53ab552f1e95960d7
165 Author: Linus Torvalds <>
166 Date:   Tue Apr 19 14:11:06 2005 -0700
168     Remove duplicate getenv(DB_ENVIRONMENT) call
170     Noted by Tony Luck.
172 diff --git a/init-db.c b/init-db.c
173 index 65898fa..b002dc6 100644
174 --- a/init-db.c
175 +++ b/init-db.c
176 @@ -7,7 +7,7 @@
178  int main(int argc, char **argv)
180 -       char *sha1_dir = getenv(DB_ENVIRONMENT), *path;
181 +       char *sha1_dir, *path;
182         int len, i;
184         if (mkdir(".git", 0755) < 0) {
185 ------------------------------------------------
187 As you can see, a commit shows who made the latest change, what they
188 did, and why.
190 Every commit has a 40-hexdigit id, sometimes called the "object name" or the
191 "SHA-1 id", shown on the first line of the "git show" output.  You can usually
192 refer to a commit by a shorter name, such as a tag or a branch name, but this
193 longer name can also be useful.  Most importantly, it is a globally unique
194 name for this commit: so if you tell somebody else the object name (for
195 example in email), then you are guaranteed that name will refer to the same
196 commit in their repository that it does in yours (assuming their repository
197 has that commit at all).  Since the object name is computed as a hash over the
198 contents of the commit, you are guaranteed that the commit can never change
199 without its name also changing.
201 In fact, in <<git-concepts>> we shall see that everything stored in git
202 history, including file data and directory contents, is stored in an object
203 with a name that is a hash of its contents.
205 [[understanding-reachability]]
206 Understanding history: commits, parents, and reachability
207 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
209 Every commit (except the very first commit in a project) also has a
210 parent commit which shows what happened before this commit.
211 Following the chain of parents will eventually take you back to the
212 beginning of the project.
214 However, the commits do not form a simple list; git allows lines of
215 development to diverge and then reconverge, and the point where two
216 lines of development reconverge is called a "merge".  The commit
217 representing a merge can therefore have more than one parent, with
218 each parent representing the most recent commit on one of the lines
219 of development leading to that point.
221 The best way to see how this works is using the linkgit:gitk[1]
222 command; running gitk now on a git repository and looking for merge
223 commits will help understand how the git organizes history.
225 In the following, we say that commit X is "reachable" from commit Y
226 if commit X is an ancestor of commit Y.  Equivalently, you could say
227 that Y is a descendant of X, or that there is a chain of parents
228 leading from commit Y to commit X.
230 [[history-diagrams]]
231 Understanding history: History diagrams
232 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
234 We will sometimes represent git history using diagrams like the one
235 below.  Commits are shown as "o", and the links between them with
236 lines drawn with - / and \.  Time goes left to right:
239 ................................................
240          o--o--o <-- Branch A
241         /
242  o--o--o <-- master
243         \
244          o--o--o <-- Branch B
245 ................................................
247 If we need to talk about a particular commit, the character "o" may
248 be replaced with another letter or number.
250 [[what-is-a-branch]]
251 Understanding history: What is a branch?
252 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
254 When we need to be precise, we will use the word "branch" to mean a line
255 of development, and "branch head" (or just "head") to mean a reference
256 to the most recent commit on a branch.  In the example above, the branch
257 head named "A" is a pointer to one particular commit, but we refer to
258 the line of three commits leading up to that point as all being part of
259 "branch A".
261 However, when no confusion will result, we often just use the term
262 "branch" both for branches and for branch heads.
264 [[manipulating-branches]]
265 Manipulating branches
266 ---------------------
268 Creating, deleting, and modifying branches is quick and easy; here's
269 a summary of the commands:
271 git branch::
272         list all branches
273 git branch <branch>::
274         create a new branch named <branch>, referencing the same
275         point in history as the current branch
276 git branch <branch> <start-point>::
277         create a new branch named <branch>, referencing
278         <start-point>, which may be specified any way you like,
279         including using a branch name or a tag name
280 git branch -d <branch>::
281         delete the branch <branch>; if the branch you are deleting
282         points to a commit which is not reachable from the current
283         branch, this command will fail with a warning.
284 git branch -D <branch>::
285         even if the branch points to a commit not reachable
286         from the current branch, you may know that that commit
287         is still reachable from some other branch or tag.  In that
288         case it is safe to use this command to force git to delete
289         the branch.
290 git checkout <branch>::
291         make the current branch <branch>, updating the working
292         directory to reflect the version referenced by <branch>
293 git checkout -b <new> <start-point>::
294         create a new branch <new> referencing <start-point>, and
295         check it out.
297 The special symbol "HEAD" can always be used to refer to the current
298 branch.  In fact, git uses a file named "HEAD" in the .git directory to
299 remember which branch is current:
301 ------------------------------------------------
302 $ cat .git/HEAD
303 ref: refs/heads/master
304 ------------------------------------------------
306 [[detached-head]]
307 Examining an old version without creating a new branch
308 ------------------------------------------------------
310 The `git checkout` command normally expects a branch head, but will also
311 accept an arbitrary commit; for example, you can check out the commit
312 referenced by a tag:
314 ------------------------------------------------
315 $ git checkout v2.6.17
316 Note: moving to "v2.6.17" which isn't a local branch
317 If you want to create a new branch from this checkout, you may do so
318 (now or later) by using -b with the checkout command again. Example:
319   git checkout -b <new_branch_name>
320 HEAD is now at 427abfa... Linux v2.6.17
321 ------------------------------------------------
323 The HEAD then refers to the SHA-1 of the commit instead of to a branch,
324 and git branch shows that you are no longer on a branch:
326 ------------------------------------------------
327 $ cat .git/HEAD
328 427abfa28afedffadfca9dd8b067eb6d36bac53f
329 $ git branch
330 * (no branch)
331   master
332 ------------------------------------------------
334 In this case we say that the HEAD is "detached".
336 This is an easy way to check out a particular version without having to
337 make up a name for the new branch.   You can still create a new branch
338 (or tag) for this version later if you decide to.
340 [[examining-remote-branches]]
341 Examining branches from a remote repository
342 -------------------------------------------
344 The "master" branch that was created at the time you cloned is a copy
345 of the HEAD in the repository that you cloned from.  That repository
346 may also have had other branches, though, and your local repository
347 keeps branches which track each of those remote branches, called
348 remote-tracking branches, which you
349 can view using the "-r" option to linkgit:git-branch[1]:
351 ------------------------------------------------
352 $ git branch -r
353   origin/HEAD
354   origin/html
355   origin/maint
356   origin/man
357   origin/master
358   origin/next
359   origin/pu
360   origin/todo
361 ------------------------------------------------
363 In this example, "origin" is called a remote repository, or "remote"
364 for short. The branches of this repository are called "remote
365 branches" from our point of view. The remote-tracking branches listed
366 above were created based on the remote branches at clone time and will
367 be updated by "git fetch" (hence "git pull") and "git push". See
368 <<Updating-a-repository-With-git-fetch>> for details.
370 You might want to build on one of these remote-tracking branches
371 on a branch of your own, just as you would for a tag:
373 ------------------------------------------------
374 $ git checkout -b my-todo-copy origin/todo
375 ------------------------------------------------
377 You can also check out "origin/todo" directly to examine it or
378 write a one-off patch.  See <<detached-head,detached head>>.
380 Note that the name "origin" is just the name that git uses by default
381 to refer to the repository that you cloned from.
383 [[how-git-stores-references]]
384 Naming branches, tags, and other references
385 -------------------------------------------
387 Branches, remote-tracking branches, and tags are all references to
388 commits.  All references are named with a slash-separated path name
389 starting with "refs"; the names we've been using so far are actually
390 shorthand:
392         - The branch "test" is short for "refs/heads/test".
393         - The tag "v2.6.18" is short for "refs/tags/v2.6.18".
394         - "origin/master" is short for "refs/remotes/origin/master".
396 The full name is occasionally useful if, for example, there ever
397 exists a tag and a branch with the same name.
399 (Newly created refs are actually stored in the .git/refs directory,
400 under the path given by their name.  However, for efficiency reasons
401 they may also be packed together in a single file; see
402 linkgit:git-pack-refs[1]).
404 As another useful shortcut, the "HEAD" of a repository can be referred
405 to just using the name of that repository.  So, for example, "origin"
406 is usually a shortcut for the HEAD branch in the repository "origin".
408 For the complete list of paths which git checks for references, and
409 the order it uses to decide which to choose when there are multiple
410 references with the same shorthand name, see the "SPECIFYING
411 REVISIONS" section of linkgit:gitrevisions[7].
413 [[Updating-a-repository-With-git-fetch]]
414 Updating a repository with git fetch
415 ------------------------------------
417 Eventually the developer cloned from will do additional work in her
418 repository, creating new commits and advancing the branches to point
419 at the new commits.
421 The command "git fetch", with no arguments, will update all of the
422 remote-tracking branches to the latest version found in her
423 repository.  It will not touch any of your own branches--not even the
424 "master" branch that was created for you on clone.
426 [[fetching-branches]]
427 Fetching branches from other repositories
428 -----------------------------------------
430 You can also track branches from repositories other than the one you
431 cloned from, using linkgit:git-remote[1]:
433 -------------------------------------------------
434 $ git remote add linux-nfs git://
435 $ git fetch linux-nfs
436 * refs/remotes/linux-nfs/master: storing branch 'master' ...
437   commit: bf81b46
438 -------------------------------------------------
440 New remote-tracking branches will be stored under the shorthand name
441 that you gave "git remote add", in this case linux-nfs:
443 -------------------------------------------------
444 $ git branch -r
445 linux-nfs/master
446 origin/master
447 -------------------------------------------------
449 If you run "git fetch <remote>" later, the remote-tracking branches for the
450 named <remote> will be updated.
452 If you examine the file .git/config, you will see that git has added
453 a new stanza:
455 -------------------------------------------------
456 $ cat .git/config
458 [remote "linux-nfs"]
459         url = git://
460         fetch = +refs/heads/*:refs/remotes/linux-nfs/*
462 -------------------------------------------------
464 This is what causes git to track the remote's branches; you may modify
465 or delete these configuration options by editing .git/config with a
466 text editor.  (See the "CONFIGURATION FILE" section of
467 linkgit:git-config[1] for details.)
469 [[exploring-git-history]]
470 Exploring git history
471 =====================
473 Git is best thought of as a tool for storing the history of a
474 collection of files.  It does this by storing compressed snapshots of
475 the contents of a file hierarchy, together with "commits" which show
476 the relationships between these snapshots.
478 Git provides extremely flexible and fast tools for exploring the
479 history of a project.
481 We start with one specialized tool that is useful for finding the
482 commit that introduced a bug into a project.
484 [[using-bisect]]
485 How to use bisect to find a regression
486 --------------------------------------
488 Suppose version 2.6.18 of your project worked, but the version at
489 "master" crashes.  Sometimes the best way to find the cause of such a
490 regression is to perform a brute-force search through the project's
491 history to find the particular commit that caused the problem.  The
492 linkgit:git-bisect[1] command can help you do this:
494 -------------------------------------------------
495 $ git bisect start
496 $ git bisect good v2.6.18
497 $ git bisect bad master
498 Bisecting: 3537 revisions left to test after this
499 [65934a9a028b88e83e2b0f8b36618fe503349f8e] BLOCK: Make USB storage depend on SCSI rather than selecting it [try #6]
500 -------------------------------------------------
502 If you run "git branch" at this point, you'll see that git has
503 temporarily moved you in "(no branch)". HEAD is now detached from any
504 branch and points directly to a commit (with commit id 65934...) that
505 is reachable from "master" but not from v2.6.18. Compile and test it,
506 and see whether it crashes. Assume it does crash. Then:
508 -------------------------------------------------
509 $ git bisect bad
510 Bisecting: 1769 revisions left to test after this
511 [7eff82c8b1511017ae605f0c99ac275a7e21b867] i2c-core: Drop useless bitmaskings
512 -------------------------------------------------
514 checks out an older version.  Continue like this, telling git at each
515 stage whether the version it gives you is good or bad, and notice
516 that the number of revisions left to test is cut approximately in
517 half each time.
519 After about 13 tests (in this case), it will output the commit id of
520 the guilty commit.  You can then examine the commit with
521 linkgit:git-show[1], find out who wrote it, and mail them your bug
522 report with the commit id.  Finally, run
524 -------------------------------------------------
525 $ git bisect reset
526 -------------------------------------------------
528 to return you to the branch you were on before.
530 Note that the version which `git bisect` checks out for you at each
531 point is just a suggestion, and you're free to try a different
532 version if you think it would be a good idea.  For example,
533 occasionally you may land on a commit that broke something unrelated;
536 -------------------------------------------------
537 $ git bisect visualize
538 -------------------------------------------------
540 which will run gitk and label the commit it chose with a marker that
541 says "bisect".  Choose a safe-looking commit nearby, note its commit
542 id, and check it out with:
544 -------------------------------------------------
545 $ git reset --hard fb47ddb2db...
546 -------------------------------------------------
548 then test, run "bisect good" or "bisect bad" as appropriate, and
549 continue.
551 Instead of "git bisect visualize" and then "git reset --hard
552 fb47ddb2db...", you might just want to tell git that you want to skip
553 the current commit:
555 -------------------------------------------------
556 $ git bisect skip
557 -------------------------------------------------
559 In this case, though, git may not eventually be able to tell the first
560 bad one between some first skipped commits and a later bad commit.
562 There are also ways to automate the bisecting process if you have a
563 test script that can tell a good from a bad commit. See
564 linkgit:git-bisect[1] for more information about this and other "git
565 bisect" features.
567 [[naming-commits]]
568 Naming commits
569 --------------
571 We have seen several ways of naming commits already:
573         - 40-hexdigit object name
574         - branch name: refers to the commit at the head of the given
575           branch
576         - tag name: refers to the commit pointed to by the given tag
577           (we've seen branches and tags are special cases of
578           <<how-git-stores-references,references>>).
579         - HEAD: refers to the head of the current branch
581 There are many more; see the "SPECIFYING REVISIONS" section of the
582 linkgit:gitrevisions[7] man page for the complete list of ways to
583 name revisions.  Some examples:
585 -------------------------------------------------
586 $ git show fb47ddb2 # the first few characters of the object name
587                     # are usually enough to specify it uniquely
588 $ git show HEAD^    # the parent of the HEAD commit
589 $ git show HEAD^^   # the grandparent
590 $ git show HEAD~4   # the great-great-grandparent
591 -------------------------------------------------
593 Recall that merge commits may have more than one parent; by default,
594 ^ and ~ follow the first parent listed in the commit, but you can
595 also choose:
597 -------------------------------------------------
598 $ git show HEAD^1   # show the first parent of HEAD
599 $ git show HEAD^2   # show the second parent of HEAD
600 -------------------------------------------------
602 In addition to HEAD, there are several other special names for
603 commits:
605 Merges (to be discussed later), as well as operations such as
606 `git reset`, which change the currently checked-out commit, generally
607 set ORIG_HEAD to the value HEAD had before the current operation.
609 The `git fetch` operation always stores the head of the last fetched
610 branch in FETCH_HEAD.  For example, if you run `git fetch` without
611 specifying a local branch as the target of the operation
613 -------------------------------------------------
614 $ git fetch git:// theirbranch
615 -------------------------------------------------
617 the fetched commits will still be available from FETCH_HEAD.
619 When we discuss merges we'll also see the special name MERGE_HEAD,
620 which refers to the other branch that we're merging in to the current
621 branch.
623 The linkgit:git-rev-parse[1] command is a low-level command that is
624 occasionally useful for translating some name for a commit to the object
625 name for that commit:
627 -------------------------------------------------
628 $ git rev-parse origin
629 e05db0fd4f31dde7005f075a84f96b360d05984b
630 -------------------------------------------------
632 [[creating-tags]]
633 Creating tags
634 -------------
636 We can also create a tag to refer to a particular commit; after
637 running
639 -------------------------------------------------
640 $ git tag stable-1 1b2e1d63ff
641 -------------------------------------------------
643 You can use stable-1 to refer to the commit 1b2e1d63ff.
645 This creates a "lightweight" tag.  If you would also like to include a
646 comment with the tag, and possibly sign it cryptographically, then you
647 should create a tag object instead; see the linkgit:git-tag[1] man page
648 for details.
650 [[browsing-revisions]]
651 Browsing revisions
652 ------------------
654 The linkgit:git-log[1] command can show lists of commits.  On its
655 own, it shows all commits reachable from the parent commit; but you
656 can also make more specific requests:
658 -------------------------------------------------
659 $ git log v2.5..        # commits since (not reachable from) v2.5
660 $ git log test..master  # commits reachable from master but not test
661 $ git log master..test  # ...reachable from test but not master
662 $ git log master...test # ...reachable from either test or master,
663                         #    but not both
664 $ git log --since="2 weeks ago" # commits from the last 2 weeks
665 $ git log Makefile      # commits which modify Makefile
666 $ git log fs/           # ... which modify any file under fs/
667 $ git log -S'foo()'     # commits which add or remove any file data
668                         # matching the string 'foo()'
669 -------------------------------------------------
671 And of course you can combine all of these; the following finds
672 commits since v2.5 which touch the Makefile or any file under fs:
674 -------------------------------------------------
675 $ git log v2.5.. Makefile fs/
676 -------------------------------------------------
678 You can also ask git log to show patches:
680 -------------------------------------------------
681 $ git log -p
682 -------------------------------------------------
684 See the "--pretty" option in the linkgit:git-log[1] man page for more
685 display options.
687 Note that git log starts with the most recent commit and works
688 backwards through the parents; however, since git history can contain
689 multiple independent lines of development, the particular order that
690 commits are listed in may be somewhat arbitrary.
692 [[generating-diffs]]
693 Generating diffs
694 ----------------
696 You can generate diffs between any two versions using
697 linkgit:git-diff[1]:
699 -------------------------------------------------
700 $ git diff master..test
701 -------------------------------------------------
703 That will produce the diff between the tips of the two branches.  If
704 you'd prefer to find the diff from their common ancestor to test, you
705 can use three dots instead of two:
707 -------------------------------------------------
708 $ git diff master...test
709 -------------------------------------------------
711 Sometimes what you want instead is a set of patches; for this you can
712 use linkgit:git-format-patch[1]:
714 -------------------------------------------------
715 $ git format-patch master..test
716 -------------------------------------------------
718 will generate a file with a patch for each commit reachable from test
719 but not from master.
721 [[viewing-old-file-versions]]
722 Viewing old file versions
723 -------------------------
725 You can always view an old version of a file by just checking out the
726 correct revision first.  But sometimes it is more convenient to be
727 able to view an old version of a single file without checking
728 anything out; this command does that:
730 -------------------------------------------------
731 $ git show v2.5:fs/locks.c
732 -------------------------------------------------
734 Before the colon may be anything that names a commit, and after it
735 may be any path to a file tracked by git.
737 [[history-examples]]
738 Examples
739 --------
741 [[counting-commits-on-a-branch]]
742 Counting the number of commits on a branch
743 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
745 Suppose you want to know how many commits you've made on "mybranch"
746 since it diverged from "origin":
748 -------------------------------------------------
749 $ git log --pretty=oneline origin..mybranch | wc -l
750 -------------------------------------------------
752 Alternatively, you may often see this sort of thing done with the
753 lower-level command linkgit:git-rev-list[1], which just lists the SHA-1's
754 of all the given commits:
756 -------------------------------------------------
757 $ git rev-list origin..mybranch | wc -l
758 -------------------------------------------------
760 [[checking-for-equal-branches]]
761 Check whether two branches point at the same history
762 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
764 Suppose you want to check whether two branches point at the same point
765 in history.
767 -------------------------------------------------
768 $ git diff origin..master
769 -------------------------------------------------
771 will tell you whether the contents of the project are the same at the
772 two branches; in theory, however, it's possible that the same project
773 contents could have been arrived at by two different historical
774 routes.  You could compare the object names:
776 -------------------------------------------------
777 $ git rev-list origin
778 e05db0fd4f31dde7005f075a84f96b360d05984b
779 $ git rev-list master
780 e05db0fd4f31dde7005f075a84f96b360d05984b
781 -------------------------------------------------
783 Or you could recall that the ... operator selects all commits
784 contained reachable from either one reference or the other but not
785 both: so
787 -------------------------------------------------
788 $ git log origin...master
789 -------------------------------------------------
791 will return no commits when the two branches are equal.
793 [[finding-tagged-descendants]]
794 Find first tagged version including a given fix
795 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
797 Suppose you know that the commit e05db0fd fixed a certain problem.
798 You'd like to find the earliest tagged release that contains that
799 fix.
801 Of course, there may be more than one answer--if the history branched
802 after commit e05db0fd, then there could be multiple "earliest" tagged
803 releases.
805 You could just visually inspect the commits since e05db0fd:
807 -------------------------------------------------
808 $ gitk e05db0fd..
809 -------------------------------------------------
811 Or you can use linkgit:git-name-rev[1], which will give the commit a
812 name based on any tag it finds pointing to one of the commit's
813 descendants:
815 -------------------------------------------------
816 $ git name-rev --tags e05db0fd
817 e05db0fd tags/v1.5.0-rc1^0~23
818 -------------------------------------------------
820 The linkgit:git-describe[1] command does the opposite, naming the
821 revision using a tag on which the given commit is based:
823 -------------------------------------------------
824 $ git describe e05db0fd
825 v1.5.0-rc0-260-ge05db0f
826 -------------------------------------------------
828 but that may sometimes help you guess which tags might come after the
829 given commit.
831 If you just want to verify whether a given tagged version contains a
832 given commit, you could use linkgit:git-merge-base[1]:
834 -------------------------------------------------
835 $ git merge-base e05db0fd v1.5.0-rc1
836 e05db0fd4f31dde7005f075a84f96b360d05984b
837 -------------------------------------------------
839 The merge-base command finds a common ancestor of the given commits,
840 and always returns one or the other in the case where one is a
841 descendant of the other; so the above output shows that e05db0fd
842 actually is an ancestor of v1.5.0-rc1.
844 Alternatively, note that
846 -------------------------------------------------
847 $ git log v1.5.0-rc1..e05db0fd
848 -------------------------------------------------
850 will produce empty output if and only if v1.5.0-rc1 includes e05db0fd,
851 because it outputs only commits that are not reachable from v1.5.0-rc1.
853 As yet another alternative, the linkgit:git-show-branch[1] command lists
854 the commits reachable from its arguments with a display on the left-hand
855 side that indicates which arguments that commit is reachable from.  So,
856 you can run something like
858 -------------------------------------------------
859 $ git show-branch e05db0fd v1.5.0-rc0 v1.5.0-rc1 v1.5.0-rc2
860 ! [e05db0fd] Fix warnings in sha1_file.c - use C99 printf format if
861 available
862  ! [v1.5.0-rc0] GIT v1.5.0 preview
863   ! [v1.5.0-rc1] GIT v1.5.0-rc1
864    ! [v1.5.0-rc2] GIT v1.5.0-rc2
866 -------------------------------------------------
868 then search for a line that looks like
870 -------------------------------------------------
871 + ++ [e05db0fd] Fix warnings in sha1_file.c - use C99 printf format if
872 available
873 -------------------------------------------------
875 Which shows that e05db0fd is reachable from itself, from v1.5.0-rc1, and
876 from v1.5.0-rc2, but not from v1.5.0-rc0.
878 [[showing-commits-unique-to-a-branch]]
879 Showing commits unique to a given branch
880 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
882 Suppose you would like to see all the commits reachable from the branch
883 head named "master" but not from any other head in your repository.
885 We can list all the heads in this repository with
886 linkgit:git-show-ref[1]:
888 -------------------------------------------------
889 $ git show-ref --heads
890 bf62196b5e363d73353a9dcf094c59595f3153b7 refs/heads/core-tutorial
891 db768d5504c1bb46f63ee9d6e1772bd047e05bf9 refs/heads/maint
892 a07157ac624b2524a059a3414e99f6f44bebc1e7 refs/heads/master
893 24dbc180ea14dc1aebe09f14c8ecf32010690627 refs/heads/tutorial-2
894 1e87486ae06626c2f31eaa63d26fc0fd646c8af2 refs/heads/tutorial-fixes
895 -------------------------------------------------
897 We can get just the branch-head names, and remove "master", with
898 the help of the standard utilities cut and grep:
900 -------------------------------------------------
901 $ git show-ref --heads | cut -d' ' -f2 | grep -v '^refs/heads/master'
902 refs/heads/core-tutorial
903 refs/heads/maint
904 refs/heads/tutorial-2
905 refs/heads/tutorial-fixes
906 -------------------------------------------------
908 And then we can ask to see all the commits reachable from master
909 but not from these other heads:
911 -------------------------------------------------
912 $ gitk master --not $( git show-ref --heads | cut -d' ' -f2 |
913                                 grep -v '^refs/heads/master' )
914 -------------------------------------------------
916 Obviously, endless variations are possible; for example, to see all
917 commits reachable from some head but not from any tag in the repository:
919 -------------------------------------------------
920 $ gitk $( git show-ref --heads ) --not  $( git show-ref --tags )
921 -------------------------------------------------
923 (See linkgit:gitrevisions[7] for explanations of commit-selecting
924 syntax such as `--not`.)
926 [[making-a-release]]
927 Creating a changelog and tarball for a software release
928 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
930 The linkgit:git-archive[1] command can create a tar or zip archive from
931 any version of a project; for example:
933 -------------------------------------------------
934 $ git archive --format=tar --prefix=project/ HEAD | gzip >latest.tar.gz
935 -------------------------------------------------
937 will use HEAD to produce a tar archive in which each filename is
938 preceded by "project/".
940 If you're releasing a new version of a software project, you may want
941 to simultaneously make a changelog to include in the release
942 announcement.
944 Linus Torvalds, for example, makes new kernel releases by tagging them,
945 then running:
947 -------------------------------------------------
948 $ release-script 2.6.12 2.6.13-rc6 2.6.13-rc7
949 -------------------------------------------------
951 where release-script is a shell script that looks like:
953 -------------------------------------------------
954 #!/bin/sh
955 stable="$1"
956 last="$2"
957 new="$3"
958 echo "# git tag v$new"
959 echo "git archive --prefix=linux-$new/ v$new | gzip -9 > ../linux-$new.tar.gz"
960 echo "git diff v$stable v$new | gzip -9 > ../patch-$new.gz"
961 echo "git log --no-merges v$new ^v$last > ../ChangeLog-$new"
962 echo "git shortlog --no-merges v$new ^v$last > ../ShortLog"
963 echo "git diff --stat --summary -M v$last v$new > ../diffstat-$new"
964 -------------------------------------------------
966 and then he just cut-and-pastes the output commands after verifying that
967 they look OK.
969 [[Finding-commits-With-given-Content]]
970 Finding commits referencing a file with given content
971 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
973 Somebody hands you a copy of a file, and asks which commits modified a
974 file such that it contained the given content either before or after the
975 commit.  You can find out with this:
977 -------------------------------------------------
978 $  git log --raw --abbrev=40 --pretty=oneline |
979         grep -B 1 `git hash-object filename`
980 -------------------------------------------------
982 Figuring out why this works is left as an exercise to the (advanced)
983 student.  The linkgit:git-log[1], linkgit:git-diff-tree[1], and
984 linkgit:git-hash-object[1] man pages may prove helpful.
986 [[Developing-With-git]]
987 Developing with git
988 ===================
990 [[telling-git-your-name]]
991 Telling git your name
992 ---------------------
994 Before creating any commits, you should introduce yourself to git.  The
995 easiest way to do so is to make sure the following lines appear in a
996 file named .gitconfig in your home directory:
998 ------------------------------------------------
999 [user]
1000         name = Your Name Comes Here
1001         email =
1002 ------------------------------------------------
1004 (See the "CONFIGURATION FILE" section of linkgit:git-config[1] for
1005 details on the configuration file.)
1008 [[creating-a-new-repository]]
1009 Creating a new repository
1010 -------------------------
1012 Creating a new repository from scratch is very easy:
1014 -------------------------------------------------
1015 $ mkdir project
1016 $ cd project
1017 $ git init
1018 -------------------------------------------------
1020 If you have some initial content (say, a tarball):
1022 -------------------------------------------------
1023 $ tar xzvf project.tar.gz
1024 $ cd project
1025 $ git init
1026 $ git add . # include everything below ./ in the first commit:
1027 $ git commit
1028 -------------------------------------------------
1030 [[how-to-make-a-commit]]
1031 How to make a commit
1032 --------------------
1034 Creating a new commit takes three steps:
1036         1. Making some changes to the working directory using your
1037            favorite editor.
1038         2. Telling git about your changes.
1039         3. Creating the commit using the content you told git about
1040            in step 2.
1042 In practice, you can interleave and repeat steps 1 and 2 as many
1043 times as you want: in order to keep track of what you want committed
1044 at step 3, git maintains a snapshot of the tree's contents in a
1045 special staging area called "the index."
1047 At the beginning, the content of the index will be identical to
1048 that of the HEAD.  The command "git diff --cached", which shows
1049 the difference between the HEAD and the index, should therefore
1050 produce no output at that point.
1052 Modifying the index is easy:
1054 To update the index with the new contents of a modified file, use
1056 -------------------------------------------------
1057 $ git add path/to/file
1058 -------------------------------------------------
1060 To add the contents of a new file to the index, use
1062 -------------------------------------------------
1063 $ git add path/to/file
1064 -------------------------------------------------
1066 To remove a file from the index and from the working tree,
1068 -------------------------------------------------
1069 $ git rm path/to/file
1070 -------------------------------------------------
1072 After each step you can verify that
1074 -------------------------------------------------
1075 $ git diff --cached
1076 -------------------------------------------------
1078 always shows the difference between the HEAD and the index file--this
1079 is what you'd commit if you created the commit now--and that
1081 -------------------------------------------------
1082 $ git diff
1083 -------------------------------------------------
1085 shows the difference between the working tree and the index file.
1087 Note that "git add" always adds just the current contents of a file
1088 to the index; further changes to the same file will be ignored unless
1089 you run `git add` on the file again.
1091 When you're ready, just run
1093 -------------------------------------------------
1094 $ git commit
1095 -------------------------------------------------
1097 and git will prompt you for a commit message and then create the new
1098 commit.  Check to make sure it looks like what you expected with
1100 -------------------------------------------------
1101 $ git show
1102 -------------------------------------------------
1104 As a special shortcut,
1106 -------------------------------------------------
1107 $ git commit -a
1108 -------------------------------------------------
1110 will update the index with any files that you've modified or removed
1111 and create a commit, all in one step.
1113 A number of commands are useful for keeping track of what you're
1114 about to commit:
1116 -------------------------------------------------
1117 $ git diff --cached # difference between HEAD and the index; what
1118                     # would be committed if you ran "commit" now.
1119 $ git diff          # difference between the index file and your
1120                     # working directory; changes that would not
1121                     # be included if you ran "commit" now.
1122 $ git diff HEAD     # difference between HEAD and working tree; what
1123                     # would be committed if you ran "commit -a" now.
1124 $ git status        # a brief per-file summary of the above.
1125 -------------------------------------------------
1127 You can also use linkgit:git-gui[1] to create commits, view changes in
1128 the index and the working tree files, and individually select diff hunks
1129 for inclusion in the index (by right-clicking on the diff hunk and
1130 choosing "Stage Hunk For Commit").
1132 [[creating-good-commit-messages]]
1133 Creating good commit messages
1134 -----------------------------
1136 Though not required, it's a good idea to begin the commit message
1137 with a single short (less than 50 character) line summarizing the
1138 change, followed by a blank line and then a more thorough
1139 description.  Tools that turn commits into email, for example, use
1140 the first line on the Subject line and the rest of the commit in the
1141 body.
1143 [[ignoring-files]]
1144 Ignoring files
1145 --------------
1147 A project will often generate files that you do 'not' want to track with git.
1148 This typically includes files generated by a build process or temporary
1149 backup files made by your editor. Of course, 'not' tracking files with git
1150 is just a matter of 'not' calling `git add` on them. But it quickly becomes
1151 annoying to have these untracked files lying around; e.g. they make
1152 `git add .` practically useless, and they keep showing up in the output of
1153 `git status`.
1155 You can tell git to ignore certain files by creating a file called .gitignore
1156 in the top level of your working directory, with contents such as:
1158 -------------------------------------------------
1159 # Lines starting with '#' are considered comments.
1160 # Ignore any file named foo.txt.
1161 foo.txt
1162 # Ignore (generated) html files,
1163 *.html
1164 # except foo.html which is maintained by hand.
1165 !foo.html
1166 # Ignore objects and archives.
1167 *.[oa]
1168 -------------------------------------------------
1170 See linkgit:gitignore[5] for a detailed explanation of the syntax.  You can
1171 also place .gitignore files in other directories in your working tree, and they
1172 will apply to those directories and their subdirectories.  The `.gitignore`
1173 files can be added to your repository like any other files (just run `git add
1174 .gitignore` and `git commit`, as usual), which is convenient when the exclude
1175 patterns (such as patterns matching build output files) would also make sense
1176 for other users who clone your repository.
1178 If you wish the exclude patterns to affect only certain repositories
1179 (instead of every repository for a given project), you may instead put
1180 them in a file in your repository named .git/info/exclude, or in any file
1181 specified by the `core.excludesfile` configuration variable.  Some git
1182 commands can also take exclude patterns directly on the command line.
1183 See linkgit:gitignore[5] for the details.
1185 [[how-to-merge]]
1186 How to merge
1187 ------------
1189 You can rejoin two diverging branches of development using
1190 linkgit:git-merge[1]:
1192 -------------------------------------------------
1193 $ git merge branchname
1194 -------------------------------------------------
1196 merges the development in the branch "branchname" into the current
1197 branch.
1199 A merge is made by combining the changes made in "branchname" and the
1200 changes made up to the latest commit in your current branch since
1201 their histories forked. The work tree is overwritten by the result of
1202 the merge when this combining is done cleanly, or overwritten by a
1203 half-merged results when this combining results in conflicts.
1204 Therefore, if you have uncommitted changes touching the same files as
1205 the ones impacted by the merge, Git will refuse to proceed. Most of
1206 the time, you will want to commit your changes before you can merge,
1207 and if you don't, then linkgit:git-stash[1] can take these changes
1208 away while you're doing the merge, and reapply them afterwards.
1210 If the changes are independent enough, Git will automatically complete
1211 the merge and commit the result (or reuse an existing commit in case
1212 of <<fast-forwards,fast-forward>>, see below). On the other hand,
1213 if there are conflicts--for example, if the same file is
1214 modified in two different ways in the remote branch and the local
1215 branch--then you are warned; the output may look something like this:
1217 -------------------------------------------------
1218 $ git merge next
1219  100% (4/4) done
1220 Auto-merged file.txt
1221 CONFLICT (content): Merge conflict in file.txt
1222 Automatic merge failed; fix conflicts and then commit the result.
1223 -------------------------------------------------
1225 Conflict markers are left in the problematic files, and after
1226 you resolve the conflicts manually, you can update the index
1227 with the contents and run git commit, as you normally would when
1228 creating a new file.
1230 If you examine the resulting commit using gitk, you will see that it
1231 has two parents, one pointing to the top of the current branch, and
1232 one to the top of the other branch.
1234 [[resolving-a-merge]]
1235 Resolving a merge
1236 -----------------
1238 When a merge isn't resolved automatically, git leaves the index and
1239 the working tree in a special state that gives you all the
1240 information you need to help resolve the merge.
1242 Files with conflicts are marked specially in the index, so until you
1243 resolve the problem and update the index, linkgit:git-commit[1] will
1244 fail:
1246 -------------------------------------------------
1247 $ git commit
1248 file.txt: needs merge
1249 -------------------------------------------------
1251 Also, linkgit:git-status[1] will list those files as "unmerged", and the
1252 files with conflicts will have conflict markers added, like this:
1254 -------------------------------------------------
1255 <<<<<<< HEAD:file.txt
1256 Hello world
1257 =======
1258 Goodbye
1259 >>>>>>> 77976da35a11db4580b80ae27e8d65caf5208086:file.txt
1260 -------------------------------------------------
1262 All you need to do is edit the files to resolve the conflicts, and then
1264 -------------------------------------------------
1265 $ git add file.txt
1266 $ git commit
1267 -------------------------------------------------
1269 Note that the commit message will already be filled in for you with
1270 some information about the merge.  Normally you can just use this
1271 default message unchanged, but you may add additional commentary of
1272 your own if desired.
1274 The above is all you need to know to resolve a simple merge.  But git
1275 also provides more information to help resolve conflicts:
1277 [[conflict-resolution]]
1278 Getting conflict-resolution help during a merge
1279 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1281 All of the changes that git was able to merge automatically are
1282 already added to the index file, so linkgit:git-diff[1] shows only
1283 the conflicts.  It uses an unusual syntax:
1285 -------------------------------------------------
1286 $ git diff
1287 diff --cc file.txt
1288 index 802992c,2b60207..0000000
1289 --- a/file.txt
1290 +++ b/file.txt
1291 @@@ -1,1 -1,1 +1,5 @@@
1292 ++<<<<<<< HEAD:file.txt
1293  +Hello world
1294 ++=======
1295 + Goodbye
1296 ++>>>>>>> 77976da35a11db4580b80ae27e8d65caf5208086:file.txt
1297 -------------------------------------------------
1299 Recall that the commit which will be committed after we resolve this
1300 conflict will have two parents instead of the usual one: one parent
1301 will be HEAD, the tip of the current branch; the other will be the
1302 tip of the other branch, which is stored temporarily in MERGE_HEAD.
1304 During the merge, the index holds three versions of each file.  Each of
1305 these three "file stages" represents a different version of the file:
1307 -------------------------------------------------
1308 $ git show :1:file.txt  # the file in a common ancestor of both branches
1309 $ git show :2:file.txt  # the version from HEAD.
1310 $ git show :3:file.txt  # the version from MERGE_HEAD.
1311 -------------------------------------------------
1313 When you ask linkgit:git-diff[1] to show the conflicts, it runs a
1314 three-way diff between the conflicted merge results in the work tree with
1315 stages 2 and 3 to show only hunks whose contents come from both sides,
1316 mixed (in other words, when a hunk's merge results come only from stage 2,
1317 that part is not conflicting and is not shown.  Same for stage 3).
1319 The diff above shows the differences between the working-tree version of
1320 file.txt and the stage 2 and stage 3 versions.  So instead of preceding
1321 each line by a single "+" or "-", it now uses two columns: the first
1322 column is used for differences between the first parent and the working
1323 directory copy, and the second for differences between the second parent
1324 and the working directory copy.  (See the "COMBINED DIFF FORMAT" section
1325 of linkgit:git-diff-files[1] for a details of the format.)
1327 After resolving the conflict in the obvious way (but before updating the
1328 index), the diff will look like:
1330 -------------------------------------------------
1331 $ git diff
1332 diff --cc file.txt
1333 index 802992c,2b60207..0000000
1334 --- a/file.txt
1335 +++ b/file.txt
1336 @@@ -1,1 -1,1 +1,1 @@@
1337 - Hello world
1338  -Goodbye
1339 ++Goodbye world
1340 -------------------------------------------------
1342 This shows that our resolved version deleted "Hello world" from the
1343 first parent, deleted "Goodbye" from the second parent, and added
1344 "Goodbye world", which was previously absent from both.
1346 Some special diff options allow diffing the working directory against
1347 any of these stages:
1349 -------------------------------------------------
1350 $ git diff -1 file.txt          # diff against stage 1
1351 $ git diff --base file.txt      # same as the above
1352 $ git diff -2 file.txt          # diff against stage 2
1353 $ git diff --ours file.txt      # same as the above
1354 $ git diff -3 file.txt          # diff against stage 3
1355 $ git diff --theirs file.txt    # same as the above.
1356 -------------------------------------------------
1358 The linkgit:git-log[1] and linkgit:gitk[1] commands also provide special help
1359 for merges:
1361 -------------------------------------------------
1362 $ git log --merge
1363 $ gitk --merge
1364 -------------------------------------------------
1366 These will display all commits which exist only on HEAD or on
1367 MERGE_HEAD, and which touch an unmerged file.
1369 You may also use linkgit:git-mergetool[1], which lets you merge the
1370 unmerged files using external tools such as Emacs or kdiff3.
1372 Each time you resolve the conflicts in a file and update the index:
1374 -------------------------------------------------
1375 $ git add file.txt
1376 -------------------------------------------------
1378 the different stages of that file will be "collapsed", after which
1379 `git diff` will (by default) no longer show diffs for that file.
1381 [[undoing-a-merge]]
1382 Undoing a merge
1383 ---------------
1385 If you get stuck and decide to just give up and throw the whole mess
1386 away, you can always return to the pre-merge state with
1388 -------------------------------------------------
1389 $ git reset --hard HEAD
1390 -------------------------------------------------
1392 Or, if you've already committed the merge that you want to throw away,
1394 -------------------------------------------------
1395 $ git reset --hard ORIG_HEAD
1396 -------------------------------------------------
1398 However, this last command can be dangerous in some cases--never
1399 throw away a commit you have already committed if that commit may
1400 itself have been merged into another branch, as doing so may confuse
1401 further merges.
1403 [[fast-forwards]]
1404 Fast-forward merges
1405 -------------------
1407 There is one special case not mentioned above, which is treated
1408 differently.  Normally, a merge results in a merge commit, with two
1409 parents, one pointing at each of the two lines of development that
1410 were merged.
1412 However, if the current branch is a descendant of the other--so every
1413 commit present in the one is already contained in the other--then git
1414 just performs a "fast-forward"; the head of the current branch is moved
1415 forward to point at the head of the merged-in branch, without any new
1416 commits being created.
1418 [[fixing-mistakes]]
1419 Fixing mistakes
1420 ---------------
1422 If you've messed up the working tree, but haven't yet committed your
1423 mistake, you can return the entire working tree to the last committed
1424 state with
1426 -------------------------------------------------
1427 $ git reset --hard HEAD
1428 -------------------------------------------------
1430 If you make a commit that you later wish you hadn't, there are two
1431 fundamentally different ways to fix the problem:
1433         1. You can create a new commit that undoes whatever was done
1434         by the old commit.  This is the correct thing if your
1435         mistake has already been made public.
1437         2. You can go back and modify the old commit.  You should
1438         never do this if you have already made the history public;
1439         git does not normally expect the "history" of a project to
1440         change, and cannot correctly perform repeated merges from
1441         a branch that has had its history changed.
1443 [[reverting-a-commit]]
1444 Fixing a mistake with a new commit
1445 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1447 Creating a new commit that reverts an earlier change is very easy;
1448 just pass the linkgit:git-revert[1] command a reference to the bad
1449 commit; for example, to revert the most recent commit:
1451 -------------------------------------------------
1452 $ git revert HEAD
1453 -------------------------------------------------
1455 This will create a new commit which undoes the change in HEAD.  You
1456 will be given a chance to edit the commit message for the new commit.
1458 You can also revert an earlier change, for example, the next-to-last:
1460 -------------------------------------------------
1461 $ git revert HEAD^
1462 -------------------------------------------------
1464 In this case git will attempt to undo the old change while leaving
1465 intact any changes made since then.  If more recent changes overlap
1466 with the changes to be reverted, then you will be asked to fix
1467 conflicts manually, just as in the case of <<resolving-a-merge,
1468 resolving a merge>>.
1470 [[fixing-a-mistake-by-rewriting-history]]
1471 Fixing a mistake by rewriting history
1472 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1474 If the problematic commit is the most recent commit, and you have not
1475 yet made that commit public, then you may just
1476 <<undoing-a-merge,destroy it using `git reset`>>.
1478 Alternatively, you
1479 can edit the working directory and update the index to fix your
1480 mistake, just as if you were going to <<how-to-make-a-commit,create a
1481 new commit>>, then run
1483 -------------------------------------------------
1484 $ git commit --amend
1485 -------------------------------------------------
1487 which will replace the old commit by a new commit incorporating your
1488 changes, giving you a chance to edit the old commit message first.
1490 Again, you should never do this to a commit that may already have
1491 been merged into another branch; use linkgit:git-revert[1] instead in
1492 that case.
1494 It is also possible to replace commits further back in the history, but
1495 this is an advanced topic to be left for
1496 <<cleaning-up-history,another chapter>>.
1498 [[checkout-of-path]]
1499 Checking out an old version of a file
1500 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1502 In the process of undoing a previous bad change, you may find it
1503 useful to check out an older version of a particular file using
1504 linkgit:git-checkout[1].  We've used `git checkout` before to switch
1505 branches, but it has quite different behavior if it is given a path
1506 name: the command
1508 -------------------------------------------------
1509 $ git checkout HEAD^ path/to/file
1510 -------------------------------------------------
1512 replaces path/to/file by the contents it had in the commit HEAD^, and
1513 also updates the index to match.  It does not change branches.
1515 If you just want to look at an old version of the file, without
1516 modifying the working directory, you can do that with
1517 linkgit:git-show[1]:
1519 -------------------------------------------------
1520 $ git show HEAD^:path/to/file
1521 -------------------------------------------------
1523 which will display the given version of the file.
1525 [[interrupted-work]]
1526 Temporarily setting aside work in progress
1527 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1529 While you are in the middle of working on something complicated, you
1530 find an unrelated but obvious and trivial bug.  You would like to fix it
1531 before continuing.  You can use linkgit:git-stash[1] to save the current
1532 state of your work, and after fixing the bug (or, optionally after doing
1533 so on a different branch and then coming back), unstash the
1534 work-in-progress changes.
1536 ------------------------------------------------
1537 $ git stash save "work in progress for foo feature"
1538 ------------------------------------------------
1540 This command will save your changes away to the `stash`, and
1541 reset your working tree and the index to match the tip of your
1542 current branch.  Then you can make your fix as usual.
1544 ------------------------------------------------
1545 ... edit and test ...
1546 $ git commit -a -m "blorpl: typofix"
1547 ------------------------------------------------
1549 After that, you can go back to what you were working on with
1550 `git stash pop`:
1552 ------------------------------------------------
1553 $ git stash pop
1554 ------------------------------------------------
1557 [[ensuring-good-performance]]
1558 Ensuring good performance
1559 -------------------------
1561 On large repositories, git depends on compression to keep the history
1562 information from taking up too much space on disk or in memory.
1564 This compression is not performed automatically.  Therefore you
1565 should occasionally run linkgit:git-gc[1]:
1567 -------------------------------------------------
1568 $ git gc
1569 -------------------------------------------------
1571 to recompress the archive.  This can be very time-consuming, so
1572 you may prefer to run `git gc` when you are not doing other work.
1575 [[ensuring-reliability]]
1576 Ensuring reliability
1577 --------------------
1579 [[checking-for-corruption]]
1580 Checking the repository for corruption
1581 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1583 The linkgit:git-fsck[1] command runs a number of self-consistency checks
1584 on the repository, and reports on any problems.  This may take some
1585 time.  The most common warning by far is about "dangling" objects:
1587 -------------------------------------------------
1588 $ git fsck
1589 dangling commit 7281251ddd2a61e38657c827739c57015671a6b3
1590 dangling commit 2706a059f258c6b245f298dc4ff2ccd30ec21a63
1591 dangling commit 13472b7c4b80851a1bc551779171dcb03655e9b5
1592 dangling blob 218761f9d90712d37a9c5e36f406f92202db07eb
1593 dangling commit bf093535a34a4d35731aa2bd90fe6b176302f14f
1594 dangling commit 8e4bec7f2ddaa268bef999853c25755452100f8e
1595 dangling tree d50bb86186bf27b681d25af89d3b5b68382e4085
1596 dangling tree b24c2473f1fd3d91352a624795be026d64c8841f
1598 -------------------------------------------------
1600 Dangling objects are not a problem.  At worst they may take up a little
1601 extra disk space.  They can sometimes provide a last-resort method for
1602 recovering lost work--see <<dangling-objects>> for details.
1604 [[recovering-lost-changes]]
1605 Recovering lost changes
1606 ~~~~~~~~~~~~~~~~~~~~~~~
1608 [[reflogs]]
1609 Reflogs
1610 ^^^^^^^
1612 Say you modify a branch with `linkgit:git-reset[1] --hard`, and then
1613 realize that the branch was the only reference you had to that point in
1614 history.
1616 Fortunately, git also keeps a log, called a "reflog", of all the
1617 previous values of each branch.  So in this case you can still find the
1618 old history using, for example,
1620 -------------------------------------------------
1621 $ git log master@{1}
1622 -------------------------------------------------
1624 This lists the commits reachable from the previous version of the
1625 "master" branch head.  This syntax can be used with any git command
1626 that accepts a commit, not just with git log.  Some other examples:
1628 -------------------------------------------------
1629 $ git show master@{2}           # See where the branch pointed 2,
1630 $ git show master@{3}           # 3, ... changes ago.
1631 $ gitk master@{yesterday}       # See where it pointed yesterday,
1632 $ gitk master@{"1 week ago"}    # ... or last week
1633 $ git log --walk-reflogs master # show reflog entries for master
1634 -------------------------------------------------
1636 A separate reflog is kept for the HEAD, so
1638 -------------------------------------------------
1639 $ git show HEAD@{"1 week ago"}
1640 -------------------------------------------------
1642 will show what HEAD pointed to one week ago, not what the current branch
1643 pointed to one week ago.  This allows you to see the history of what
1644 you've checked out.
1646 The reflogs are kept by default for 30 days, after which they may be
1647 pruned.  See linkgit:git-reflog[1] and linkgit:git-gc[1] to learn
1648 how to control this pruning, and see the "SPECIFYING REVISIONS"
1649 section of linkgit:gitrevisions[7] for details.
1651 Note that the reflog history is very different from normal git history.
1652 While normal history is shared by every repository that works on the
1653 same project, the reflog history is not shared: it tells you only about
1654 how the branches in your local repository have changed over time.
1656 [[dangling-object-recovery]]
1657 Examining dangling objects
1658 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1660 In some situations the reflog may not be able to save you.  For example,
1661 suppose you delete a branch, then realize you need the history it
1662 contained.  The reflog is also deleted; however, if you have not yet
1663 pruned the repository, then you may still be able to find the lost
1664 commits in the dangling objects that `git fsck` reports.  See
1665 <<dangling-objects>> for the details.
1667 -------------------------------------------------
1668 $ git fsck
1669 dangling commit 7281251ddd2a61e38657c827739c57015671a6b3
1670 dangling commit 2706a059f258c6b245f298dc4ff2ccd30ec21a63
1671 dangling commit 13472b7c4b80851a1bc551779171dcb03655e9b5
1673 -------------------------------------------------
1675 You can examine
1676 one of those dangling commits with, for example,
1678 ------------------------------------------------
1679 $ gitk 7281251ddd --not --all
1680 ------------------------------------------------
1682 which does what it sounds like: it says that you want to see the commit
1683 history that is described by the dangling commit(s), but not the
1684 history that is described by all your existing branches and tags.  Thus
1685 you get exactly the history reachable from that commit that is lost.
1686 (And notice that it might not be just one commit: we only report the
1687 "tip of the line" as being dangling, but there might be a whole deep
1688 and complex commit history that was dropped.)
1690 If you decide you want the history back, you can always create a new
1691 reference pointing to it, for example, a new branch:
1693 ------------------------------------------------
1694 $ git branch recovered-branch 7281251ddd
1695 ------------------------------------------------
1697 Other types of dangling objects (blobs and trees) are also possible, and
1698 dangling objects can arise in other situations.
1701 [[sharing-development]]
1702 Sharing development with others
1703 ===============================
1705 [[getting-updates-With-git-pull]]
1706 Getting updates with git pull
1707 -----------------------------
1709 After you clone a repository and commit a few changes of your own, you
1710 may wish to check the original repository for updates and merge them
1711 into your own work.
1713 We have already seen <<Updating-a-repository-With-git-fetch,how to
1714 keep remote-tracking branches up to date>> with linkgit:git-fetch[1],
1715 and how to merge two branches.  So you can merge in changes from the
1716 original repository's master branch with:
1718 -------------------------------------------------
1719 $ git fetch
1720 $ git merge origin/master
1721 -------------------------------------------------
1723 However, the linkgit:git-pull[1] command provides a way to do this in
1724 one step:
1726 -------------------------------------------------
1727 $ git pull origin master
1728 -------------------------------------------------
1730 In fact, if you have "master" checked out, then this branch has been
1731 configured by "git clone" to get changes from the HEAD branch of the
1732 origin repository.  So often you can
1733 accomplish the above with just a simple
1735 -------------------------------------------------
1736 $ git pull
1737 -------------------------------------------------
1739 This command will fetch changes from the remote branches to your
1740 remote-tracking branches `origin/*`, and merge the default branch into
1741 the current branch.
1743 More generally, a branch that is created from a remote-tracking branch
1744 will pull
1745 by default from that branch.  See the descriptions of the
1746 branch.<name>.remote and branch.<name>.merge options in
1747 linkgit:git-config[1], and the discussion of the `--track` option in
1748 linkgit:git-checkout[1], to learn how to control these defaults.
1750 In addition to saving you keystrokes, "git pull" also helps you by
1751 producing a default commit message documenting the branch and
1752 repository that you pulled from.
1754 (But note that no such commit will be created in the case of a
1755 <<fast-forwards,fast-forward>>; instead, your branch will just be
1756 updated to point to the latest commit from the upstream branch.)
1758 The `git pull` command can also be given "." as the "remote" repository,
1759 in which case it just merges in a branch from the current repository; so
1760 the commands
1762 -------------------------------------------------
1763 $ git pull . branch
1764 $ git merge branch
1765 -------------------------------------------------
1767 are roughly equivalent.  The former is actually very commonly used.
1769 [[submitting-patches]]
1770 Submitting patches to a project
1771 -------------------------------
1773 If you just have a few changes, the simplest way to submit them may
1774 just be to send them as patches in email:
1776 First, use linkgit:git-format-patch[1]; for example:
1778 -------------------------------------------------
1779 $ git format-patch origin
1780 -------------------------------------------------
1782 will produce a numbered series of files in the current directory, one
1783 for each patch in the current branch but not in origin/HEAD.
1785 You can then import these into your mail client and send them by
1786 hand.  However, if you have a lot to send at once, you may prefer to
1787 use the linkgit:git-send-email[1] script to automate the process.
1788 Consult the mailing list for your project first to determine how they
1789 prefer such patches be handled.
1791 [[importing-patches]]
1792 Importing patches to a project
1793 ------------------------------
1795 Git also provides a tool called linkgit:git-am[1] (am stands for
1796 "apply mailbox"), for importing such an emailed series of patches.
1797 Just save all of the patch-containing messages, in order, into a
1798 single mailbox file, say "patches.mbox", then run
1800 -------------------------------------------------
1801 $ git am -3 patches.mbox
1802 -------------------------------------------------
1804 Git will apply each patch in order; if any conflicts are found, it
1805 will stop, and you can fix the conflicts as described in
1806 "<<resolving-a-merge,Resolving a merge>>".  (The "-3" option tells
1807 git to perform a merge; if you would prefer it just to abort and
1808 leave your tree and index untouched, you may omit that option.)
1810 Once the index is updated with the results of the conflict
1811 resolution, instead of creating a new commit, just run
1813 -------------------------------------------------
1814 $ git am --resolved
1815 -------------------------------------------------
1817 and git will create the commit for you and continue applying the
1818 remaining patches from the mailbox.
1820 The final result will be a series of commits, one for each patch in
1821 the original mailbox, with authorship and commit log message each
1822 taken from the message containing each patch.
1824 [[public-repositories]]
1825 Public git repositories
1826 -----------------------
1828 Another way to submit changes to a project is to tell the maintainer
1829 of that project to pull the changes from your repository using
1830 linkgit:git-pull[1].  In the section "<<getting-updates-With-git-pull,
1831 Getting updates with `git pull`>>" we described this as a way to get
1832 updates from the "main" repository, but it works just as well in the
1833 other direction.
1835 If you and the maintainer both have accounts on the same machine, then
1836 you can just pull changes from each other's repositories directly;
1837 commands that accept repository URLs as arguments will also accept a
1838 local directory name:
1840 -------------------------------------------------
1841 $ git clone /path/to/repository
1842 $ git pull /path/to/other/repository
1843 -------------------------------------------------
1845 or an ssh URL:
1847 -------------------------------------------------
1848 $ git clone ssh://yourhost/~you/repository
1849 -------------------------------------------------
1851 For projects with few developers, or for synchronizing a few private
1852 repositories, this may be all you need.
1854 However, the more common way to do this is to maintain a separate public
1855 repository (usually on a different host) for others to pull changes
1856 from.  This is usually more convenient, and allows you to cleanly
1857 separate private work in progress from publicly visible work.
1859 You will continue to do your day-to-day work in your personal
1860 repository, but periodically "push" changes from your personal
1861 repository into your public repository, allowing other developers to
1862 pull from that repository.  So the flow of changes, in a situation
1863 where there is one other developer with a public repository, looks
1864 like this:
1866                         you push
1867   your personal repo ------------------> your public repo
1868         ^                                     |
1869         |                                     |
1870         | you pull                            | they pull
1871         |                                     |
1872         |                                     |
1873         |               they push             V
1874   their public repo <------------------- their repo
1876 We explain how to do this in the following sections.
1878 [[setting-up-a-public-repository]]
1879 Setting up a public repository
1880 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1882 Assume your personal repository is in the directory ~/proj.  We
1883 first create a new clone of the repository and tell `git daemon` that it
1884 is meant to be public:
1886 -------------------------------------------------
1887 $ git clone --bare ~/proj proj.git
1888 $ touch proj.git/git-daemon-export-ok
1889 -------------------------------------------------
1891 The resulting directory proj.git contains a "bare" git repository--it is
1892 just the contents of the ".git" directory, without any files checked out
1893 around it.
1895 Next, copy proj.git to the server where you plan to host the
1896 public repository.  You can use scp, rsync, or whatever is most
1897 convenient.
1899 [[exporting-via-git]]
1900 Exporting a git repository via the git protocol
1901 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1903 This is the preferred method.
1905 If someone else administers the server, they should tell you what
1906 directory to put the repository in, and what git:// URL it will appear
1907 at.  You can then skip to the section
1908 "<<pushing-changes-to-a-public-repository,Pushing changes to a public
1909 repository>>", below.
1911 Otherwise, all you need to do is start linkgit:git-daemon[1]; it will
1912 listen on port 9418.  By default, it will allow access to any directory
1913 that looks like a git directory and contains the magic file
1914 git-daemon-export-ok.  Passing some directory paths as `git daemon`
1915 arguments will further restrict the exports to those paths.
1917 You can also run `git daemon` as an inetd service; see the
1918 linkgit:git-daemon[1] man page for details.  (See especially the
1919 examples section.)
1921 [[exporting-via-http]]
1922 Exporting a git repository via http
1923 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1925 The git protocol gives better performance and reliability, but on a
1926 host with a web server set up, http exports may be simpler to set up.
1928 All you need to do is place the newly created bare git repository in
1929 a directory that is exported by the web server, and make some
1930 adjustments to give web clients some extra information they need:
1932 -------------------------------------------------
1933 $ mv proj.git /home/you/public_html/proj.git
1934 $ cd proj.git
1935 $ git --bare update-server-info
1936 $ mv hooks/post-update.sample hooks/post-update
1937 -------------------------------------------------
1939 (For an explanation of the last two lines, see
1940 linkgit:git-update-server-info[1] and linkgit:githooks[5].)
1942 Advertise the URL of proj.git.  Anybody else should then be able to
1943 clone or pull from that URL, for example with a command line like:
1945 -------------------------------------------------
1946 $ git clone
1947 -------------------------------------------------
1949 (See also
1950 link:howto/setup-git-server-over-http.txt[setup-git-server-over-http]
1951 for a slightly more sophisticated setup using WebDAV which also
1952 allows pushing over http.)
1954 [[pushing-changes-to-a-public-repository]]
1955 Pushing changes to a public repository
1956 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1958 Note that the two techniques outlined above (exporting via
1959 <<exporting-via-http,http>> or <<exporting-via-git,git>>) allow other
1960 maintainers to fetch your latest changes, but they do not allow write
1961 access, which you will need to update the public repository with the
1962 latest changes created in your private repository.
1964 The simplest way to do this is using linkgit:git-push[1] and ssh; to
1965 update the remote branch named "master" with the latest state of your
1966 branch named "master", run
1968 -------------------------------------------------
1969 $ git push ssh:// master:master
1970 -------------------------------------------------
1972 or just
1974 -------------------------------------------------
1975 $ git push ssh:// master
1976 -------------------------------------------------
1978 As with `git fetch`, `git push` will complain if this does not result in a
1979 <<fast-forwards,fast-forward>>; see the following section for details on
1980 handling this case.
1982 Note that the target of a "push" is normally a
1983 <<def_bare_repository,bare>> repository.  You can also push to a
1984 repository that has a checked-out working tree, but the working tree
1985 will not be updated by the push.  This may lead to unexpected results if
1986 the branch you push to is the currently checked-out branch!
1988 As with `git fetch`, you may also set up configuration options to
1989 save typing; so, for example, after
1991 -------------------------------------------------
1992 $ cat >>.git/config <<EOF
1993 [remote "public-repo"]
1994         url = ssh://
1996 -------------------------------------------------
1998 you should be able to perform the above push with just
2000 -------------------------------------------------
2001 $ git push public-repo master
2002 -------------------------------------------------
2004 See the explanations of the remote.<name>.url, branch.<name>.remote,
2005 and remote.<name>.push options in linkgit:git-config[1] for
2006 details.
2008 [[forcing-push]]
2009 What to do when a push fails
2010 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2012 If a push would not result in a <<fast-forwards,fast-forward>> of the
2013 remote branch, then it will fail with an error like:
2015 -------------------------------------------------
2016 error: remote 'refs/heads/master' is not an ancestor of
2017  local  'refs/heads/master'.
2018  Maybe you are not up-to-date and need to pull first?
2019 error: failed to push to 'ssh://'
2020 -------------------------------------------------
2022 This can happen, for example, if you:
2024         - use `git reset --hard` to remove already-published commits, or
2025         - use `git commit --amend` to replace already-published commits
2026           (as in <<fixing-a-mistake-by-rewriting-history>>), or
2027         - use `git rebase` to rebase any already-published commits (as
2028           in <<using-git-rebase>>).
2030 You may force `git push` to perform the update anyway by preceding the
2031 branch name with a plus sign:
2033 -------------------------------------------------
2034 $ git push ssh:// +master
2035 -------------------------------------------------
2037 Normally whenever a branch head in a public repository is modified, it
2038 is modified to point to a descendant of the commit that it pointed to
2039 before.  By forcing a push in this situation, you break that convention.
2040 (See <<problems-With-rewriting-history>>.)
2042 Nevertheless, this is a common practice for people that need a simple
2043 way to publish a work-in-progress patch series, and it is an acceptable
2044 compromise as long as you warn other developers that this is how you
2045 intend to manage the branch.
2047 It's also possible for a push to fail in this way when other people have
2048 the right to push to the same repository.  In that case, the correct
2049 solution is to retry the push after first updating your work: either by a
2050 pull, or by a fetch followed by a rebase; see the
2051 <<setting-up-a-shared-repository,next section>> and
2052 linkgit:gitcvs-migration[7] for more.
2054 [[setting-up-a-shared-repository]]
2055 Setting up a shared repository
2056 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2058 Another way to collaborate is by using a model similar to that
2059 commonly used in CVS, where several developers with special rights
2060 all push to and pull from a single shared repository.  See
2061 linkgit:gitcvs-migration[7] for instructions on how to
2062 set this up.
2064 However, while there is nothing wrong with git's support for shared
2065 repositories, this mode of operation is not generally recommended,
2066 simply because the mode of collaboration that git supports--by
2067 exchanging patches and pulling from public repositories--has so many
2068 advantages over the central shared repository:
2070         - Git's ability to quickly import and merge patches allows a
2071           single maintainer to process incoming changes even at very
2072           high rates.  And when that becomes too much, `git pull` provides
2073           an easy way for that maintainer to delegate this job to other
2074           maintainers while still allowing optional review of incoming
2075           changes.
2076         - Since every developer's repository has the same complete copy
2077           of the project history, no repository is special, and it is
2078           trivial for another developer to take over maintenance of a
2079           project, either by mutual agreement, or because a maintainer
2080           becomes unresponsive or difficult to work with.
2081         - The lack of a central group of "committers" means there is
2082           less need for formal decisions about who is "in" and who is
2083           "out".
2085 [[setting-up-gitweb]]
2086 Allowing web browsing of a repository
2087 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2089 The gitweb cgi script provides users an easy way to browse your
2090 project's files and history without having to install git; see the file
2091 gitweb/INSTALL in the git source tree for instructions on setting it up.
2093 [[sharing-development-examples]]
2094 Examples
2095 --------
2097 [[maintaining-topic-branches]]
2098 Maintaining topic branches for a Linux subsystem maintainer
2099 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2101 This describes how Tony Luck uses git in his role as maintainer of the
2102 IA64 architecture for the Linux kernel.
2104 He uses two public branches:
2106  - A "test" tree into which patches are initially placed so that they
2107    can get some exposure when integrated with other ongoing development.
2108    This tree is available to Andrew for pulling into -mm whenever he
2109    wants.
2111  - A "release" tree into which tested patches are moved for final sanity
2112    checking, and as a vehicle to send them upstream to Linus (by sending
2113    him a "please pull" request.)
2115 He also uses a set of temporary branches ("topic branches"), each
2116 containing a logical grouping of patches.
2118 To set this up, first create your work tree by cloning Linus's public
2119 tree:
2121 -------------------------------------------------
2122 $ git clone git:// work
2123 $ cd work
2124 -------------------------------------------------
2126 Linus's tree will be stored in the remote-tracking branch named origin/master,
2127 and can be updated using linkgit:git-fetch[1]; you can track other
2128 public trees using linkgit:git-remote[1] to set up a "remote" and
2129 linkgit:git-fetch[1] to keep them up-to-date; see
2130 <<repositories-and-branches>>.
2132 Now create the branches in which you are going to work; these start out
2133 at the current tip of origin/master branch, and should be set up (using
2134 the --track option to linkgit:git-branch[1]) to merge changes in from
2135 Linus by default.
2137 -------------------------------------------------
2138 $ git branch --track test origin/master
2139 $ git branch --track release origin/master
2140 -------------------------------------------------
2142 These can be easily kept up to date using linkgit:git-pull[1].
2144 -------------------------------------------------
2145 $ git checkout test && git pull
2146 $ git checkout release && git pull
2147 -------------------------------------------------
2149 Important note!  If you have any local changes in these branches, then
2150 this merge will create a commit object in the history (with no local
2151 changes git will simply do a "fast-forward" merge).  Many people dislike
2152 the "noise" that this creates in the Linux history, so you should avoid
2153 doing this capriciously in the "release" branch, as these noisy commits
2154 will become part of the permanent history when you ask Linus to pull
2155 from the release branch.
2157 A few configuration variables (see linkgit:git-config[1]) can
2158 make it easy to push both branches to your public tree.  (See
2159 <<setting-up-a-public-repository>>.)
2161 -------------------------------------------------
2162 $ cat >> .git/config <<EOF
2163 [remote "mytree"]
2164         url =
2165         push = release
2166         push = test
2168 -------------------------------------------------
2170 Then you can push both the test and release trees using
2171 linkgit:git-push[1]:
2173 -------------------------------------------------
2174 $ git push mytree
2175 -------------------------------------------------
2177 or push just one of the test and release branches using:
2179 -------------------------------------------------
2180 $ git push mytree test
2181 -------------------------------------------------
2185 -------------------------------------------------
2186 $ git push mytree release
2187 -------------------------------------------------
2189 Now to apply some patches from the community.  Think of a short
2190 snappy name for a branch to hold this patch (or related group of
2191 patches), and create a new branch from a recent stable tag of
2192 Linus's branch. Picking a stable base for your branch will:
2193 1) help you: by avoiding inclusion of unrelated and perhaps lightly
2194 tested changes
2195 2) help future bug hunters that use "git bisect" to find problems
2197 -------------------------------------------------
2198 $ git checkout -b speed-up-spinlocks v2.6.35
2199 -------------------------------------------------
2201 Now you apply the patch(es), run some tests, and commit the change(s).  If
2202 the patch is a multi-part series, then you should apply each as a separate
2203 commit to this branch.
2205 -------------------------------------------------
2206 $ ... patch ... test  ... commit [ ... patch ... test ... commit ]*
2207 -------------------------------------------------
2209 When you are happy with the state of this change, you can pull it into the
2210 "test" branch in preparation to make it public:
2212 -------------------------------------------------
2213 $ git checkout test && git pull . speed-up-spinlocks
2214 -------------------------------------------------
2216 It is unlikely that you would have any conflicts here ... but you might if you
2217 spent a while on this step and had also pulled new versions from upstream.
2219 Some time later when enough time has passed and testing done, you can pull the
2220 same branch into the "release" tree ready to go upstream.  This is where you
2221 see the value of keeping each patch (or patch series) in its own branch.  It
2222 means that the patches can be moved into the "release" tree in any order.
2224 -------------------------------------------------
2225 $ git checkout release && git pull . speed-up-spinlocks
2226 -------------------------------------------------
2228 After a while, you will have a number of branches, and despite the
2229 well chosen names you picked for each of them, you may forget what
2230 they are for, or what status they are in.  To get a reminder of what
2231 changes are in a specific branch, use:
2233 -------------------------------------------------
2234 $ git log linux..branchname | git shortlog
2235 -------------------------------------------------
2237 To see whether it has already been merged into the test or release branches,
2238 use:
2240 -------------------------------------------------
2241 $ git log test..branchname
2242 -------------------------------------------------
2246 -------------------------------------------------
2247 $ git log release..branchname
2248 -------------------------------------------------
2250 (If this branch has not yet been merged, you will see some log entries.
2251 If it has been merged, then there will be no output.)
2253 Once a patch completes the great cycle (moving from test to release,
2254 then pulled by Linus, and finally coming back into your local
2255 "origin/master" branch), the branch for this change is no longer needed.
2256 You detect this when the output from:
2258 -------------------------------------------------
2259 $ git log origin..branchname
2260 -------------------------------------------------
2262 is empty.  At this point the branch can be deleted:
2264 -------------------------------------------------
2265 $ git branch -d branchname
2266 -------------------------------------------------
2268 Some changes are so trivial that it is not necessary to create a separate
2269 branch and then merge into each of the test and release branches.  For
2270 these changes, just apply directly to the "release" branch, and then
2271 merge that into the "test" branch.
2273 To create diffstat and shortlog summaries of changes to include in a "please
2274 pull" request to Linus you can use:
2276 -------------------------------------------------
2277 $ git diff --stat origin..release
2278 -------------------------------------------------
2282 -------------------------------------------------
2283 $ git log -p origin..release | git shortlog
2284 -------------------------------------------------
2286 Here are some of the scripts that simplify all this even further.
2288 -------------------------------------------------
2289 ==== update script ====
2290 # Update a branch in my GIT tree.  If the branch to be updated
2291 # is origin, then pull from  Otherwise merge
2292 # origin/master branch into test|release branch
2294 case "$1" in
2295 test|release)
2296         git checkout $1 && git pull . origin
2297         ;;
2298 origin)
2299         before=$(git rev-parse refs/remotes/origin/master)
2300         git fetch origin
2301         after=$(git rev-parse refs/remotes/origin/master)
2302         if [ $before != $after ]
2303         then
2304                 git log $before..$after | git shortlog
2305         fi
2306         ;;
2308         echo "Usage: $0 origin|test|release" 1>&2
2309         exit 1
2310         ;;
2311 esac
2312 -------------------------------------------------
2314 -------------------------------------------------
2315 ==== merge script ====
2316 # Merge a branch into either the test or release branch
2318 pname=$0
2320 usage()
2322         echo "Usage: $pname branch test|release" 1>&2
2323         exit 1
2326 git show-ref -q --verify -- refs/heads/"$1" || {
2327         echo "Can't see branch <$1>" 1>&2
2328         usage
2331 case "$2" in
2332 test|release)
2333         if [ $(git log $2..$1 | wc -c) -eq 0 ]
2334         then
2335                 echo $1 already merged into $2 1>&2
2336                 exit 1
2337         fi
2338         git checkout $2 && git pull . $1
2339         ;;
2341         usage
2342         ;;
2343 esac
2344 -------------------------------------------------
2346 -------------------------------------------------
2347 ==== status script ====
2348 # report on status of my ia64 GIT tree
2350 gb=$(tput setab 2)
2351 rb=$(tput setab 1)
2352 restore=$(tput setab 9)
2354 if [ `git rev-list test..release | wc -c` -gt 0 ]
2355 then
2356         echo $rb Warning: commits in release that are not in test $restore
2357         git log test..release
2360 for branch in `git show-ref --heads | sed 's|^.*/||'`
2362         if [ $branch = test -o $branch = release ]
2363         then
2364                 continue
2365         fi
2367         echo -n $gb ======= $branch ====== $restore " "
2368         status=
2369         for ref in test release origin/master
2370         do
2371                 if [ `git rev-list $ref..$branch | wc -c` -gt 0 ]
2372                 then
2373                         status=$status${ref:0:1}
2374                 fi
2375         done
2376         case $status in
2377         trl)
2378                 echo $rb Need to pull into test $restore
2379                 ;;
2380         rl)
2381                 echo "In test"
2382                 ;;
2383         l)
2384                 echo "Waiting for linus"
2385                 ;;
2386         "")
2387                 echo $rb All done $restore
2388                 ;;
2389         *)
2390                 echo $rb "<$status>" $restore
2391                 ;;
2392         esac
2393         git log origin/master..$branch | git shortlog
2394 done
2395 -------------------------------------------------
2398 [[cleaning-up-history]]
2399 Rewriting history and maintaining patch series
2400 ==============================================
2402 Normally commits are only added to a project, never taken away or
2403 replaced.  Git is designed with this assumption, and violating it will
2404 cause git's merge machinery (for example) to do the wrong thing.
2406 However, there is a situation in which it can be useful to violate this
2407 assumption.
2409 [[patch-series]]
2410 Creating the perfect patch series
2411 ---------------------------------
2413 Suppose you are a contributor to a large project, and you want to add a
2414 complicated feature, and to present it to the other developers in a way
2415 that makes it easy for them to read your changes, verify that they are
2416 correct, and understand why you made each change.
2418 If you present all of your changes as a single patch (or commit), they
2419 may find that it is too much to digest all at once.
2421 If you present them with the entire history of your work, complete with
2422 mistakes, corrections, and dead ends, they may be overwhelmed.
2424 So the ideal is usually to produce a series of patches such that:
2426         1. Each patch can be applied in order.
2428         2. Each patch includes a single logical change, together with a
2429            message explaining the change.
2431         3. No patch introduces a regression: after applying any initial
2432            part of the series, the resulting project still compiles and
2433            works, and has no bugs that it didn't have before.
2435         4. The complete series produces the same end result as your own
2436            (probably much messier!) development process did.
2438 We will introduce some tools that can help you do this, explain how to
2439 use them, and then explain some of the problems that can arise because
2440 you are rewriting history.
2442 [[using-git-rebase]]
2443 Keeping a patch series up to date using git rebase
2444 --------------------------------------------------
2446 Suppose that you create a branch "mywork" on a remote-tracking branch
2447 "origin", and create some commits on top of it:
2449 -------------------------------------------------
2450 $ git checkout -b mywork origin
2451 $ vi file.txt
2452 $ git commit
2453 $ vi otherfile.txt
2454 $ git commit
2456 -------------------------------------------------
2458 You have performed no merges into mywork, so it is just a simple linear
2459 sequence of patches on top of "origin":
2461 ................................................
2462  o--o--O <-- origin
2463         \
2464          a--b--c <-- mywork
2465 ................................................
2467 Some more interesting work has been done in the upstream project, and
2468 "origin" has advanced:
2470 ................................................
2471  o--o--O--o--o--o <-- origin
2472         \
2473          a--b--c <-- mywork
2474 ................................................
2476 At this point, you could use "pull" to merge your changes back in;
2477 the result would create a new merge commit, like this:
2479 ................................................
2480  o--o--O--o--o--o <-- origin
2481         \        \
2482          a--b--c--m <-- mywork
2483 ................................................
2485 However, if you prefer to keep the history in mywork a simple series of
2486 commits without any merges, you may instead choose to use
2487 linkgit:git-rebase[1]:
2489 -------------------------------------------------
2490 $ git checkout mywork
2491 $ git rebase origin
2492 -------------------------------------------------
2494 This will remove each of your commits from mywork, temporarily saving
2495 them as patches (in a directory named ".git/rebase-apply"), update mywork to
2496 point at the latest version of origin, then apply each of the saved
2497 patches to the new mywork.  The result will look like:
2500 ................................................
2501  o--o--O--o--o--o <-- origin
2502                  \
2503                   a'--b'--c' <-- mywork
2504 ................................................
2506 In the process, it may discover conflicts.  In that case it will stop
2507 and allow you to fix the conflicts; after fixing conflicts, use `git add`
2508 to update the index with those contents, and then, instead of
2509 running `git commit`, just run
2511 -------------------------------------------------
2512 $ git rebase --continue
2513 -------------------------------------------------
2515 and git will continue applying the rest of the patches.
2517 At any point you may use the `--abort` option to abort this process and
2518 return mywork to the state it had before you started the rebase:
2520 -------------------------------------------------
2521 $ git rebase --abort
2522 -------------------------------------------------
2524 [[rewriting-one-commit]]
2525 Rewriting a single commit
2526 -------------------------
2528 We saw in <<fixing-a-mistake-by-rewriting-history>> that you can replace the
2529 most recent commit using
2531 -------------------------------------------------
2532 $ git commit --amend
2533 -------------------------------------------------
2535 which will replace the old commit by a new commit incorporating your
2536 changes, giving you a chance to edit the old commit message first.
2538 You can also use a combination of this and linkgit:git-rebase[1] to
2539 replace a commit further back in your history and recreate the
2540 intervening changes on top of it.  First, tag the problematic commit
2541 with
2543 -------------------------------------------------
2544 $ git tag bad mywork~5
2545 -------------------------------------------------
2547 (Either gitk or `git log` may be useful for finding the commit.)
2549 Then check out that commit, edit it, and rebase the rest of the series
2550 on top of it (note that we could check out the commit on a temporary
2551 branch, but instead we're using a <<detached-head,detached head>>):
2553 -------------------------------------------------
2554 $ git checkout bad
2555 $ # make changes here and update the index
2556 $ git commit --amend
2557 $ git rebase --onto HEAD bad mywork
2558 -------------------------------------------------
2560 When you're done, you'll be left with mywork checked out, with the top
2561 patches on mywork reapplied on top of your modified commit.  You can
2562 then clean up with
2564 -------------------------------------------------
2565 $ git tag -d bad
2566 -------------------------------------------------
2568 Note that the immutable nature of git history means that you haven't really
2569 "modified" existing commits; instead, you have replaced the old commits with
2570 new commits having new object names.
2572 [[reordering-patch-series]]
2573 Reordering or selecting from a patch series
2574 -------------------------------------------
2576 Given one existing commit, the linkgit:git-cherry-pick[1] command
2577 allows you to apply the change introduced by that commit and create a
2578 new commit that records it.  So, for example, if "mywork" points to a
2579 series of patches on top of "origin", you might do something like:
2581 -------------------------------------------------
2582 $ git checkout -b mywork-new origin
2583 $ gitk origin..mywork &
2584 -------------------------------------------------
2586 and browse through the list of patches in the mywork branch using gitk,
2587 applying them (possibly in a different order) to mywork-new using
2588 cherry-pick, and possibly modifying them as you go using `git commit --amend`.
2589 The linkgit:git-gui[1] command may also help as it allows you to
2590 individually select diff hunks for inclusion in the index (by
2591 right-clicking on the diff hunk and choosing "Stage Hunk for Commit").
2593 Another technique is to use `git format-patch` to create a series of
2594 patches, then reset the state to before the patches:
2596 -------------------------------------------------
2597 $ git format-patch origin
2598 $ git reset --hard origin
2599 -------------------------------------------------
2601 Then modify, reorder, or eliminate patches as preferred before applying
2602 them again with linkgit:git-am[1].
2604 [[patch-series-tools]]
2605 Other tools
2606 -----------
2608 There are numerous other tools, such as StGit, which exist for the
2609 purpose of maintaining a patch series.  These are outside of the scope of
2610 this manual.
2612 [[problems-With-rewriting-history]]
2613 Problems with rewriting history
2614 -------------------------------
2616 The primary problem with rewriting the history of a branch has to do
2617 with merging.  Suppose somebody fetches your branch and merges it into
2618 their branch, with a result something like this:
2620 ................................................
2621  o--o--O--o--o--o <-- origin
2622         \        \
2623          t--t--t--m <-- their branch:
2624 ................................................
2626 Then suppose you modify the last three commits:
2628 ................................................
2629          o--o--o <-- new head of origin
2630         /
2631  o--o--O--o--o--o <-- old head of origin
2632 ................................................
2634 If we examined all this history together in one repository, it will
2635 look like:
2637 ................................................
2638          o--o--o <-- new head of origin
2639         /
2640  o--o--O--o--o--o <-- old head of origin
2641         \        \
2642          t--t--t--m <-- their branch:
2643 ................................................
2645 Git has no way of knowing that the new head is an updated version of
2646 the old head; it treats this situation exactly the same as it would if
2647 two developers had independently done the work on the old and new heads
2648 in parallel.  At this point, if someone attempts to merge the new head
2649 in to their branch, git will attempt to merge together the two (old and
2650 new) lines of development, instead of trying to replace the old by the
2651 new.  The results are likely to be unexpected.
2653 You may still choose to publish branches whose history is rewritten,
2654 and it may be useful for others to be able to fetch those branches in
2655 order to examine or test them, but they should not attempt to pull such
2656 branches into their own work.
2658 For true distributed development that supports proper merging,
2659 published branches should never be rewritten.
2661 [[bisect-merges]]
2662 Why bisecting merge commits can be harder than bisecting linear history
2663 -----------------------------------------------------------------------
2665 The linkgit:git-bisect[1] command correctly handles history that
2666 includes merge commits.  However, when the commit that it finds is a
2667 merge commit, the user may need to work harder than usual to figure out
2668 why that commit introduced a problem.
2670 Imagine this history:
2672 ................................................
2673       ---Z---o---X---...---o---A---C---D
2674           \                       /
2675            o---o---Y---...---o---B
2676 ................................................
2678 Suppose that on the upper line of development, the meaning of one
2679 of the functions that exists at Z is changed at commit X.  The
2680 commits from Z leading to A change both the function's
2681 implementation and all calling sites that exist at Z, as well
2682 as new calling sites they add, to be consistent.  There is no
2683 bug at A.
2685 Suppose that in the meantime on the lower line of development somebody
2686 adds a new calling site for that function at commit Y.  The
2687 commits from Z leading to B all assume the old semantics of that
2688 function and the callers and the callee are consistent with each
2689 other.  There is no bug at B, either.
2691 Suppose further that the two development lines merge cleanly at C,
2692 so no conflict resolution is required.
2694 Nevertheless, the code at C is broken, because the callers added
2695 on the lower line of development have not been converted to the new
2696 semantics introduced on the upper line of development.  So if all
2697 you know is that D is bad, that Z is good, and that
2698 linkgit:git-bisect[1] identifies C as the culprit, how will you
2699 figure out that the problem is due to this change in semantics?
2701 When the result of a `git bisect` is a non-merge commit, you should
2702 normally be able to discover the problem by examining just that commit.
2703 Developers can make this easy by breaking their changes into small
2704 self-contained commits.  That won't help in the case above, however,
2705 because the problem isn't obvious from examination of any single
2706 commit; instead, a global view of the development is required.  To
2707 make matters worse, the change in semantics in the problematic
2708 function may be just one small part of the changes in the upper
2709 line of development.
2711 On the other hand, if instead of merging at C you had rebased the
2712 history between Z to B on top of A, you would have gotten this
2713 linear history:
2715 ................................................................
2716     ---Z---o---X--...---o---A---o---o---Y*--...---o---B*--D*
2717 ................................................................
2719 Bisecting between Z and D* would hit a single culprit commit Y*,
2720 and understanding why Y* was broken would probably be easier.
2722 Partly for this reason, many experienced git users, even when
2723 working on an otherwise merge-heavy project, keep the history
2724 linear by rebasing against the latest upstream version before
2725 publishing.
2727 [[advanced-branch-management]]
2728 Advanced branch management
2729 ==========================
2731 [[fetching-individual-branches]]
2732 Fetching individual branches
2733 ----------------------------
2735 Instead of using linkgit:git-remote[1], you can also choose just
2736 to update one branch at a time, and to store it locally under an
2737 arbitrary name:
2739 -------------------------------------------------
2740 $ git fetch origin todo:my-todo-work
2741 -------------------------------------------------
2743 The first argument, "origin", just tells git to fetch from the
2744 repository you originally cloned from.  The second argument tells git
2745 to fetch the branch named "todo" from the remote repository, and to
2746 store it locally under the name refs/heads/my-todo-work.
2748 You can also fetch branches from other repositories; so
2750 -------------------------------------------------
2751 $ git fetch git:// master:example-master
2752 -------------------------------------------------
2754 will create a new branch named "example-master" and store in it the
2755 branch named "master" from the repository at the given URL.  If you
2756 already have a branch named example-master, it will attempt to
2757 <<fast-forwards,fast-forward>> to the commit given by's
2758 master branch.  In more detail:
2760 [[fetch-fast-forwards]]
2761 git fetch and fast-forwards
2762 ---------------------------
2764 In the previous example, when updating an existing branch, "git fetch"
2765 checks to make sure that the most recent commit on the remote
2766 branch is a descendant of the most recent commit on your copy of the
2767 branch before updating your copy of the branch to point at the new
2768 commit.  Git calls this process a <<fast-forwards,fast-forward>>.
2770 A fast-forward looks something like this:
2772 ................................................
2773  o--o--o--o <-- old head of the branch
2774            \
2775             o--o--o <-- new head of the branch
2776 ................................................
2779 In some cases it is possible that the new head will *not* actually be
2780 a descendant of the old head.  For example, the developer may have
2781 realized she made a serious mistake, and decided to backtrack,
2782 resulting in a situation like:
2784 ................................................
2785  o--o--o--o--a--b <-- old head of the branch
2786            \
2787             o--o--o <-- new head of the branch
2788 ................................................
2790 In this case, "git fetch" will fail, and print out a warning.
2792 In that case, you can still force git to update to the new head, as
2793 described in the following section.  However, note that in the
2794 situation above this may mean losing the commits labeled "a" and "b",
2795 unless you've already created a reference of your own pointing to
2796 them.
2798 [[forcing-fetch]]
2799 Forcing git fetch to do non-fast-forward updates
2800 ------------------------------------------------
2802 If git fetch fails because the new head of a branch is not a
2803 descendant of the old head, you may force the update with:
2805 -------------------------------------------------
2806 $ git fetch git:// +master:refs/remotes/example/master
2807 -------------------------------------------------
2809 Note the addition of the "+" sign.  Alternatively, you can use the "-f"
2810 flag to force updates of all the fetched branches, as in:
2812 -------------------------------------------------
2813 $ git fetch -f origin
2814 -------------------------------------------------
2816 Be aware that commits that the old version of example/master pointed at
2817 may be lost, as we saw in the previous section.
2819 [[remote-branch-configuration]]
2820 Configuring remote-tracking branches
2821 ------------------------------------
2823 We saw above that "origin" is just a shortcut to refer to the
2824 repository that you originally cloned from.  This information is
2825 stored in git configuration variables, which you can see using
2826 linkgit:git-config[1]:
2828 -------------------------------------------------
2829 $ git config -l
2830 core.repositoryformatversion=0
2831 core.filemode=true
2832 core.logallrefupdates=true
2833 remote.origin.url=git://
2834 remote.origin.fetch=+refs/heads/*:refs/remotes/origin/*
2835 branch.master.remote=origin
2836 branch.master.merge=refs/heads/master
2837 -------------------------------------------------
2839 If there are other repositories that you also use frequently, you can
2840 create similar configuration options to save typing; for example,
2841 after
2843 -------------------------------------------------
2844 $ git config remote.example.url git://
2845 -------------------------------------------------
2847 then the following two commands will do the same thing:
2849 -------------------------------------------------
2850 $ git fetch git:// master:refs/remotes/example/master
2851 $ git fetch example master:refs/remotes/example/master
2852 -------------------------------------------------
2854 Even better, if you add one more option:
2856 -------------------------------------------------
2857 $ git config remote.example.fetch master:refs/remotes/example/master
2858 -------------------------------------------------
2860 then the following commands will all do the same thing:
2862 -------------------------------------------------
2863 $ git fetch git:// master:refs/remotes/example/master
2864 $ git fetch example master:refs/remotes/example/master
2865 $ git fetch example
2866 -------------------------------------------------
2868 You can also add a "+" to force the update each time:
2870 -------------------------------------------------
2871 $ git config remote.example.fetch +master:ref/remotes/example/master
2872 -------------------------------------------------
2874 Don't do this unless you're sure you won't mind "git fetch" possibly
2875 throwing away commits on 'example/master'.
2877 Also note that all of the above configuration can be performed by
2878 directly editing the file .git/config instead of using
2879 linkgit:git-config[1].
2881 See linkgit:git-config[1] for more details on the configuration
2882 options mentioned above.
2885 [[git-concepts]]
2886 Git concepts
2887 ============
2889 Git is built on a small number of simple but powerful ideas.  While it
2890 is possible to get things done without understanding them, you will find
2891 git much more intuitive if you do.
2893 We start with the most important, the  <<def_object_database,object
2894 database>> and the <<def_index,index>>.
2896 [[the-object-database]]
2897 The Object Database
2898 -------------------
2901 We already saw in <<understanding-commits>> that all commits are stored
2902 under a 40-digit "object name".  In fact, all the information needed to
2903 represent the history of a project is stored in objects with such names.
2904 In each case the name is calculated by taking the SHA-1 hash of the
2905 contents of the object.  The SHA-1 hash is a cryptographic hash function.
2906 What that means to us is that it is impossible to find two different
2907 objects with the same name.  This has a number of advantages; among
2908 others:
2910 - Git can quickly determine whether two objects are identical or not,
2911   just by comparing names.
2912 - Since object names are computed the same way in every repository, the
2913   same content stored in two repositories will always be stored under
2914   the same name.
2915 - Git can detect errors when it reads an object, by checking that the
2916   object's name is still the SHA-1 hash of its contents.
2918 (See <<object-details>> for the details of the object formatting and
2919 SHA-1 calculation.)
2921 There are four different types of objects: "blob", "tree", "commit", and
2922 "tag".
2924 - A <<def_blob_object,"blob" object>> is used to store file data.
2925 - A <<def_tree_object,"tree" object>> ties one or more
2926   "blob" objects into a directory structure. In addition, a tree object
2927   can refer to other tree objects, thus creating a directory hierarchy.
2928 - A <<def_commit_object,"commit" object>> ties such directory hierarchies
2929   together into a <<def_DAG,directed acyclic graph>> of revisions--each
2930   commit contains the object name of exactly one tree designating the
2931   directory hierarchy at the time of the commit. In addition, a commit
2932   refers to "parent" commit objects that describe the history of how we
2933   arrived at that directory hierarchy.
2934 - A <<def_tag_object,"tag" object>> symbolically identifies and can be
2935   used to sign other objects. It contains the object name and type of
2936   another object, a symbolic name (of course!) and, optionally, a
2937   signature.
2939 The object types in some more detail:
2941 [[commit-object]]
2942 Commit Object
2943 ~~~~~~~~~~~~~
2945 The "commit" object links a physical state of a tree with a description
2946 of how we got there and why.  Use the --pretty=raw option to
2947 linkgit:git-show[1] or linkgit:git-log[1] to examine your favorite
2948 commit:
2950 ------------------------------------------------
2951 $ git show -s --pretty=raw 2be7fcb476
2952 commit 2be7fcb4764f2dbcee52635b91fedb1b3dcf7ab4
2953 tree fb3a8bdd0ceddd019615af4d57a53f43d8cee2bf
2954 parent 257a84d9d02e90447b149af58b271c19405edb6a
2955 author Dave Watson <> 1187576872 -0400
2956 committer Junio C Hamano <> 1187591163 -0700
2958     Fix misspelling of 'suppress' in docs
2960     Signed-off-by: Junio C Hamano <>
2961 ------------------------------------------------
2963 As you can see, a commit is defined by:
2965 - a tree: The SHA-1 name of a tree object (as defined below), representing
2966   the contents of a directory at a certain point in time.
2967 - parent(s): The SHA-1 name of some number of commits which represent the
2968   immediately previous step(s) in the history of the project.  The
2969   example above has one parent; merge commits may have more than
2970   one.  A commit with no parents is called a "root" commit, and
2971   represents the initial revision of a project.  Each project must have
2972   at least one root.  A project can also have multiple roots, though
2973   that isn't common (or necessarily a good idea).
2974 - an author: The name of the person responsible for this change, together
2975   with its date.
2976 - a committer: The name of the person who actually created the commit,
2977   with the date it was done.  This may be different from the author, for
2978   example, if the author was someone who wrote a patch and emailed it
2979   to the person who used it to create the commit.
2980 - a comment describing this commit.
2982 Note that a commit does not itself contain any information about what
2983 actually changed; all changes are calculated by comparing the contents
2984 of the tree referred to by this commit with the trees associated with
2985 its parents.  In particular, git does not attempt to record file renames
2986 explicitly, though it can identify cases where the existence of the same
2987 file data at changing paths suggests a rename.  (See, for example, the
2988 -M option to linkgit:git-diff[1]).
2990 A commit is usually created by linkgit:git-commit[1], which creates a
2991 commit whose parent is normally the current HEAD, and whose tree is
2992 taken from the content currently stored in the index.
2994 [[tree-object]]
2995 Tree Object
2996 ~~~~~~~~~~~
2998 The ever-versatile linkgit:git-show[1] command can also be used to
2999 examine tree objects, but linkgit:git-ls-tree[1] will give you more
3000 details:
3002 ------------------------------------------------
3003 $ git ls-tree fb3a8bdd0ce
3004 100644 blob 63c918c667fa005ff12ad89437f2fdc80926e21c    .gitignore
3005 100644 blob 5529b198e8d14decbe4ad99db3f7fb632de0439d    .mailmap
3006 100644 blob 6ff87c4664981e4397625791c8ea3bbb5f2279a3    COPYING
3007 040000 tree 2fb783e477100ce076f6bf57e4a6f026013dc745    Documentation
3008 100755 blob 3c0032cec592a765692234f1cba47dfdcc3a9200    GIT-VERSION-GEN
3009 100644 blob 289b046a443c0647624607d471289b2c7dcd470b    INSTALL
3010 100644 blob 4eb463797adc693dc168b926b6932ff53f17d0b1    Makefile
3011 100644 blob 548142c327a6790ff8821d67c2ee1eff7a656b52    README
3013 ------------------------------------------------
3015 As you can see, a tree object contains a list of entries, each with a
3016 mode, object type, SHA-1 name, and name, sorted by name.  It represents
3017 the contents of a single directory tree.
3019 The object type may be a blob, representing the contents of a file, or
3020 another tree, representing the contents of a subdirectory.  Since trees
3021 and blobs, like all other objects, are named by the SHA-1 hash of their
3022 contents, two trees have the same SHA-1 name if and only if their
3023 contents (including, recursively, the contents of all subdirectories)
3024 are identical.  This allows git to quickly determine the differences
3025 between two related tree objects, since it can ignore any entries with
3026 identical object names.
3028 (Note: in the presence of submodules, trees may also have commits as
3029 entries.  See <<submodules>> for documentation.)
3031 Note that the files all have mode 644 or 755: git actually only pays
3032 attention to the executable bit.
3034 [[blob-object]]
3035 Blob Object
3036 ~~~~~~~~~~~
3038 You can use linkgit:git-show[1] to examine the contents of a blob; take,
3039 for example, the blob in the entry for "COPYING" from the tree above:
3041 ------------------------------------------------
3042 $ git show 6ff87c4664
3044  Note that the only valid version of the GPL as far as this project
3045  is concerned is _this_ particular version of the license (ie v2, not
3046  v2.2 or v3.x or whatever), unless explicitly otherwise stated.
3048 ------------------------------------------------
3050 A "blob" object is nothing but a binary blob of data.  It doesn't refer
3051 to anything else or have attributes of any kind.
3053 Since the blob is entirely defined by its data, if two files in a
3054 directory tree (or in multiple different versions of the repository)
3055 have the same contents, they will share the same blob object. The object
3056 is totally independent of its location in the directory tree, and
3057 renaming a file does not change the object that file is associated with.
3059 Note that any tree or blob object can be examined using
3060 linkgit:git-show[1] with the <revision>:<path> syntax.  This can
3061 sometimes be useful for browsing the contents of a tree that is not
3062 currently checked out.
3064 [[trust]]
3065 Trust
3066 ~~~~~
3068 If you receive the SHA-1 name of a blob from one source, and its contents
3069 from another (possibly untrusted) source, you can still trust that those
3070 contents are correct as long as the SHA-1 name agrees.  This is because
3071 the SHA-1 is designed so that it is infeasible to find different contents
3072 that produce the same hash.
3074 Similarly, you need only trust the SHA-1 name of a top-level tree object
3075 to trust the contents of the entire directory that it refers to, and if
3076 you receive the SHA-1 name of a commit from a trusted source, then you
3077 can easily verify the entire history of commits reachable through
3078 parents of that commit, and all of those contents of the trees referred
3079 to by those commits.
3081 So to introduce some real trust in the system, the only thing you need
3082 to do is to digitally sign just 'one' special note, which includes the
3083 name of a top-level commit.  Your digital signature shows others
3084 that you trust that commit, and the immutability of the history of
3085 commits tells others that they can trust the whole history.
3087 In other words, you can easily validate a whole archive by just
3088 sending out a single email that tells the people the name (SHA-1 hash)
3089 of the top commit, and digitally sign that email using something
3090 like GPG/PGP.
3092 To assist in this, git also provides the tag object...
3094 [[tag-object]]
3095 Tag Object
3096 ~~~~~~~~~~
3098 A tag object contains an object, object type, tag name, the name of the
3099 person ("tagger") who created the tag, and a message, which may contain
3100 a signature, as can be seen using linkgit:git-cat-file[1]:
3102 ------------------------------------------------
3103 $ git cat-file tag v1.5.0
3104 object 437b1b20df4b356c9342dac8d38849f24ef44f27
3105 type commit
3106 tag v1.5.0
3107 tagger Junio C Hamano <> 1171411200 +0000
3109 GIT 1.5.0
3110 -----BEGIN PGP SIGNATURE-----
3111 Version: GnuPG v1.4.6 (GNU/Linux)
3113 iD8DBQBF0lGqwMbZpPMRm5oRAuRiAJ9ohBLd7s2kqjkKlq1qqC57SbnmzQCdG4ui
3114 nLE/L9aUXdWeTFPron96DLA=
3115 =2E+0
3116 -----END PGP SIGNATURE-----
3117 ------------------------------------------------
3119 See the linkgit:git-tag[1] command to learn how to create and verify tag
3120 objects.  (Note that linkgit:git-tag[1] can also be used to create
3121 "lightweight tags", which are not tag objects at all, but just simple
3122 references whose names begin with "refs/tags/").
3124 [[pack-files]]
3125 How git stores objects efficiently: pack files
3126 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3128 Newly created objects are initially created in a file named after the
3129 object's SHA-1 hash (stored in .git/objects).
3131 Unfortunately this system becomes inefficient once a project has a
3132 lot of objects.  Try this on an old project:
3134 ------------------------------------------------
3135 $ git count-objects
3136 6930 objects, 47620 kilobytes
3137 ------------------------------------------------
3139 The first number is the number of objects which are kept in
3140 individual files.  The second is the amount of space taken up by
3141 those "loose" objects.
3143 You can save space and make git faster by moving these loose objects in
3144 to a "pack file", which stores a group of objects in an efficient
3145 compressed format; the details of how pack files are formatted can be
3146 found in link:technical/pack-format.txt[technical/pack-format.txt].
3148 To put the loose objects into a pack, just run git repack:
3150 ------------------------------------------------
3151 $ git repack
3152 Generating pack...
3153 Done counting 6020 objects.
3154 Deltifying 6020 objects.
3155  100% (6020/6020) done
3156 Writing 6020 objects.
3157  100% (6020/6020) done
3158 Total 6020, written 6020 (delta 4070), reused 0 (delta 0)
3159 Pack pack-3e54ad29d5b2e05838c75df582c65257b8d08e1c created.
3160 ------------------------------------------------
3162 You can then run
3164 ------------------------------------------------
3165 $ git prune
3166 ------------------------------------------------
3168 to remove any of the "loose" objects that are now contained in the
3169 pack.  This will also remove any unreferenced objects (which may be
3170 created when, for example, you use "git reset" to remove a commit).
3171 You can verify that the loose objects are gone by looking at the
3172 .git/objects directory or by running
3174 ------------------------------------------------
3175 $ git count-objects
3176 0 objects, 0 kilobytes
3177 ------------------------------------------------
3179 Although the object files are gone, any commands that refer to those
3180 objects will work exactly as they did before.
3182 The linkgit:git-gc[1] command performs packing, pruning, and more for
3183 you, so is normally the only high-level command you need.
3185 [[dangling-objects]]
3186 Dangling objects
3187 ~~~~~~~~~~~~~~~~
3189 The linkgit:git-fsck[1] command will sometimes complain about dangling
3190 objects.  They are not a problem.
3192 The most common cause of dangling objects is that you've rebased a
3193 branch, or you have pulled from somebody else who rebased a branch--see
3194 <<cleaning-up-history>>.  In that case, the old head of the original
3195 branch still exists, as does everything it pointed to. The branch
3196 pointer itself just doesn't, since you replaced it with another one.
3198 There are also other situations that cause dangling objects. For
3199 example, a "dangling blob" may arise because you did a "git add" of a
3200 file, but then, before you actually committed it and made it part of the
3201 bigger picture, you changed something else in that file and committed
3202 that *updated* thing--the old state that you added originally ends up
3203 not being pointed to by any commit or tree, so it's now a dangling blob
3204 object.
3206 Similarly, when the "recursive" merge strategy runs, and finds that
3207 there are criss-cross merges and thus more than one merge base (which is
3208 fairly unusual, but it does happen), it will generate one temporary
3209 midway tree (or possibly even more, if you had lots of criss-crossing
3210 merges and more than two merge bases) as a temporary internal merge
3211 base, and again, those are real objects, but the end result will not end
3212 up pointing to them, so they end up "dangling" in your repository.
3214 Generally, dangling objects aren't anything to worry about. They can
3215 even be very useful: if you screw something up, the dangling objects can
3216 be how you recover your old tree (say, you did a rebase, and realized
3217 that you really didn't want to--you can look at what dangling objects
3218 you have, and decide to reset your head to some old dangling state).
3220 For commits, you can just use:
3222 ------------------------------------------------
3223 $ gitk <dangling-commit-sha-goes-here> --not --all
3224 ------------------------------------------------
3226 This asks for all the history reachable from the given commit but not
3227 from any branch, tag, or other reference.  If you decide it's something
3228 you want, you can always create a new reference to it, e.g.,
3230 ------------------------------------------------
3231 $ git branch recovered-branch <dangling-commit-sha-goes-here>
3232 ------------------------------------------------
3234 For blobs and trees, you can't do the same, but you can still examine
3235 them.  You can just do
3237 ------------------------------------------------
3238 $ git show <dangling-blob/tree-sha-goes-here>
3239 ------------------------------------------------
3241 to show what the contents of the blob were (or, for a tree, basically
3242 what the "ls" for that directory was), and that may give you some idea
3243 of what the operation was that left that dangling object.
3245 Usually, dangling blobs and trees aren't very interesting. They're
3246 almost always the result of either being a half-way mergebase (the blob
3247 will often even have the conflict markers from a merge in it, if you
3248 have had conflicting merges that you fixed up by hand), or simply
3249 because you interrupted a "git fetch" with ^C or something like that,
3250 leaving _some_ of the new objects in the object database, but just
3251 dangling and useless.
3253 Anyway, once you are sure that you're not interested in any dangling
3254 state, you can just prune all unreachable objects:
3256 ------------------------------------------------
3257 $ git prune
3258 ------------------------------------------------
3260 and they'll be gone. But you should only run "git prune" on a quiescent
3261 repository--it's kind of like doing a filesystem fsck recovery: you
3262 don't want to do that while the filesystem is mounted.
3264 (The same is true of "git fsck" itself, btw, but since
3265 `git fsck` never actually *changes* the repository, it just reports
3266 on what it found, `git fsck` itself is never 'dangerous' to run.
3267 Running it while somebody is actually changing the repository can cause
3268 confusing and scary messages, but it won't actually do anything bad. In
3269 contrast, running "git prune" while somebody is actively changing the
3270 repository is a *BAD* idea).
3272 [[recovering-from-repository-corruption]]
3273 Recovering from repository corruption
3274 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3276 By design, git treats data trusted to it with caution.  However, even in
3277 the absence of bugs in git itself, it is still possible that hardware or
3278 operating system errors could corrupt data.
3280 The first defense against such problems is backups.  You can back up a
3281 git directory using clone, or just using cp, tar, or any other backup
3282 mechanism.
3284 As a last resort, you can search for the corrupted objects and attempt
3285 to replace them by hand.  Back up your repository before attempting this
3286 in case you corrupt things even more in the process.
3288 We'll assume that the problem is a single missing or corrupted blob,
3289 which is sometimes a solvable problem.  (Recovering missing trees and
3290 especially commits is *much* harder).
3292 Before starting, verify that there is corruption, and figure out where
3293 it is with linkgit:git-fsck[1]; this may be time-consuming.
3295 Assume the output looks like this:
3297 ------------------------------------------------
3298 $ git fsck --full
3299 broken link from    tree 2d9263c6d23595e7cb2a21e5ebbb53655278dff8
3300               to    blob 4b9458b3786228369c63936db65827de3cc06200
3301 missing blob 4b9458b3786228369c63936db65827de3cc06200
3302 ------------------------------------------------
3304 (Typically there will be some "dangling object" messages too, but they
3305 aren't interesting.)
3307 Now you know that blob 4b9458b3 is missing, and that the tree 2d9263c6
3308 points to it.  If you could find just one copy of that missing blob
3309 object, possibly in some other repository, you could move it into
3310 .git/objects/4b/9458b3... and be done.  Suppose you can't.  You can
3311 still examine the tree that pointed to it with linkgit:git-ls-tree[1],
3312 which might output something like:
3314 ------------------------------------------------
3315 $ git ls-tree 2d9263c6d23595e7cb2a21e5ebbb53655278dff8
3316 100644 blob 8d14531846b95bfa3564b58ccfb7913a034323b8    .gitignore
3317 100644 blob ebf9bf84da0aab5ed944264a5db2a65fe3a3e883    .mailmap
3318 100644 blob ca442d313d86dc67e0a2e5d584b465bd382cbf5c    COPYING
3320 100644 blob 4b9458b3786228369c63936db65827de3cc06200    myfile
3322 ------------------------------------------------
3324 So now you know that the missing blob was the data for a file named
3325 "myfile".  And chances are you can also identify the directory--let's
3326 say it's in "somedirectory".  If you're lucky the missing copy might be
3327 the same as the copy you have checked out in your working tree at
3328 "somedirectory/myfile"; you can test whether that's right with
3329 linkgit:git-hash-object[1]:
3331 ------------------------------------------------
3332 $ git hash-object -w somedirectory/myfile
3333 ------------------------------------------------
3335 which will create and store a blob object with the contents of
3336 somedirectory/myfile, and output the SHA-1 of that object.  if you're
3337 extremely lucky it might be 4b9458b3786228369c63936db65827de3cc06200, in
3338 which case you've guessed right, and the corruption is fixed!
3340 Otherwise, you need more information.  How do you tell which version of
3341 the file has been lost?
3343 The easiest way to do this is with:
3345 ------------------------------------------------
3346 $ git log --raw --all --full-history -- somedirectory/myfile
3347 ------------------------------------------------
3349 Because you're asking for raw output, you'll now get something like
3351 ------------------------------------------------
3352 commit abc
3353 Author:
3354 Date:
3356 :100644 100644 4b9458b... newsha... M somedirectory/myfile
3359 commit xyz
3360 Author:
3361 Date:
3364 :100644 100644 oldsha... 4b9458b... M somedirectory/myfile
3365 ------------------------------------------------
3367 This tells you that the immediately preceding version of the file was
3368 "newsha", and that the immediately following version was "oldsha".
3369 You also know the commit messages that went with the change from oldsha
3370 to 4b9458b and with the change from 4b9458b to newsha.
3372 If you've been committing small enough changes, you may now have a good
3373 shot at reconstructing the contents of the in-between state 4b9458b.
3375 If you can do that, you can now recreate the missing object with
3377 ------------------------------------------------
3378 $ git hash-object -w <recreated-file>
3379 ------------------------------------------------
3381 and your repository is good again!
3383 (Btw, you could have ignored the fsck, and started with doing a
3385 ------------------------------------------------
3386 $ git log --raw --all
3387 ------------------------------------------------
3389 and just looked for the sha of the missing object (4b9458b..) in that
3390 whole thing. It's up to you - git does *have* a lot of information, it is
3391 just missing one particular blob version.
3393 [[the-index]]
3394 The index
3395 -----------
3397 The index is a binary file (generally kept in .git/index) containing a
3398 sorted list of path names, each with permissions and the SHA-1 of a blob
3399 object; linkgit:git-ls-files[1] can show you the contents of the index:
3401 -------------------------------------------------
3402 $ git ls-files --stage
3403 100644 63c918c667fa005ff12ad89437f2fdc80926e21c 0       .gitignore
3404 100644 5529b198e8d14decbe4ad99db3f7fb632de0439d 0       .mailmap
3405 100644 6ff87c4664981e4397625791c8ea3bbb5f2279a3 0       COPYING
3406 100644 a37b2152bd26be2c2289e1f57a292534a51a93c7 0       Documentation/.gitignore
3407 100644 fbefe9a45b00a54b58d94d06eca48b03d40a50e0 0       Documentation/Makefile
3409 100644 2511aef8d89ab52be5ec6a5e46236b4b6bcd07ea 0       xdiff/xtypes.h
3410 100644 2ade97b2574a9f77e7ae4002a4e07a6a38e46d07 0       xdiff/xutils.c
3411 100644 d5de8292e05e7c36c4b68857c1cf9855e3d2f70a 0       xdiff/xutils.h
3412 -------------------------------------------------
3414 Note that in older documentation you may see the index called the
3415 "current directory cache" or just the "cache".  It has three important
3416 properties:
3418 1. The index contains all the information necessary to generate a single
3419 (uniquely determined) tree object.
3421 For example, running linkgit:git-commit[1] generates this tree object
3422 from the index, stores it in the object database, and uses it as the
3423 tree object associated with the new commit.
3425 2. The index enables fast comparisons between the tree object it defines
3426 and the working tree.
3428 It does this by storing some additional data for each entry (such as
3429 the last modified time).  This data is not displayed above, and is not
3430 stored in the created tree object, but it can be used to determine
3431 quickly which files in the working directory differ from what was
3432 stored in the index, and thus save git from having to read all of the
3433 data from such files to look for changes.
3435 3. It can efficiently represent information about merge conflicts
3436 between different tree objects, allowing each pathname to be
3437 associated with sufficient information about the trees involved that
3438 you can create a three-way merge between them.
3440 We saw in <<conflict-resolution>> that during a merge the index can
3441 store multiple versions of a single file (called "stages").  The third
3442 column in the linkgit:git-ls-files[1] output above is the stage
3443 number, and will take on values other than 0 for files with merge
3444 conflicts.
3446 The index is thus a sort of temporary staging area, which is filled with
3447 a tree which you are in the process of working on.
3449 If you blow the index away entirely, you generally haven't lost any
3450 information as long as you have the name of the tree that it described.
3452 [[submodules]]
3453 Submodules
3454 ==========
3456 Large projects are often composed of smaller, self-contained modules.  For
3457 example, an embedded Linux distribution's source tree would include every
3458 piece of software in the distribution with some local modifications; a movie
3459 player might need to build against a specific, known-working version of a
3460 decompression library; several independent programs might all share the same
3461 build scripts.
3463 With centralized revision control systems this is often accomplished by
3464 including every module in one single repository.  Developers can check out
3465 all modules or only the modules they need to work with.  They can even modify
3466 files across several modules in a single commit while moving things around
3467 or updating APIs and translations.
3469 Git does not allow partial checkouts, so duplicating this approach in Git
3470 would force developers to keep a local copy of modules they are not
3471 interested in touching.  Commits in an enormous checkout would be slower
3472 than you'd expect as Git would have to scan every directory for changes.
3473 If modules have a lot of local history, clones would take forever.
3475 On the plus side, distributed revision control systems can much better
3476 integrate with external sources.  In a centralized model, a single arbitrary
3477 snapshot of the external project is exported from its own revision control
3478 and then imported into the local revision control on a vendor branch.  All
3479 the history is hidden.  With distributed revision control you can clone the
3480 entire external history and much more easily follow development and re-merge
3481 local changes.
3483 Git's submodule support allows a repository to contain, as a subdirectory, a
3484 checkout of an external project.  Submodules maintain their own identity;
3485 the submodule support just stores the submodule repository location and
3486 commit ID, so other developers who clone the containing project
3487 ("superproject") can easily clone all the submodules at the same revision.
3488 Partial checkouts of the superproject are possible: you can tell Git to
3489 clone none, some or all of the submodules.
3491 The linkgit:git-submodule[1] command is available since Git 1.5.3.  Users
3492 with Git 1.5.2 can look up the submodule commits in the repository and
3493 manually check them out; earlier versions won't recognize the submodules at
3494 all.
3496 To see how submodule support works, create (for example) four example
3497 repositories that can be used later as a submodule:
3499 -------------------------------------------------
3500 $ mkdir ~/git
3501 $ cd ~/git
3502 $ for i in a b c d
3504         mkdir $i
3505         cd $i
3506         git init
3507         echo "module $i" > $i.txt
3508         git add $i.txt
3509         git commit -m "Initial commit, submodule $i"
3510         cd ..
3511 done
3512 -------------------------------------------------
3514 Now create the superproject and add all the submodules:
3516 -------------------------------------------------
3517 $ mkdir super
3518 $ cd super
3519 $ git init
3520 $ for i in a b c d
3522         git submodule add ~/git/$i $i
3523 done
3524 -------------------------------------------------
3526 NOTE: Do not use local URLs here if you plan to publish your superproject!
3528 See what files `git submodule` created:
3530 -------------------------------------------------
3531 $ ls -a
3532 .  ..  .git  .gitmodules  a  b  c  d
3533 -------------------------------------------------
3535 The `git submodule add <repo> <path>` command does a couple of things:
3537 - It clones the submodule from <repo> to the given <path> under the
3538   current directory and by default checks out the master branch.
3539 - It adds the submodule's clone path to the linkgit:gitmodules[5] file and
3540   adds this file to the index, ready to be committed.
3541 - It adds the submodule's current commit ID to the index, ready to be
3542   committed.
3544 Commit the superproject:
3546 -------------------------------------------------
3547 $ git commit -m "Add submodules a, b, c and d."
3548 -------------------------------------------------
3550 Now clone the superproject:
3552 -------------------------------------------------
3553 $ cd ..
3554 $ git clone super cloned
3555 $ cd cloned
3556 -------------------------------------------------
3558 The submodule directories are there, but they're empty:
3560 -------------------------------------------------
3561 $ ls -a a
3562 .  ..
3563 $ git submodule status
3564 -d266b9873ad50488163457f025db7cdd9683d88b a
3565 -e81d457da15309b4fef4249aba9b50187999670d b
3566 -c1536a972b9affea0f16e0680ba87332dc059146 c
3567 -d96249ff5d57de5de093e6baff9e0aafa5276a74 d
3568 -------------------------------------------------
3570 NOTE: The commit object names shown above would be different for you, but they
3571 should match the HEAD commit object names of your repositories.  You can check
3572 it by running `git ls-remote ../a`.
3574 Pulling down the submodules is a two-step process. First run `git submodule
3575 init` to add the submodule repository URLs to `.git/config`:
3577 -------------------------------------------------
3578 $ git submodule init
3579 -------------------------------------------------
3581 Now use `git submodule update` to clone the repositories and check out the
3582 commits specified in the superproject:
3584 -------------------------------------------------
3585 $ git submodule update
3586 $ cd a
3587 $ ls -a
3588 .  ..  .git  a.txt
3589 -------------------------------------------------
3591 One major difference between `git submodule update` and `git submodule add` is
3592 that `git submodule update` checks out a specific commit, rather than the tip
3593 of a branch. It's like checking out a tag: the head is detached, so you're not
3594 working on a branch.
3596 -------------------------------------------------
3597 $ git branch
3598 * (no branch)
3599   master
3600 -------------------------------------------------
3602 If you want to make a change within a submodule and you have a detached head,
3603 then you should create or checkout a branch, make your changes, publish the
3604 change within the submodule, and then update the superproject to reference the
3605 new commit:
3607 -------------------------------------------------
3608 $ git checkout master
3609 -------------------------------------------------
3613 -------------------------------------------------
3614 $ git checkout -b fix-up
3615 -------------------------------------------------
3617 then
3619 -------------------------------------------------
3620 $ echo "adding a line again" >> a.txt
3621 $ git commit -a -m "Updated the submodule from within the superproject."
3622 $ git push
3623 $ cd ..
3624 $ git diff
3625 diff --git a/a b/a
3626 index d266b98..261dfac 160000
3627 --- a/a
3628 +++ b/a
3629 @@ -1 +1 @@
3630 -Subproject commit d266b9873ad50488163457f025db7cdd9683d88b
3631 +Subproject commit 261dfac35cb99d380eb966e102c1197139f7fa24
3632 $ git add a
3633 $ git commit -m "Updated submodule a."
3634 $ git push
3635 -------------------------------------------------
3637 You have to run `git submodule update` after `git pull` if you want to update
3638 submodules, too.
3640 Pitfalls with submodules
3641 ------------------------
3643 Always publish the submodule change before publishing the change to the
3644 superproject that references it. If you forget to publish the submodule change,
3645 others won't be able to clone the repository:
3647 -------------------------------------------------
3648 $ cd ~/git/super/a
3649 $ echo i added another line to this file >> a.txt
3650 $ git commit -a -m "doing it wrong this time"
3651 $ cd ..
3652 $ git add a
3653 $ git commit -m "Updated submodule a again."
3654 $ git push
3655 $ cd ~/git/cloned
3656 $ git pull
3657 $ git submodule update
3658 error: pathspec '261dfac35cb99d380eb966e102c1197139f7fa24' did not match any file(s) known to git.
3659 Did you forget to 'git add'?
3660 Unable to checkout '261dfac35cb99d380eb966e102c1197139f7fa24' in submodule path 'a'
3661 -------------------------------------------------
3663 In older git versions it could be easily forgotten to commit new or modified
3664 files in a submodule, which silently leads to similar problems as not pushing
3665 the submodule changes. Starting with git 1.7.0 both "git status" and "git diff"
3666 in the superproject show submodules as modified when they contain new or
3667 modified files to protect against accidentally committing such a state. "git
3668 diff" will also add a "-dirty" to the work tree side when generating patch
3669 output or used with the --submodule option:
3671 -------------------------------------------------
3672 $ git diff
3673 diff --git a/sub b/sub
3674 --- a/sub
3675 +++ b/sub
3676 @@ -1 +1 @@
3677 -Subproject commit 3f356705649b5d566d97ff843cf193359229a453
3678 +Subproject commit 3f356705649b5d566d97ff843cf193359229a453-dirty
3679 $ git diff --submodule
3680 Submodule sub 3f35670..3f35670-dirty:
3681 -------------------------------------------------
3683 You also should not rewind branches in a submodule beyond commits that were
3684 ever recorded in any superproject.
3686 It's not safe to run `git submodule update` if you've made and committed
3687 changes within a submodule without checking out a branch first. They will be
3688 silently overwritten:
3690 -------------------------------------------------
3691 $ cat a.txt
3692 module a
3693 $ echo line added from private2 >> a.txt
3694 $ git commit -a -m "line added inside private2"
3695 $ cd ..
3696 $ git submodule update
3697 Submodule path 'a': checked out 'd266b9873ad50488163457f025db7cdd9683d88b'
3698 $ cd a
3699 $ cat a.txt
3700 module a
3701 -------------------------------------------------
3703 NOTE: The changes are still visible in the submodule's reflog.
3705 This is not the case if you did not commit your changes.
3707 [[low-level-operations]]
3708 Low-level git operations
3709 ========================
3711 Many of the higher-level commands were originally implemented as shell
3712 scripts using a smaller core of low-level git commands.  These can still
3713 be useful when doing unusual things with git, or just as a way to
3714 understand its inner workings.
3716 [[object-manipulation]]
3717 Object access and manipulation
3718 ------------------------------
3720 The linkgit:git-cat-file[1] command can show the contents of any object,
3721 though the higher-level linkgit:git-show[1] is usually more useful.
3723 The linkgit:git-commit-tree[1] command allows constructing commits with
3724 arbitrary parents and trees.
3726 A tree can be created with linkgit:git-write-tree[1] and its data can be
3727 accessed by linkgit:git-ls-tree[1].  Two trees can be compared with
3728 linkgit:git-diff-tree[1].
3730 A tag is created with linkgit:git-mktag[1], and the signature can be
3731 verified by linkgit:git-verify-tag[1], though it is normally simpler to
3732 use linkgit:git-tag[1] for both.
3734 [[the-workflow]]
3735 The Workflow
3736 ------------
3738 High-level operations such as linkgit:git-commit[1],
3739 linkgit:git-checkout[1] and linkgit:git-reset[1] work by moving data
3740 between the working tree, the index, and the object database.  Git
3741 provides low-level operations which perform each of these steps
3742 individually.
3744 Generally, all "git" operations work on the index file. Some operations
3745 work *purely* on the index file (showing the current state of the
3746 index), but most operations move data between the index file and either
3747 the database or the working directory. Thus there are four main
3748 combinations:
3750 [[working-directory-to-index]]
3751 working directory -> index
3752 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3754 The linkgit:git-update-index[1] command updates the index with
3755 information from the working directory.  You generally update the
3756 index information by just specifying the filename you want to update,
3757 like so:
3759 -------------------------------------------------
3760 $ git update-index filename
3761 -------------------------------------------------
3763 but to avoid common mistakes with filename globbing etc, the command
3764 will not normally add totally new entries or remove old entries,
3765 i.e. it will normally just update existing cache entries.
3767 To tell git that yes, you really do realize that certain files no
3768 longer exist, or that new files should be added, you
3769 should use the `--remove` and `--add` flags respectively.
3771 NOTE! A `--remove` flag does 'not' mean that subsequent filenames will
3772 necessarily be removed: if the files still exist in your directory
3773 structure, the index will be updated with their new status, not
3774 removed. The only thing `--remove` means is that update-index will be
3775 considering a removed file to be a valid thing, and if the file really
3776 does not exist any more, it will update the index accordingly.
3778 As a special case, you can also do `git update-index --refresh`, which
3779 will refresh the "stat" information of each index to match the current
3780 stat information. It will 'not' update the object status itself, and
3781 it will only update the fields that are used to quickly test whether
3782 an object still matches its old backing store object.
3784 The previously introduced linkgit:git-add[1] is just a wrapper for
3785 linkgit:git-update-index[1].
3787 [[index-to-object-database]]
3788 index -> object database
3789 ~~~~~~~~~~~~~~~~~~~~~~~~
3791 You write your current index file to a "tree" object with the program
3793 -------------------------------------------------
3794 $ git write-tree
3795 -------------------------------------------------
3797 that doesn't come with any options--it will just write out the
3798 current index into the set of tree objects that describe that state,
3799 and it will return the name of the resulting top-level tree. You can
3800 use that tree to re-generate the index at any time by going in the
3801 other direction:
3803 [[object-database-to-index]]
3804 object database -> index
3805 ~~~~~~~~~~~~~~~~~~~~~~~~
3807 You read a "tree" file from the object database, and use that to
3808 populate (and overwrite--don't do this if your index contains any
3809 unsaved state that you might want to restore later!) your current
3810 index.  Normal operation is just
3812 -------------------------------------------------
3813 $ git read-tree <SHA-1 of tree>
3814 -------------------------------------------------
3816 and your index file will now be equivalent to the tree that you saved
3817 earlier. However, that is only your 'index' file: your working
3818 directory contents have not been modified.
3820 [[index-to-working-directory]]
3821 index -> working directory
3822 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3824 You update your working directory from the index by "checking out"
3825 files. This is not a very common operation, since normally you'd just
3826 keep your files updated, and rather than write to your working
3827 directory, you'd tell the index files about the changes in your
3828 working directory (i.e. `git update-index`).
3830 However, if you decide to jump to a new version, or check out somebody
3831 else's version, or just restore a previous tree, you'd populate your
3832 index file with read-tree, and then you need to check out the result
3833 with
3835 -------------------------------------------------
3836 $ git checkout-index filename
3837 -------------------------------------------------
3839 or, if you want to check out all of the index, use `-a`.
3841 NOTE! `git checkout-index` normally refuses to overwrite old files, so
3842 if you have an old version of the tree already checked out, you will
3843 need to use the "-f" flag ('before' the "-a" flag or the filename) to
3844 'force' the checkout.
3847 Finally, there are a few odds and ends which are not purely moving
3848 from one representation to the other:
3850 [[tying-it-all-together]]
3851 Tying it all together
3852 ~~~~~~~~~~~~~~~~~~~~~
3854 To commit a tree you have instantiated with "git write-tree", you'd
3855 create a "commit" object that refers to that tree and the history
3856 behind it--most notably the "parent" commits that preceded it in
3857 history.
3859 Normally a "commit" has one parent: the previous state of the tree
3860 before a certain change was made. However, sometimes it can have two
3861 or more parent commits, in which case we call it a "merge", due to the
3862 fact that such a commit brings together ("merges") two or more
3863 previous states represented by other commits.
3865 In other words, while a "tree" represents a particular directory state
3866 of a working directory, a "commit" represents that state in "time",
3867 and explains how we got there.
3869 You create a commit object by giving it the tree that describes the
3870 state at the time of the commit, and a list of parents:
3872 -------------------------------------------------
3873 $ git commit-tree <tree> -p <parent> [(-p <parent2>)...]
3874 -------------------------------------------------
3876 and then giving the reason for the commit on stdin (either through
3877 redirection from a pipe or file, or by just typing it at the tty).
3879 `git commit-tree` will return the name of the object that represents
3880 that commit, and you should save it away for later use. Normally,
3881 you'd commit a new `HEAD` state, and while git doesn't care where you
3882 save the note about that state, in practice we tend to just write the
3883 result to the file pointed at by `.git/HEAD`, so that we can always see
3884 what the last committed state was.
3886 Here is an ASCII art by Jon Loeliger that illustrates how
3887 various pieces fit together.
3889 ------------
3891                      commit-tree
3892                       commit obj
3893                        +----+
3894                        |    |
3895                        |    |
3896                        V    V
3897                     +-----------+
3898                     | Object DB |
3899                     |  Backing  |
3900                     |   Store   |
3901                     +-----------+
3902                        ^
3903            write-tree  |     |
3904              tree obj  |     |
3905                        |     |  read-tree
3906                        |     |  tree obj
3907                              V
3908                     +-----------+
3909                     |   Index   |
3910                     |  "cache"  |
3911                     +-----------+
3912          update-index  ^
3913              blob obj  |     |
3914                        |     |
3915     checkout-index -u  |     |  checkout-index
3916              stat      |     |  blob obj
3917                              V
3918                     +-----------+
3919                     |  Working  |
3920                     | Directory |
3921                     +-----------+
3923 ------------
3926 [[examining-the-data]]
3927 Examining the data
3928 ------------------
3930 You can examine the data represented in the object database and the
3931 index with various helper tools. For every object, you can use
3932 linkgit:git-cat-file[1] to examine details about the
3933 object:
3935 -------------------------------------------------
3936 $ git cat-file -t <objectname>
3937 -------------------------------------------------
3939 shows the type of the object, and once you have the type (which is
3940 usually implicit in where you find the object), you can use
3942 -------------------------------------------------
3943 $ git cat-file blob|tree|commit|tag <objectname>
3944 -------------------------------------------------
3946 to show its contents. NOTE! Trees have binary content, and as a result
3947 there is a special helper for showing that content, called
3948 `git ls-tree`, which turns the binary content into a more easily
3949 readable form.
3951 It's especially instructive to look at "commit" objects, since those
3952 tend to be small and fairly self-explanatory. In particular, if you
3953 follow the convention of having the top commit name in `.git/HEAD`,
3954 you can do
3956 -------------------------------------------------
3957 $ git cat-file commit HEAD
3958 -------------------------------------------------
3960 to see what the top commit was.
3962 [[merging-multiple-trees]]
3963 Merging multiple trees
3964 ----------------------
3966 Git helps you do a three-way merge, which you can expand to n-way by
3967 repeating the merge procedure arbitrary times until you finally
3968 "commit" the state.  The normal situation is that you'd only do one
3969 three-way merge (two parents), and commit it, but if you like to, you
3970 can do multiple parents in one go.
3972 To do a three-way merge, you need the two sets of "commit" objects
3973 that you want to merge, use those to find the closest common parent (a
3974 third "commit" object), and then use those commit objects to find the
3975 state of the directory ("tree" object) at these points.
3977 To get the "base" for the merge, you first look up the common parent
3978 of two commits with
3980 -------------------------------------------------
3981 $ git merge-base <commit1> <commit2>
3982 -------------------------------------------------
3984 which will return you the commit they are both based on.  You should
3985 now look up the "tree" objects of those commits, which you can easily
3986 do with (for example)
3988 -------------------------------------------------
3989 $ git cat-file commit <commitname> | head -1
3990 -------------------------------------------------
3992 since the tree object information is always the first line in a commit
3993 object.
3995 Once you know the three trees you are going to merge (the one "original"
3996 tree, aka the common tree, and the two "result" trees, aka the branches
3997 you want to merge), you do a "merge" read into the index. This will
3998 complain if it has to throw away your old index contents, so you should
3999 make sure that you've committed those--in fact you would normally
4000 always do a merge against your last commit (which should thus match what
4001 you have in your current index anyway).
4003 To do the merge, do
4005 -------------------------------------------------
4006 $ git read-tree -m -u <origtree> <yourtree> <targettree>
4007 -------------------------------------------------
4009 which will do all trivial merge operations for you directly in the
4010 index file, and you can just write the result out with
4011 `git write-tree`.
4014 [[merging-multiple-trees-2]]
4015 Merging multiple trees, continued
4016 ---------------------------------
4018 Sadly, many merges aren't trivial. If there are files that have
4019 been added, moved or removed, or if both branches have modified the
4020 same file, you will be left with an index tree that contains "merge
4021 entries" in it. Such an index tree can 'NOT' be written out to a tree
4022 object, and you will have to resolve any such merge clashes using
4023 other tools before you can write out the result.
4025 You can examine such index state with `git ls-files --unmerged`
4026 command.  An example:
4028 ------------------------------------------------
4029 $ git read-tree -m $orig HEAD $target
4030 $ git ls-files --unmerged
4031 100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1       hello.c
4032 100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2       hello.c
4033 100644 cc44c73eb783565da5831b4d820c962954019b69 3       hello.c
4034 ------------------------------------------------
4036 Each line of the `git ls-files --unmerged` output begins with
4037 the blob mode bits, blob SHA-1, 'stage number', and the
4038 filename.  The 'stage number' is git's way to say which tree it
4039 came from: stage 1 corresponds to `$orig` tree, stage 2 `HEAD`
4040 tree, and stage3 `$target` tree.
4042 Earlier we said that trivial merges are done inside
4043 `git read-tree -m`.  For example, if the file did not change
4044 from `$orig` to `HEAD` nor `$target`, or if the file changed
4045 from `$orig` to `HEAD` and `$orig` to `$target` the same way,
4046 obviously the final outcome is what is in `HEAD`.  What the
4047 above example shows is that file `hello.c` was changed from
4048 `$orig` to `HEAD` and `$orig` to `$target` in a different way.
4049 You could resolve this by running your favorite 3-way merge
4050 program, e.g.  `diff3`, `merge`, or git's own merge-file, on
4051 the blob objects from these three stages yourself, like this:
4053 ------------------------------------------------
4054 $ git cat-file blob 263414f... >hello.c~1
4055 $ git cat-file blob 06fa6a2... >hello.c~2
4056 $ git cat-file blob cc44c73... >hello.c~3
4057 $ git merge-file hello.c~2 hello.c~1 hello.c~3
4058 ------------------------------------------------
4060 This would leave the merge result in `hello.c~2` file, along
4061 with conflict markers if there are conflicts.  After verifying
4062 the merge result makes sense, you can tell git what the final
4063 merge result for this file is by:
4065 -------------------------------------------------
4066 $ mv -f hello.c~2 hello.c
4067 $ git update-index hello.c
4068 -------------------------------------------------
4070 When a path is in the "unmerged" state, running `git update-index` for
4071 that path tells git to mark the path resolved.
4073 The above is the description of a git merge at the lowest level,
4074 to help you understand what conceptually happens under the hood.
4075 In practice, nobody, not even git itself, runs `git cat-file` three times
4076 for this.  There is a `git merge-index` program that extracts the
4077 stages to temporary files and calls a "merge" script on it:
4079 -------------------------------------------------
4080 $ git merge-index git-merge-one-file hello.c
4081 -------------------------------------------------
4083 and that is what higher level `git merge -s resolve` is implemented with.
4085 [[hacking-git]]
4086 Hacking git
4087 ===========
4089 This chapter covers internal details of the git implementation which
4090 probably only git developers need to understand.
4092 [[object-details]]
4093 Object storage format
4094 ---------------------
4096 All objects have a statically determined "type" which identifies the
4097 format of the object (i.e. how it is used, and how it can refer to other
4098 objects).  There are currently four different object types: "blob",
4099 "tree", "commit", and "tag".
4101 Regardless of object type, all objects share the following
4102 characteristics: they are all deflated with zlib, and have a header
4103 that not only specifies their type, but also provides size information
4104 about the data in the object.  It's worth noting that the SHA-1 hash
4105 that is used to name the object is the hash of the original data
4106 plus this header, so `sha1sum` 'file' does not match the object name
4107 for 'file'.
4108 (Historical note: in the dawn of the age of git the hash
4109 was the SHA-1 of the 'compressed' object.)
4111 As a result, the general consistency of an object can always be tested
4112 independently of the contents or the type of the object: all objects can
4113 be validated by verifying that (a) their hashes match the content of the
4114 file and (b) the object successfully inflates to a stream of bytes that
4115 forms a sequence of <ascii type without space> {plus} <space> {plus} <ascii decimal
4116 size> {plus} <byte\0> {plus} <binary object data>.
4118 The structured objects can further have their structure and
4119 connectivity to other objects verified. This is generally done with
4120 the `git fsck` program, which generates a full dependency graph
4121 of all objects, and verifies their internal consistency (in addition
4122 to just verifying their superficial consistency through the hash).
4124 [[birdview-on-the-source-code]]
4125 A birds-eye view of Git's source code
4126 -------------------------------------
4128 It is not always easy for new developers to find their way through Git's
4129 source code.  This section gives you a little guidance to show where to
4130 start.
4132 A good place to start is with the contents of the initial commit, with:
4134 ----------------------------------------------------
4135 $ git checkout e83c5163
4136 ----------------------------------------------------
4138 The initial revision lays the foundation for almost everything git has
4139 today, but is small enough to read in one sitting.
4141 Note that terminology has changed since that revision.  For example, the
4142 README in that revision uses the word "changeset" to describe what we
4143 now call a <<def_commit_object,commit>>.
4145 Also, we do not call it "cache" any more, but rather "index"; however, the
4146 file is still called `cache.h`.  Remark: Not much reason to change it now,
4147 especially since there is no good single name for it anyway, because it is
4148 basically _the_ header file which is included by _all_ of Git's C sources.
4150 If you grasp the ideas in that initial commit, you should check out a
4151 more recent version and skim `cache.h`, `object.h` and `commit.h`.
4153 In the early days, Git (in the tradition of UNIX) was a bunch of programs
4154 which were extremely simple, and which you used in scripts, piping the
4155 output of one into another. This turned out to be good for initial
4156 development, since it was easier to test new things.  However, recently
4157 many of these parts have become builtins, and some of the core has been
4158 "libified", i.e. put into libgit.a for performance, portability reasons,
4159 and to avoid code duplication.
4161 By now, you know what the index is (and find the corresponding data
4162 structures in `cache.h`), and that there are just a couple of object types
4163 (blobs, trees, commits and tags) which inherit their common structure from
4164 `struct object`, which is their first member (and thus, you can cast e.g.
4165 `(struct object *)commit` to achieve the _same_ as `&commit->object`, i.e.
4166 get at the object name and flags).
4168 Now is a good point to take a break to let this information sink in.
4170 Next step: get familiar with the object naming.  Read <<naming-commits>>.
4171 There are quite a few ways to name an object (and not only revisions!).
4172 All of these are handled in `sha1_name.c`. Just have a quick look at
4173 the function `get_sha1()`. A lot of the special handling is done by
4174 functions like `get_sha1_basic()` or the likes.
4176 This is just to get you into the groove for the most libified part of Git:
4177 the revision walker.
4179 Basically, the initial version of `git log` was a shell script:
4181 ----------------------------------------------------------------
4182 $ git-rev-list --pretty $(git-rev-parse --default HEAD "$@") | \
4183         LESS=-S ${PAGER:-less}
4184 ----------------------------------------------------------------
4186 What does this mean?
4188 `git rev-list` is the original version of the revision walker, which
4189 _always_ printed a list of revisions to stdout.  It is still functional,
4190 and needs to, since most new Git commands start out as scripts using
4191 `git rev-list`.
4193 `git rev-parse` is not as important any more; it was only used to filter out
4194 options that were relevant for the different plumbing commands that were
4195 called by the script.
4197 Most of what `git rev-list` did is contained in `revision.c` and
4198 `revision.h`.  It wraps the options in a struct named `rev_info`, which
4199 controls how and what revisions are walked, and more.
4201 The original job of `git rev-parse` is now taken by the function
4202 `setup_revisions()`, which parses the revisions and the common command line
4203 options for the revision walker. This information is stored in the struct
4204 `rev_info` for later consumption. You can do your own command line option
4205 parsing after calling `setup_revisions()`. After that, you have to call
4206 `prepare_revision_walk()` for initialization, and then you can get the
4207 commits one by one with the function `get_revision()`.
4209 If you are interested in more details of the revision walking process,
4210 just have a look at the first implementation of `cmd_log()`; call
4211 `git show v1.3.0{tilde}155^2{tilde}4` and scroll down to that function (note that you
4212 no longer need to call `setup_pager()` directly).
4214 Nowadays, `git log` is a builtin, which means that it is _contained_ in the
4215 command `git`.  The source side of a builtin is
4217 - a function called `cmd_<bla>`, typically defined in `builtin-<bla>.c`,
4218   and declared in `builtin.h`,
4220 - an entry in the `commands[]` array in `git.c`, and
4222 - an entry in `BUILTIN_OBJECTS` in the `Makefile`.
4224 Sometimes, more than one builtin is contained in one source file.  For
4225 example, `cmd_whatchanged()` and `cmd_log()` both reside in `builtin-log.c`,
4226 since they share quite a bit of code.  In that case, the commands which are
4227 _not_ named like the `.c` file in which they live have to be listed in
4228 `BUILT_INS` in the `Makefile`.
4230 `git log` looks more complicated in C than it does in the original script,
4231 but that allows for a much greater flexibility and performance.
4233 Here again it is a good point to take a pause.
4235 Lesson three is: study the code.  Really, it is the best way to learn about
4236 the organization of Git (after you know the basic concepts).
4238 So, think about something which you are interested in, say, "how can I
4239 access a blob just knowing the object name of it?".  The first step is to
4240 find a Git command with which you can do it.  In this example, it is either
4241 `git show` or `git cat-file`.
4243 For the sake of clarity, let's stay with `git cat-file`, because it
4245 - is plumbing, and
4247 - was around even in the initial commit (it literally went only through
4248   some 20 revisions as `cat-file.c`, was renamed to `builtin-cat-file.c`
4249   when made a builtin, and then saw less than 10 versions).
4251 So, look into `builtin-cat-file.c`, search for `cmd_cat_file()` and look what
4252 it does.
4254 ------------------------------------------------------------------
4255         git_config(git_default_config);
4256         if (argc != 3)
4257                 usage("git cat-file [-t|-s|-e|-p|<type>] <sha1>");
4258         if (get_sha1(argv[2], sha1))
4259                 die("Not a valid object name %s", argv[2]);
4260 ------------------------------------------------------------------
4262 Let's skip over the obvious details; the only really interesting part
4263 here is the call to `get_sha1()`.  It tries to interpret `argv[2]` as an
4264 object name, and if it refers to an object which is present in the current
4265 repository, it writes the resulting SHA-1 into the variable `sha1`.
4267 Two things are interesting here:
4269 - `get_sha1()` returns 0 on _success_.  This might surprise some new
4270   Git hackers, but there is a long tradition in UNIX to return different
4271   negative numbers in case of different errors--and 0 on success.
4273 - the variable `sha1` in the function signature of `get_sha1()` is `unsigned
4274   char {asterisk}`, but is actually expected to be a pointer to `unsigned
4275   char[20]`.  This variable will contain the 160-bit SHA-1 of the given
4276   commit.  Note that whenever a SHA-1 is passed as `unsigned char {asterisk}`, it
4277   is the binary representation, as opposed to the ASCII representation in
4278   hex characters, which is passed as `char *`.
4280 You will see both of these things throughout the code.
4282 Now, for the meat:
4284 -----------------------------------------------------------------------------
4285         case 0:
4286                 buf = read_object_with_reference(sha1, argv[1], &size, NULL);
4287 -----------------------------------------------------------------------------
4289 This is how you read a blob (actually, not only a blob, but any type of
4290 object).  To know how the function `read_object_with_reference()` actually
4291 works, find the source code for it (something like `git grep
4292 read_object_with | grep ":[a-z]"` in the git repository), and read
4293 the source.
4295 To find out how the result can be used, just read on in `cmd_cat_file()`:
4297 -----------------------------------
4298         write_or_die(1, buf, size);
4299 -----------------------------------
4301 Sometimes, you do not know where to look for a feature.  In many such cases,
4302 it helps to search through the output of `git log`, and then `git show` the
4303 corresponding commit.
4305 Example: If you know that there was some test case for `git bundle`, but
4306 do not remember where it was (yes, you _could_ `git grep bundle t/`, but that
4307 does not illustrate the point!):
4309 ------------------------
4310 $ git log --no-merges t/
4311 ------------------------
4313 In the pager (`less`), just search for "bundle", go a few lines back,
4314 and see that it is in commit 18449ab0...  Now just copy this object name,
4315 and paste it into the command line
4317 -------------------
4318 $ git show 18449ab0
4319 -------------------
4321 Voila.
4323 Another example: Find out what to do in order to make some script a
4324 builtin:
4326 -------------------------------------------------
4327 $ git log --no-merges --diff-filter=A builtin-*.c
4328 -------------------------------------------------
4330 You see, Git is actually the best tool to find out about the source of Git
4331 itself!
4333 [[glossary]]
4334 Git Glossary
4335 ============
4337 include::glossary-content.txt[]
4339 [[git-quick-start]]
4340 Appendix A: Git Quick Reference
4341 ===============================
4343 This is a quick summary of the major commands; the previous chapters
4344 explain how these work in more detail.
4346 [[quick-creating-a-new-repository]]
4347 Creating a new repository
4348 -------------------------
4350 From a tarball:
4352 -----------------------------------------------
4353 $ tar xzf project.tar.gz
4354 $ cd project
4355 $ git init
4356 Initialized empty Git repository in .git/
4357 $ git add .
4358 $ git commit
4359 -----------------------------------------------
4361 From a remote repository:
4363 -----------------------------------------------
4364 $ git clone git://
4365 $ cd project
4366 -----------------------------------------------
4368 [[managing-branches]]
4369 Managing branches
4370 -----------------
4372 -----------------------------------------------
4373 $ git branch         # list all local branches in this repo
4374 $ git checkout test  # switch working directory to branch "test"
4375 $ git branch new     # create branch "new" starting at current HEAD
4376 $ git branch -d new  # delete branch "new"
4377 -----------------------------------------------
4379 Instead of basing a new branch on current HEAD (the default), use:
4381 -----------------------------------------------
4382 $ git branch new test    # branch named "test"
4383 $ git branch new v2.6.15 # tag named v2.6.15
4384 $ git branch new HEAD^   # commit before the most recent
4385 $ git branch new HEAD^^  # commit before that
4386 $ git branch new test~10 # ten commits before tip of branch "test"
4387 -----------------------------------------------
4389 Create and switch to a new branch at the same time:
4391 -----------------------------------------------
4392 $ git checkout -b new v2.6.15
4393 -----------------------------------------------
4395 Update and examine branches from the repository you cloned from:
4397 -----------------------------------------------
4398 $ git fetch             # update
4399 $ git branch -r         # list
4400   origin/master
4401   origin/next
4402   ...
4403 $ git checkout -b masterwork origin/master
4404 -----------------------------------------------
4406 Fetch a branch from a different repository, and give it a new
4407 name in your repository:
4409 -----------------------------------------------
4410 $ git fetch git:// theirbranch:mybranch
4411 $ git fetch git:// v2.6.15:mybranch
4412 -----------------------------------------------
4414 Keep a list of repositories you work with regularly:
4416 -----------------------------------------------
4417 $ git remote add example git://
4418 $ git remote                    # list remote repositories
4419 example
4420 origin
4421 $ git remote show example       # get details
4422 * remote example
4423   URL: git://
4424   Tracked remote branches
4425     master
4426     next
4427     ...
4428 $ git fetch example             # update branches from example
4429 $ git branch -r                 # list all remote branches
4430 -----------------------------------------------
4433 [[exploring-history]]
4434 Exploring history
4435 -----------------
4437 -----------------------------------------------
4438 $ gitk                      # visualize and browse history
4439 $ git log                   # list all commits
4440 $ git log src/              # ...modifying src/
4441 $ git log v2.6.15..v2.6.16  # v2.6.16, not in v2.6.15
4442 $ git log master..test      # branch test, not in branch master
4443 $ git log test..master      # branch master, but not in test
4444 $ git log test...master     # one branch, not in both
4445 $ git log -S'foo()'         # ...where difference contain "foo()"
4446 $ git log --since="2 weeks ago"
4447 $ git log -p                # show patches as well
4448 $ git show                  # most recent commit
4449 $ git diff v2.6.15..v2.6.16 # diff between two tagged versions
4450 $ git diff v2.6.15..HEAD    # diff with current head
4451 $ git grep "foo()"          # search working directory for "foo()"
4452 $ git grep v2.6.15 "foo()"  # search old tree for "foo()"
4453 $ git show v2.6.15:a.txt    # look at old version of a.txt
4454 -----------------------------------------------
4456 Search for regressions:
4458 -----------------------------------------------
4459 $ git bisect start
4460 $ git bisect bad                # current version is bad
4461 $ git bisect good v2.6.13-rc2   # last known good revision
4462 Bisecting: 675 revisions left to test after this
4463                                 # test here, then:
4464 $ git bisect good               # if this revision is good, or
4465 $ git bisect bad                # if this revision is bad.
4466                                 # repeat until done.
4467 -----------------------------------------------
4469 [[making-changes]]
4470 Making changes
4471 --------------
4473 Make sure git knows who to blame:
4475 ------------------------------------------------
4476 $ cat >>~/.gitconfig <<\EOF
4477 [user]
4478         name = Your Name Comes Here
4479         email =
4481 ------------------------------------------------
4483 Select file contents to include in the next commit, then make the
4484 commit:
4486 -----------------------------------------------
4487 $ git add a.txt    # updated file
4488 $ git add b.txt    # new file
4489 $ git rm c.txt     # old file
4490 $ git commit
4491 -----------------------------------------------
4493 Or, prepare and create the commit in one step:
4495 -----------------------------------------------
4496 $ git commit d.txt # use latest content only of d.txt
4497 $ git commit -a    # use latest content of all tracked files
4498 -----------------------------------------------
4500 [[merging]]
4501 Merging
4502 -------
4504 -----------------------------------------------
4505 $ git merge test   # merge branch "test" into the current branch
4506 $ git pull git:// master
4507                    # fetch and merge in remote branch
4508 $ git pull . test  # equivalent to git merge test
4509 -----------------------------------------------
4511 [[sharing-your-changes]]
4512 Sharing your changes
4513 --------------------
4515 Importing or exporting patches:
4517 -----------------------------------------------
4518 $ git format-patch origin..HEAD # format a patch for each commit
4519                                 # in HEAD but not in origin
4520 $ git am mbox # import patc