Merge branch 'wk/man-deny-current-branch-is-default-these-days' into maint
[git/jnareb-git.git] / Documentation / user-manual.txt
blob20e5b4216d3bf25b826ed5c835ec1a2d4594c3f5
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://git.kernel.org/pub/scm/git/git.git
62         # the Linux kernel (approx. 150MB download):
63 $ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.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 <torvalds@ppc970.osdl.org.(none)>
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://linux-nfs.org/pub/nfs-2.6.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://linux-nfs.org/pub/nfs-2.6.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://example.com/proj.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 -o latest.tar.gz --prefix=project/ HEAD
935 -------------------------------------------------
937 will use HEAD to produce a gzipped tar archive in which each filename
938 is preceded by `project/`.  The output file format is inferred from
939 the output file extension if possible, see linkgit:git-archive[1] for
940 details.
942 Versions of Git older than 1.7.7 don't know about the 'tar.gz' format,
943 you'll need to use gzip explicitly:
945 -------------------------------------------------
946 $ git archive --format=tar --prefix=project/ HEAD | gzip >latest.tar.gz
947 -------------------------------------------------
949 If you're releasing a new version of a software project, you may want
950 to simultaneously make a changelog to include in the release
951 announcement.
953 Linus Torvalds, for example, makes new kernel releases by tagging them,
954 then running:
956 -------------------------------------------------
957 $ release-script 2.6.12 2.6.13-rc6 2.6.13-rc7
958 -------------------------------------------------
960 where release-script is a shell script that looks like:
962 -------------------------------------------------
963 #!/bin/sh
964 stable="$1"
965 last="$2"
966 new="$3"
967 echo "# git tag v$new"
968 echo "git archive --prefix=linux-$new/ v$new | gzip -9 > ../linux-$new.tar.gz"
969 echo "git diff v$stable v$new | gzip -9 > ../patch-$new.gz"
970 echo "git log --no-merges v$new ^v$last > ../ChangeLog-$new"
971 echo "git shortlog --no-merges v$new ^v$last > ../ShortLog"
972 echo "git diff --stat --summary -M v$last v$new > ../diffstat-$new"
973 -------------------------------------------------
975 and then he just cut-and-pastes the output commands after verifying that
976 they look OK.
978 [[Finding-commits-With-given-Content]]
979 Finding commits referencing a file with given content
980 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
982 Somebody hands you a copy of a file, and asks which commits modified a
983 file such that it contained the given content either before or after the
984 commit.  You can find out with this:
986 -------------------------------------------------
987 $  git log --raw --abbrev=40 --pretty=oneline |
988         grep -B 1 `git hash-object filename`
989 -------------------------------------------------
991 Figuring out why this works is left as an exercise to the (advanced)
992 student.  The linkgit:git-log[1], linkgit:git-diff-tree[1], and
993 linkgit:git-hash-object[1] man pages may prove helpful.
995 [[Developing-With-git]]
996 Developing with git
997 ===================
999 [[telling-git-your-name]]
1000 Telling git your name
1001 ---------------------
1003 Before creating any commits, you should introduce yourself to Git.
1004 The easiest way to do so is to use linkgit:git-config[1]:
1006 ------------------------------------------------
1007 $ git config --global user.name 'Your Name Comes Here'
1008 $ git config --global user.email 'you@yourdomain.example.com'
1009 ------------------------------------------------
1011 Which will add the following to a file named `.gitconfig` in your
1012 home directory:
1014 ------------------------------------------------
1015 [user]
1016         name = Your Name Comes Here
1017         email = you@yourdomain.example.com
1018 ------------------------------------------------
1020 See the "CONFIGURATION FILE" section of linkgit:git-config[1] for
1021 details on the configuration file.  The file is plain text, so you can
1022 also edit it with your favorite editor.
1025 [[creating-a-new-repository]]
1026 Creating a new repository
1027 -------------------------
1029 Creating a new repository from scratch is very easy:
1031 -------------------------------------------------
1032 $ mkdir project
1033 $ cd project
1034 $ git init
1035 -------------------------------------------------
1037 If you have some initial content (say, a tarball):
1039 -------------------------------------------------
1040 $ tar xzvf project.tar.gz
1041 $ cd project
1042 $ git init
1043 $ git add . # include everything below ./ in the first commit:
1044 $ git commit
1045 -------------------------------------------------
1047 [[how-to-make-a-commit]]
1048 How to make a commit
1049 --------------------
1051 Creating a new commit takes three steps:
1053         1. Making some changes to the working directory using your
1054            favorite editor.
1055         2. Telling git about your changes.
1056         3. Creating the commit using the content you told git about
1057            in step 2.
1059 In practice, you can interleave and repeat steps 1 and 2 as many
1060 times as you want: in order to keep track of what you want committed
1061 at step 3, git maintains a snapshot of the tree's contents in a
1062 special staging area called "the index."
1064 At the beginning, the content of the index will be identical to
1065 that of the HEAD.  The command "git diff --cached", which shows
1066 the difference between the HEAD and the index, should therefore
1067 produce no output at that point.
1069 Modifying the index is easy:
1071 To update the index with the new contents of a modified file, use
1073 -------------------------------------------------
1074 $ git add path/to/file
1075 -------------------------------------------------
1077 To add the contents of a new file to the index, use
1079 -------------------------------------------------
1080 $ git add path/to/file
1081 -------------------------------------------------
1083 To remove a file from the index and from the working tree,
1085 -------------------------------------------------
1086 $ git rm path/to/file
1087 -------------------------------------------------
1089 After each step you can verify that
1091 -------------------------------------------------
1092 $ git diff --cached
1093 -------------------------------------------------
1095 always shows the difference between the HEAD and the index file--this
1096 is what you'd commit if you created the commit now--and that
1098 -------------------------------------------------
1099 $ git diff
1100 -------------------------------------------------
1102 shows the difference between the working tree and the index file.
1104 Note that "git add" always adds just the current contents of a file
1105 to the index; further changes to the same file will be ignored unless
1106 you run `git add` on the file again.
1108 When you're ready, just run
1110 -------------------------------------------------
1111 $ git commit
1112 -------------------------------------------------
1114 and git will prompt you for a commit message and then create the new
1115 commit.  Check to make sure it looks like what you expected with
1117 -------------------------------------------------
1118 $ git show
1119 -------------------------------------------------
1121 As a special shortcut,
1123 -------------------------------------------------
1124 $ git commit -a
1125 -------------------------------------------------
1127 will update the index with any files that you've modified or removed
1128 and create a commit, all in one step.
1130 A number of commands are useful for keeping track of what you're
1131 about to commit:
1133 -------------------------------------------------
1134 $ git diff --cached # difference between HEAD and the index; what
1135                     # would be committed if you ran "commit" now.
1136 $ git diff          # difference between the index file and your
1137                     # working directory; changes that would not
1138                     # be included if you ran "commit" now.
1139 $ git diff HEAD     # difference between HEAD and working tree; what
1140                     # would be committed if you ran "commit -a" now.
1141 $ git status        # a brief per-file summary of the above.
1142 -------------------------------------------------
1144 You can also use linkgit:git-gui[1] to create commits, view changes in
1145 the index and the working tree files, and individually select diff hunks
1146 for inclusion in the index (by right-clicking on the diff hunk and
1147 choosing "Stage Hunk For Commit").
1149 [[creating-good-commit-messages]]
1150 Creating good commit messages
1151 -----------------------------
1153 Though not required, it's a good idea to begin the commit message
1154 with a single short (less than 50 character) line summarizing the
1155 change, followed by a blank line and then a more thorough
1156 description.  The text up to the first blank line in a commit
1157 message is treated as the commit title, and that title is used
1158 throughout git.  For example, linkgit:git-format-patch[1] turns a
1159 commit into email, and it uses the title on the Subject line and the
1160 rest of the commit in the body.
1163 [[ignoring-files]]
1164 Ignoring files
1165 --------------
1167 A project will often generate files that you do 'not' want to track with git.
1168 This typically includes files generated by a build process or temporary
1169 backup files made by your editor. Of course, 'not' tracking files with git
1170 is just a matter of 'not' calling `git add` on them. But it quickly becomes
1171 annoying to have these untracked files lying around; e.g. they make
1172 `git add .` practically useless, and they keep showing up in the output of
1173 `git status`.
1175 You can tell git to ignore certain files by creating a file called .gitignore
1176 in the top level of your working directory, with contents such as:
1178 -------------------------------------------------
1179 # Lines starting with '#' are considered comments.
1180 # Ignore any file named foo.txt.
1181 foo.txt
1182 # Ignore (generated) html files,
1183 *.html
1184 # except foo.html which is maintained by hand.
1185 !foo.html
1186 # Ignore objects and archives.
1187 *.[oa]
1188 -------------------------------------------------
1190 See linkgit:gitignore[5] for a detailed explanation of the syntax.  You can
1191 also place .gitignore files in other directories in your working tree, and they
1192 will apply to those directories and their subdirectories.  The `.gitignore`
1193 files can be added to your repository like any other files (just run `git add
1194 .gitignore` and `git commit`, as usual), which is convenient when the exclude
1195 patterns (such as patterns matching build output files) would also make sense
1196 for other users who clone your repository.
1198 If you wish the exclude patterns to affect only certain repositories
1199 (instead of every repository for a given project), you may instead put
1200 them in a file in your repository named .git/info/exclude, or in any file
1201 specified by the `core.excludesfile` configuration variable.  Some git
1202 commands can also take exclude patterns directly on the command line.
1203 See linkgit:gitignore[5] for the details.
1205 [[how-to-merge]]
1206 How to merge
1207 ------------
1209 You can rejoin two diverging branches of development using
1210 linkgit:git-merge[1]:
1212 -------------------------------------------------
1213 $ git merge branchname
1214 -------------------------------------------------
1216 merges the development in the branch "branchname" into the current
1217 branch.
1219 A merge is made by combining the changes made in "branchname" and the
1220 changes made up to the latest commit in your current branch since
1221 their histories forked. The work tree is overwritten by the result of
1222 the merge when this combining is done cleanly, or overwritten by a
1223 half-merged results when this combining results in conflicts.
1224 Therefore, if you have uncommitted changes touching the same files as
1225 the ones impacted by the merge, Git will refuse to proceed. Most of
1226 the time, you will want to commit your changes before you can merge,
1227 and if you don't, then linkgit:git-stash[1] can take these changes
1228 away while you're doing the merge, and reapply them afterwards.
1230 If the changes are independent enough, Git will automatically complete
1231 the merge and commit the result (or reuse an existing commit in case
1232 of <<fast-forwards,fast-forward>>, see below). On the other hand,
1233 if there are conflicts--for example, if the same file is
1234 modified in two different ways in the remote branch and the local
1235 branch--then you are warned; the output may look something like this:
1237 -------------------------------------------------
1238 $ git merge next
1239  100% (4/4) done
1240 Auto-merged file.txt
1241 CONFLICT (content): Merge conflict in file.txt
1242 Automatic merge failed; fix conflicts and then commit the result.
1243 -------------------------------------------------
1245 Conflict markers are left in the problematic files, and after
1246 you resolve the conflicts manually, you can update the index
1247 with the contents and run git commit, as you normally would when
1248 creating a new file.
1250 If you examine the resulting commit using gitk, you will see that it
1251 has two parents, one pointing to the top of the current branch, and
1252 one to the top of the other branch.
1254 [[resolving-a-merge]]
1255 Resolving a merge
1256 -----------------
1258 When a merge isn't resolved automatically, git leaves the index and
1259 the working tree in a special state that gives you all the
1260 information you need to help resolve the merge.
1262 Files with conflicts are marked specially in the index, so until you
1263 resolve the problem and update the index, linkgit:git-commit[1] will
1264 fail:
1266 -------------------------------------------------
1267 $ git commit
1268 file.txt: needs merge
1269 -------------------------------------------------
1271 Also, linkgit:git-status[1] will list those files as "unmerged", and the
1272 files with conflicts will have conflict markers added, like this:
1274 -------------------------------------------------
1275 <<<<<<< HEAD:file.txt
1276 Hello world
1277 =======
1278 Goodbye
1279 >>>>>>> 77976da35a11db4580b80ae27e8d65caf5208086:file.txt
1280 -------------------------------------------------
1282 All you need to do is edit the files to resolve the conflicts, and then
1284 -------------------------------------------------
1285 $ git add file.txt
1286 $ git commit
1287 -------------------------------------------------
1289 Note that the commit message will already be filled in for you with
1290 some information about the merge.  Normally you can just use this
1291 default message unchanged, but you may add additional commentary of
1292 your own if desired.
1294 The above is all you need to know to resolve a simple merge.  But git
1295 also provides more information to help resolve conflicts:
1297 [[conflict-resolution]]
1298 Getting conflict-resolution help during a merge
1299 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1301 All of the changes that git was able to merge automatically are
1302 already added to the index file, so linkgit:git-diff[1] shows only
1303 the conflicts.  It uses an unusual syntax:
1305 -------------------------------------------------
1306 $ git diff
1307 diff --cc file.txt
1308 index 802992c,2b60207..0000000
1309 --- a/file.txt
1310 +++ b/file.txt
1311 @@@ -1,1 -1,1 +1,5 @@@
1312 ++<<<<<<< HEAD:file.txt
1313  +Hello world
1314 ++=======
1315 + Goodbye
1316 ++>>>>>>> 77976da35a11db4580b80ae27e8d65caf5208086:file.txt
1317 -------------------------------------------------
1319 Recall that the commit which will be committed after we resolve this
1320 conflict will have two parents instead of the usual one: one parent
1321 will be HEAD, the tip of the current branch; the other will be the
1322 tip of the other branch, which is stored temporarily in MERGE_HEAD.
1324 During the merge, the index holds three versions of each file.  Each of
1325 these three "file stages" represents a different version of the file:
1327 -------------------------------------------------
1328 $ git show :1:file.txt  # the file in a common ancestor of both branches
1329 $ git show :2:file.txt  # the version from HEAD.
1330 $ git show :3:file.txt  # the version from MERGE_HEAD.
1331 -------------------------------------------------
1333 When you ask linkgit:git-diff[1] to show the conflicts, it runs a
1334 three-way diff between the conflicted merge results in the work tree with
1335 stages 2 and 3 to show only hunks whose contents come from both sides,
1336 mixed (in other words, when a hunk's merge results come only from stage 2,
1337 that part is not conflicting and is not shown.  Same for stage 3).
1339 The diff above shows the differences between the working-tree version of
1340 file.txt and the stage 2 and stage 3 versions.  So instead of preceding
1341 each line by a single "+" or "-", it now uses two columns: the first
1342 column is used for differences between the first parent and the working
1343 directory copy, and the second for differences between the second parent
1344 and the working directory copy.  (See the "COMBINED DIFF FORMAT" section
1345 of linkgit:git-diff-files[1] for a details of the format.)
1347 After resolving the conflict in the obvious way (but before updating the
1348 index), the diff will look like:
1350 -------------------------------------------------
1351 $ git diff
1352 diff --cc file.txt
1353 index 802992c,2b60207..0000000
1354 --- a/file.txt
1355 +++ b/file.txt
1356 @@@ -1,1 -1,1 +1,1 @@@
1357 - Hello world
1358  -Goodbye
1359 ++Goodbye world
1360 -------------------------------------------------
1362 This shows that our resolved version deleted "Hello world" from the
1363 first parent, deleted "Goodbye" from the second parent, and added
1364 "Goodbye world", which was previously absent from both.
1366 Some special diff options allow diffing the working directory against
1367 any of these stages:
1369 -------------------------------------------------
1370 $ git diff -1 file.txt          # diff against stage 1
1371 $ git diff --base file.txt      # same as the above
1372 $ git diff -2 file.txt          # diff against stage 2
1373 $ git diff --ours file.txt      # same as the above
1374 $ git diff -3 file.txt          # diff against stage 3
1375 $ git diff --theirs file.txt    # same as the above.
1376 -------------------------------------------------
1378 The linkgit:git-log[1] and linkgit:gitk[1] commands also provide special help
1379 for merges:
1381 -------------------------------------------------
1382 $ git log --merge
1383 $ gitk --merge
1384 -------------------------------------------------
1386 These will display all commits which exist only on HEAD or on
1387 MERGE_HEAD, and which touch an unmerged file.
1389 You may also use linkgit:git-mergetool[1], which lets you merge the
1390 unmerged files using external tools such as Emacs or kdiff3.
1392 Each time you resolve the conflicts in a file and update the index:
1394 -------------------------------------------------
1395 $ git add file.txt
1396 -------------------------------------------------
1398 the different stages of that file will be "collapsed", after which
1399 `git diff` will (by default) no longer show diffs for that file.
1401 [[undoing-a-merge]]
1402 Undoing a merge
1403 ---------------
1405 If you get stuck and decide to just give up and throw the whole mess
1406 away, you can always return to the pre-merge state with
1408 -------------------------------------------------
1409 $ git reset --hard HEAD
1410 -------------------------------------------------
1412 Or, if you've already committed the merge that you want to throw away,
1414 -------------------------------------------------
1415 $ git reset --hard ORIG_HEAD
1416 -------------------------------------------------
1418 However, this last command can be dangerous in some cases--never
1419 throw away a commit you have already committed if that commit may
1420 itself have been merged into another branch, as doing so may confuse
1421 further merges.
1423 [[fast-forwards]]
1424 Fast-forward merges
1425 -------------------
1427 There is one special case not mentioned above, which is treated
1428 differently.  Normally, a merge results in a merge commit, with two
1429 parents, one pointing at each of the two lines of development that
1430 were merged.
1432 However, if the current branch is a descendant of the other--so every
1433 commit present in the one is already contained in the other--then git
1434 just performs a "fast-forward"; the head of the current branch is moved
1435 forward to point at the head of the merged-in branch, without any new
1436 commits being created.
1438 [[fixing-mistakes]]
1439 Fixing mistakes
1440 ---------------
1442 If you've messed up the working tree, but haven't yet committed your
1443 mistake, you can return the entire working tree to the last committed
1444 state with
1446 -------------------------------------------------
1447 $ git reset --hard HEAD
1448 -------------------------------------------------
1450 If you make a commit that you later wish you hadn't, there are two
1451 fundamentally different ways to fix the problem:
1453         1. You can create a new commit that undoes whatever was done
1454         by the old commit.  This is the correct thing if your
1455         mistake has already been made public.
1457         2. You can go back and modify the old commit.  You should
1458         never do this if you have already made the history public;
1459         git does not normally expect the "history" of a project to
1460         change, and cannot correctly perform repeated merges from
1461         a branch that has had its history changed.
1463 [[reverting-a-commit]]
1464 Fixing a mistake with a new commit
1465 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1467 Creating a new commit that reverts an earlier change is very easy;
1468 just pass the linkgit:git-revert[1] command a reference to the bad
1469 commit; for example, to revert the most recent commit:
1471 -------------------------------------------------
1472 $ git revert HEAD
1473 -------------------------------------------------
1475 This will create a new commit which undoes the change in HEAD.  You
1476 will be given a chance to edit the commit message for the new commit.
1478 You can also revert an earlier change, for example, the next-to-last:
1480 -------------------------------------------------
1481 $ git revert HEAD^
1482 -------------------------------------------------
1484 In this case git will attempt to undo the old change while leaving
1485 intact any changes made since then.  If more recent changes overlap
1486 with the changes to be reverted, then you will be asked to fix
1487 conflicts manually, just as in the case of <<resolving-a-merge,
1488 resolving a merge>>.
1490 [[fixing-a-mistake-by-rewriting-history]]
1491 Fixing a mistake by rewriting history
1492 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1494 If the problematic commit is the most recent commit, and you have not
1495 yet made that commit public, then you may just
1496 <<undoing-a-merge,destroy it using `git reset`>>.
1498 Alternatively, you
1499 can edit the working directory and update the index to fix your
1500 mistake, just as if you were going to <<how-to-make-a-commit,create a
1501 new commit>>, then run
1503 -------------------------------------------------
1504 $ git commit --amend
1505 -------------------------------------------------
1507 which will replace the old commit by a new commit incorporating your
1508 changes, giving you a chance to edit the old commit message first.
1510 Again, you should never do this to a commit that may already have
1511 been merged into another branch; use linkgit:git-revert[1] instead in
1512 that case.
1514 It is also possible to replace commits further back in the history, but
1515 this is an advanced topic to be left for
1516 <<cleaning-up-history,another chapter>>.
1518 [[checkout-of-path]]
1519 Checking out an old version of a file
1520 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1522 In the process of undoing a previous bad change, you may find it
1523 useful to check out an older version of a particular file using
1524 linkgit:git-checkout[1].  We've used `git checkout` before to switch
1525 branches, but it has quite different behavior if it is given a path
1526 name: the command
1528 -------------------------------------------------
1529 $ git checkout HEAD^ path/to/file
1530 -------------------------------------------------
1532 replaces path/to/file by the contents it had in the commit HEAD^, and
1533 also updates the index to match.  It does not change branches.
1535 If you just want to look at an old version of the file, without
1536 modifying the working directory, you can do that with
1537 linkgit:git-show[1]:
1539 -------------------------------------------------
1540 $ git show HEAD^:path/to/file
1541 -------------------------------------------------
1543 which will display the given version of the file.
1545 [[interrupted-work]]
1546 Temporarily setting aside work in progress
1547 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1549 While you are in the middle of working on something complicated, you
1550 find an unrelated but obvious and trivial bug.  You would like to fix it
1551 before continuing.  You can use linkgit:git-stash[1] to save the current
1552 state of your work, and after fixing the bug (or, optionally after doing
1553 so on a different branch and then coming back), unstash the
1554 work-in-progress changes.
1556 ------------------------------------------------
1557 $ git stash save "work in progress for foo feature"
1558 ------------------------------------------------
1560 This command will save your changes away to the `stash`, and
1561 reset your working tree and the index to match the tip of your
1562 current branch.  Then you can make your fix as usual.
1564 ------------------------------------------------
1565 ... edit and test ...
1566 $ git commit -a -m "blorpl: typofix"
1567 ------------------------------------------------
1569 After that, you can go back to what you were working on with
1570 `git stash pop`:
1572 ------------------------------------------------
1573 $ git stash pop
1574 ------------------------------------------------
1577 [[ensuring-good-performance]]
1578 Ensuring good performance
1579 -------------------------
1581 On large repositories, Git depends on compression to keep the history
1582 information from taking up too much space on disk or in memory.  Some
1583 git commands may automatically run linkgit:git-gc[1], so you don't
1584 have to worry about running it manually.  However, compressing a large
1585 repository may take a while, so you may want to call `gc` explicitly
1586 to avoid automatic compression kicking in when it is not convenient.
1589 [[ensuring-reliability]]
1590 Ensuring reliability
1591 --------------------
1593 [[checking-for-corruption]]
1594 Checking the repository for corruption
1595 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1597 The linkgit:git-fsck[1] command runs a number of self-consistency checks
1598 on the repository, and reports on any problems.  This may take some
1599 time.
1601 -------------------------------------------------
1602 $ git fsck
1603 dangling commit 7281251ddd2a61e38657c827739c57015671a6b3
1604 dangling commit 2706a059f258c6b245f298dc4ff2ccd30ec21a63
1605 dangling commit 13472b7c4b80851a1bc551779171dcb03655e9b5
1606 dangling blob 218761f9d90712d37a9c5e36f406f92202db07eb
1607 dangling commit bf093535a34a4d35731aa2bd90fe6b176302f14f
1608 dangling commit 8e4bec7f2ddaa268bef999853c25755452100f8e
1609 dangling tree d50bb86186bf27b681d25af89d3b5b68382e4085
1610 dangling tree b24c2473f1fd3d91352a624795be026d64c8841f
1612 -------------------------------------------------
1614 You will see informational messages on dangling objects. They are objects
1615 that still exist in the repository but are no longer referenced by any of
1616 your branches, and can (and will) be removed after a while with "gc".
1617 You can run `git fsck --no-dangling` to suppress these messages, and still
1618 view real errors.
1620 [[recovering-lost-changes]]
1621 Recovering lost changes
1622 ~~~~~~~~~~~~~~~~~~~~~~~
1624 [[reflogs]]
1625 Reflogs
1626 ^^^^^^^
1628 Say you modify a branch with +linkgit:git-reset[1] \--hard+, and then
1629 realize that the branch was the only reference you had to that point in
1630 history.
1632 Fortunately, git also keeps a log, called a "reflog", of all the
1633 previous values of each branch.  So in this case you can still find the
1634 old history using, for example,
1636 -------------------------------------------------
1637 $ git log master@{1}
1638 -------------------------------------------------
1640 This lists the commits reachable from the previous version of the
1641 "master" branch head.  This syntax can be used with any git command
1642 that accepts a commit, not just with git log.  Some other examples:
1644 -------------------------------------------------
1645 $ git show master@{2}           # See where the branch pointed 2,
1646 $ git show master@{3}           # 3, ... changes ago.
1647 $ gitk master@{yesterday}       # See where it pointed yesterday,
1648 $ gitk master@{"1 week ago"}    # ... or last week
1649 $ git log --walk-reflogs master # show reflog entries for master
1650 -------------------------------------------------
1652 A separate reflog is kept for the HEAD, so
1654 -------------------------------------------------
1655 $ git show HEAD@{"1 week ago"}
1656 -------------------------------------------------
1658 will show what HEAD pointed to one week ago, not what the current branch
1659 pointed to one week ago.  This allows you to see the history of what
1660 you've checked out.
1662 The reflogs are kept by default for 30 days, after which they may be
1663 pruned.  See linkgit:git-reflog[1] and linkgit:git-gc[1] to learn
1664 how to control this pruning, and see the "SPECIFYING REVISIONS"
1665 section of linkgit:gitrevisions[7] for details.
1667 Note that the reflog history is very different from normal git history.
1668 While normal history is shared by every repository that works on the
1669 same project, the reflog history is not shared: it tells you only about
1670 how the branches in your local repository have changed over time.
1672 [[dangling-object-recovery]]
1673 Examining dangling objects
1674 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1676 In some situations the reflog may not be able to save you.  For example,
1677 suppose you delete a branch, then realize you need the history it
1678 contained.  The reflog is also deleted; however, if you have not yet
1679 pruned the repository, then you may still be able to find the lost
1680 commits in the dangling objects that `git fsck` reports.  See
1681 <<dangling-objects>> for the details.
1683 -------------------------------------------------
1684 $ git fsck
1685 dangling commit 7281251ddd2a61e38657c827739c57015671a6b3
1686 dangling commit 2706a059f258c6b245f298dc4ff2ccd30ec21a63
1687 dangling commit 13472b7c4b80851a1bc551779171dcb03655e9b5
1689 -------------------------------------------------
1691 You can examine
1692 one of those dangling commits with, for example,
1694 ------------------------------------------------
1695 $ gitk 7281251ddd --not --all
1696 ------------------------------------------------
1698 which does what it sounds like: it says that you want to see the commit
1699 history that is described by the dangling commit(s), but not the
1700 history that is described by all your existing branches and tags.  Thus
1701 you get exactly the history reachable from that commit that is lost.
1702 (And notice that it might not be just one commit: we only report the
1703 "tip of the line" as being dangling, but there might be a whole deep
1704 and complex commit history that was dropped.)
1706 If you decide you want the history back, you can always create a new
1707 reference pointing to it, for example, a new branch:
1709 ------------------------------------------------
1710 $ git branch recovered-branch 7281251ddd
1711 ------------------------------------------------
1713 Other types of dangling objects (blobs and trees) are also possible, and
1714 dangling objects can arise in other situations.
1717 [[sharing-development]]
1718 Sharing development with others
1719 ===============================
1721 [[getting-updates-With-git-pull]]
1722 Getting updates with git pull
1723 -----------------------------
1725 After you clone a repository and commit a few changes of your own, you
1726 may wish to check the original repository for updates and merge them
1727 into your own work.
1729 We have already seen <<Updating-a-repository-With-git-fetch,how to
1730 keep remote-tracking branches up to date>> with linkgit:git-fetch[1],
1731 and how to merge two branches.  So you can merge in changes from the
1732 original repository's master branch with:
1734 -------------------------------------------------
1735 $ git fetch
1736 $ git merge origin/master
1737 -------------------------------------------------
1739 However, the linkgit:git-pull[1] command provides a way to do this in
1740 one step:
1742 -------------------------------------------------
1743 $ git pull origin master
1744 -------------------------------------------------
1746 In fact, if you have "master" checked out, then this branch has been
1747 configured by "git clone" to get changes from the HEAD branch of the
1748 origin repository.  So often you can
1749 accomplish the above with just a simple
1751 -------------------------------------------------
1752 $ git pull
1753 -------------------------------------------------
1755 This command will fetch changes from the remote branches to your
1756 remote-tracking branches `origin/*`, and merge the default branch into
1757 the current branch.
1759 More generally, a branch that is created from a remote-tracking branch
1760 will pull
1761 by default from that branch.  See the descriptions of the
1762 branch.<name>.remote and branch.<name>.merge options in
1763 linkgit:git-config[1], and the discussion of the `--track` option in
1764 linkgit:git-checkout[1], to learn how to control these defaults.
1766 In addition to saving you keystrokes, "git pull" also helps you by
1767 producing a default commit message documenting the branch and
1768 repository that you pulled from.
1770 (But note that no such commit will be created in the case of a
1771 <<fast-forwards,fast-forward>>; instead, your branch will just be
1772 updated to point to the latest commit from the upstream branch.)
1774 The `git pull` command can also be given "." as the "remote" repository,
1775 in which case it just merges in a branch from the current repository; so
1776 the commands
1778 -------------------------------------------------
1779 $ git pull . branch
1780 $ git merge branch
1781 -------------------------------------------------
1783 are roughly equivalent.  The former is actually very commonly used.
1785 [[submitting-patches]]
1786 Submitting patches to a project
1787 -------------------------------
1789 If you just have a few changes, the simplest way to submit them may
1790 just be to send them as patches in email:
1792 First, use linkgit:git-format-patch[1]; for example:
1794 -------------------------------------------------
1795 $ git format-patch origin
1796 -------------------------------------------------
1798 will produce a numbered series of files in the current directory, one
1799 for each patch in the current branch but not in origin/HEAD.
1801 `git format-patch` can include an initial "cover letter". You can insert
1802 commentary on individual patches after the three dash line which
1803 `format-patch` places after the commit message but before the patch
1804 itself.  If you use `git notes` to track your cover letter material,
1805 `git format-patch --notes` will include the commit's notes in a similar
1806 manner.
1808 You can then import these into your mail client and send them by
1809 hand.  However, if you have a lot to send at once, you may prefer to
1810 use the linkgit:git-send-email[1] script to automate the process.
1811 Consult the mailing list for your project first to determine how they
1812 prefer such patches be handled.
1814 [[importing-patches]]
1815 Importing patches to a project
1816 ------------------------------
1818 Git also provides a tool called linkgit:git-am[1] (am stands for
1819 "apply mailbox"), for importing such an emailed series of patches.
1820 Just save all of the patch-containing messages, in order, into a
1821 single mailbox file, say "patches.mbox", then run
1823 -------------------------------------------------
1824 $ git am -3 patches.mbox
1825 -------------------------------------------------
1827 Git will apply each patch in order; if any conflicts are found, it
1828 will stop, and you can fix the conflicts as described in
1829 "<<resolving-a-merge,Resolving a merge>>".  (The "-3" option tells
1830 git to perform a merge; if you would prefer it just to abort and
1831 leave your tree and index untouched, you may omit that option.)
1833 Once the index is updated with the results of the conflict
1834 resolution, instead of creating a new commit, just run
1836 -------------------------------------------------
1837 $ git am --resolved
1838 -------------------------------------------------
1840 and git will create the commit for you and continue applying the
1841 remaining patches from the mailbox.
1843 The final result will be a series of commits, one for each patch in
1844 the original mailbox, with authorship and commit log message each
1845 taken from the message containing each patch.
1847 [[public-repositories]]
1848 Public git repositories
1849 -----------------------
1851 Another way to submit changes to a project is to tell the maintainer
1852 of that project to pull the changes from your repository using
1853 linkgit:git-pull[1].  In the section "<<getting-updates-With-git-pull,
1854 Getting updates with `git pull`>>" we described this as a way to get
1855 updates from the "main" repository, but it works just as well in the
1856 other direction.
1858 If you and the maintainer both have accounts on the same machine, then
1859 you can just pull changes from each other's repositories directly;
1860 commands that accept repository URLs as arguments will also accept a
1861 local directory name:
1863 -------------------------------------------------
1864 $ git clone /path/to/repository
1865 $ git pull /path/to/other/repository
1866 -------------------------------------------------
1868 or an ssh URL:
1870 -------------------------------------------------
1871 $ git clone ssh://yourhost/~you/repository
1872 -------------------------------------------------
1874 For projects with few developers, or for synchronizing a few private
1875 repositories, this may be all you need.
1877 However, the more common way to do this is to maintain a separate public
1878 repository (usually on a different host) for others to pull changes
1879 from.  This is usually more convenient, and allows you to cleanly
1880 separate private work in progress from publicly visible work.
1882 You will continue to do your day-to-day work in your personal
1883 repository, but periodically "push" changes from your personal
1884 repository into your public repository, allowing other developers to
1885 pull from that repository.  So the flow of changes, in a situation
1886 where there is one other developer with a public repository, looks
1887 like this:
1889                         you push
1890   your personal repo ------------------> your public repo
1891         ^                                     |
1892         |                                     |
1893         | you pull                            | they pull
1894         |                                     |
1895         |                                     |
1896         |               they push             V
1897   their public repo <------------------- their repo
1899 We explain how to do this in the following sections.
1901 [[setting-up-a-public-repository]]
1902 Setting up a public repository
1903 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1905 Assume your personal repository is in the directory ~/proj.  We
1906 first create a new clone of the repository and tell `git daemon` that it
1907 is meant to be public:
1909 -------------------------------------------------
1910 $ git clone --bare ~/proj proj.git
1911 $ touch proj.git/git-daemon-export-ok
1912 -------------------------------------------------
1914 The resulting directory proj.git contains a "bare" git repository--it is
1915 just the contents of the ".git" directory, without any files checked out
1916 around it.
1918 Next, copy proj.git to the server where you plan to host the
1919 public repository.  You can use scp, rsync, or whatever is most
1920 convenient.
1922 [[exporting-via-git]]
1923 Exporting a git repository via the git protocol
1924 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1926 This is the preferred method.
1928 If someone else administers the server, they should tell you what
1929 directory to put the repository in, and what git:// URL it will appear
1930 at.  You can then skip to the section
1931 "<<pushing-changes-to-a-public-repository,Pushing changes to a public
1932 repository>>", below.
1934 Otherwise, all you need to do is start linkgit:git-daemon[1]; it will
1935 listen on port 9418.  By default, it will allow access to any directory
1936 that looks like a git directory and contains the magic file
1937 git-daemon-export-ok.  Passing some directory paths as `git daemon`
1938 arguments will further restrict the exports to those paths.
1940 You can also run `git daemon` as an inetd service; see the
1941 linkgit:git-daemon[1] man page for details.  (See especially the
1942 examples section.)
1944 [[exporting-via-http]]
1945 Exporting a git repository via HTTP
1946 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1948 The git protocol gives better performance and reliability, but on a
1949 host with a web server set up, HTTP exports may be simpler to set up.
1951 All you need to do is place the newly created bare git repository in
1952 a directory that is exported by the web server, and make some
1953 adjustments to give web clients some extra information they need:
1955 -------------------------------------------------
1956 $ mv proj.git /home/you/public_html/proj.git
1957 $ cd proj.git
1958 $ git --bare update-server-info
1959 $ mv hooks/post-update.sample hooks/post-update
1960 -------------------------------------------------
1962 (For an explanation of the last two lines, see
1963 linkgit:git-update-server-info[1] and linkgit:githooks[5].)
1965 Advertise the URL of proj.git.  Anybody else should then be able to
1966 clone or pull from that URL, for example with a command line like:
1968 -------------------------------------------------
1969 $ git clone http://yourserver.com/~you/proj.git
1970 -------------------------------------------------
1972 (See also
1973 link:howto/setup-git-server-over-http.txt[setup-git-server-over-http]
1974 for a slightly more sophisticated setup using WebDAV which also
1975 allows pushing over HTTP.)
1977 [[pushing-changes-to-a-public-repository]]
1978 Pushing changes to a public repository
1979 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1981 Note that the two techniques outlined above (exporting via
1982 <<exporting-via-http,http>> or <<exporting-via-git,git>>) allow other
1983 maintainers to fetch your latest changes, but they do not allow write
1984 access, which you will need to update the public repository with the
1985 latest changes created in your private repository.
1987 The simplest way to do this is using linkgit:git-push[1] and ssh; to
1988 update the remote branch named "master" with the latest state of your
1989 branch named "master", run
1991 -------------------------------------------------
1992 $ git push ssh://yourserver.com/~you/proj.git master:master
1993 -------------------------------------------------
1995 or just
1997 -------------------------------------------------
1998 $ git push ssh://yourserver.com/~you/proj.git master
1999 -------------------------------------------------
2001 As with `git fetch`, `git push` will complain if this does not result in a
2002 <<fast-forwards,fast-forward>>; see the following section for details on
2003 handling this case.
2005 Note that the target of a "push" is normally a
2006 <<def_bare_repository,bare>> repository.  You can also push to a
2007 repository that has a checked-out working tree, but a push to update the
2008 currently checked-out branch is denied by default to prevent confusion.
2009 See the description of the receive.denyCurrentBranch option
2010 in linkgit:git-config[1] for details.
2012 As with `git fetch`, you may also set up configuration options to
2013 save typing; so, for example:
2015 -------------------------------------------------
2016 $ git remote add public-repo ssh://yourserver.com/~you/proj.git
2017 -------------------------------------------------
2019 adds the following to `.git/config`:
2021 -------------------------------------------------
2022 [remote "public-repo"]
2023         url = yourserver.com:proj.git
2024         fetch = +refs/heads/*:refs/remotes/example/*
2025 -------------------------------------------------
2027 which lets you do the same push with just
2029 -------------------------------------------------
2030 $ git push public-repo master
2031 -------------------------------------------------
2033 See the explanations of the remote.<name>.url, branch.<name>.remote,
2034 and remote.<name>.push options in linkgit:git-config[1] for
2035 details.
2037 [[forcing-push]]
2038 What to do when a push fails
2039 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2041 If a push would not result in a <<fast-forwards,fast-forward>> of the
2042 remote branch, then it will fail with an error like:
2044 -------------------------------------------------
2045 error: remote 'refs/heads/master' is not an ancestor of
2046  local  'refs/heads/master'.
2047  Maybe you are not up-to-date and need to pull first?
2048 error: failed to push to 'ssh://yourserver.com/~you/proj.git'
2049 -------------------------------------------------
2051 This can happen, for example, if you:
2053         - use `git reset --hard` to remove already-published commits, or
2054         - use `git commit --amend` to replace already-published commits
2055           (as in <<fixing-a-mistake-by-rewriting-history>>), or
2056         - use `git rebase` to rebase any already-published commits (as
2057           in <<using-git-rebase>>).
2059 You may force `git push` to perform the update anyway by preceding the
2060 branch name with a plus sign:
2062 -------------------------------------------------
2063 $ git push ssh://yourserver.com/~you/proj.git +master
2064 -------------------------------------------------
2066 Note the addition of the `+` sign.  Alternatively, you can use the
2067 `-f` flag to force the remote update, as in:
2069 -------------------------------------------------
2070 $ git push -f ssh://yourserver.com/~you/proj.git master
2071 -------------------------------------------------
2073 Normally whenever a branch head in a public repository is modified, it
2074 is modified to point to a descendant of the commit that it pointed to
2075 before.  By forcing a push in this situation, you break that convention.
2076 (See <<problems-With-rewriting-history>>.)
2078 Nevertheless, this is a common practice for people that need a simple
2079 way to publish a work-in-progress patch series, and it is an acceptable
2080 compromise as long as you warn other developers that this is how you
2081 intend to manage the branch.
2083 It's also possible for a push to fail in this way when other people have
2084 the right to push to the same repository.  In that case, the correct
2085 solution is to retry the push after first updating your work: either by a
2086 pull, or by a fetch followed by a rebase; see the
2087 <<setting-up-a-shared-repository,next section>> and
2088 linkgit:gitcvs-migration[7] for more.
2090 [[setting-up-a-shared-repository]]
2091 Setting up a shared repository
2092 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2094 Another way to collaborate is by using a model similar to that
2095 commonly used in CVS, where several developers with special rights
2096 all push to and pull from a single shared repository.  See
2097 linkgit:gitcvs-migration[7] for instructions on how to
2098 set this up.
2100 However, while there is nothing wrong with git's support for shared
2101 repositories, this mode of operation is not generally recommended,
2102 simply because the mode of collaboration that git supports--by
2103 exchanging patches and pulling from public repositories--has so many
2104 advantages over the central shared repository:
2106         - Git's ability to quickly import and merge patches allows a
2107           single maintainer to process incoming changes even at very
2108           high rates.  And when that becomes too much, `git pull` provides
2109           an easy way for that maintainer to delegate this job to other
2110           maintainers while still allowing optional review of incoming
2111           changes.
2112         - Since every developer's repository has the same complete copy
2113           of the project history, no repository is special, and it is
2114           trivial for another developer to take over maintenance of a
2115           project, either by mutual agreement, or because a maintainer
2116           becomes unresponsive or difficult to work with.
2117         - The lack of a central group of "committers" means there is
2118           less need for formal decisions about who is "in" and who is
2119           "out".
2121 [[setting-up-gitweb]]
2122 Allowing web browsing of a repository
2123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2125 The gitweb cgi script provides users an easy way to browse your
2126 project's files and history without having to install git; see the file
2127 gitweb/INSTALL in the git source tree for instructions on setting it up.
2129 [[sharing-development-examples]]
2130 Examples
2131 --------
2133 [[maintaining-topic-branches]]
2134 Maintaining topic branches for a Linux subsystem maintainer
2135 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2137 This describes how Tony Luck uses git in his role as maintainer of the
2138 IA64 architecture for the Linux kernel.
2140 He uses two public branches:
2142  - A "test" tree into which patches are initially placed so that they
2143    can get some exposure when integrated with other ongoing development.
2144    This tree is available to Andrew for pulling into -mm whenever he
2145    wants.
2147  - A "release" tree into which tested patches are moved for final sanity
2148    checking, and as a vehicle to send them upstream to Linus (by sending
2149    him a "please pull" request.)
2151 He also uses a set of temporary branches ("topic branches"), each
2152 containing a logical grouping of patches.
2154 To set this up, first create your work tree by cloning Linus's public
2155 tree:
2157 -------------------------------------------------
2158 $ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git work
2159 $ cd work
2160 -------------------------------------------------
2162 Linus's tree will be stored in the remote-tracking branch named origin/master,
2163 and can be updated using linkgit:git-fetch[1]; you can track other
2164 public trees using linkgit:git-remote[1] to set up a "remote" and
2165 linkgit:git-fetch[1] to keep them up-to-date; see
2166 <<repositories-and-branches>>.
2168 Now create the branches in which you are going to work; these start out
2169 at the current tip of origin/master branch, and should be set up (using
2170 the --track option to linkgit:git-branch[1]) to merge changes in from
2171 Linus by default.
2173 -------------------------------------------------
2174 $ git branch --track test origin/master
2175 $ git branch --track release origin/master
2176 -------------------------------------------------
2178 These can be easily kept up to date using linkgit:git-pull[1].
2180 -------------------------------------------------
2181 $ git checkout test && git pull
2182 $ git checkout release && git pull
2183 -------------------------------------------------
2185 Important note!  If you have any local changes in these branches, then
2186 this merge will create a commit object in the history (with no local
2187 changes git will simply do a "fast-forward" merge).  Many people dislike
2188 the "noise" that this creates in the Linux history, so you should avoid
2189 doing this capriciously in the "release" branch, as these noisy commits
2190 will become part of the permanent history when you ask Linus to pull
2191 from the release branch.
2193 A few configuration variables (see linkgit:git-config[1]) can
2194 make it easy to push both branches to your public tree.  (See
2195 <<setting-up-a-public-repository>>.)
2197 -------------------------------------------------
2198 $ cat >> .git/config <<EOF
2199 [remote "mytree"]
2200         url =  master.kernel.org:/pub/scm/linux/kernel/git/aegl/linux-2.6.git
2201         push = release
2202         push = test
2204 -------------------------------------------------
2206 Then you can push both the test and release trees using
2207 linkgit:git-push[1]:
2209 -------------------------------------------------
2210 $ git push mytree
2211 -------------------------------------------------
2213 or push just one of the test and release branches using:
2215 -------------------------------------------------
2216 $ git push mytree test
2217 -------------------------------------------------
2221 -------------------------------------------------
2222 $ git push mytree release
2223 -------------------------------------------------
2225 Now to apply some patches from the community.  Think of a short
2226 snappy name for a branch to hold this patch (or related group of
2227 patches), and create a new branch from a recent stable tag of
2228 Linus's branch. Picking a stable base for your branch will:
2229 1) help you: by avoiding inclusion of unrelated and perhaps lightly
2230 tested changes
2231 2) help future bug hunters that use "git bisect" to find problems
2233 -------------------------------------------------
2234 $ git checkout -b speed-up-spinlocks v2.6.35
2235 -------------------------------------------------
2237 Now you apply the patch(es), run some tests, and commit the change(s).  If
2238 the patch is a multi-part series, then you should apply each as a separate
2239 commit to this branch.
2241 -------------------------------------------------
2242 $ ... patch ... test  ... commit [ ... patch ... test ... commit ]*
2243 -------------------------------------------------
2245 When you are happy with the state of this change, you can pull it into the
2246 "test" branch in preparation to make it public:
2248 -------------------------------------------------
2249 $ git checkout test && git pull . speed-up-spinlocks
2250 -------------------------------------------------
2252 It is unlikely that you would have any conflicts here ... but you might if you
2253 spent a while on this step and had also pulled new versions from upstream.
2255 Some time later when enough time has passed and testing done, you can pull the
2256 same branch into the "release" tree ready to go upstream.  This is where you
2257 see the value of keeping each patch (or patch series) in its own branch.  It
2258 means that the patches can be moved into the "release" tree in any order.
2260 -------------------------------------------------
2261 $ git checkout release && git pull . speed-up-spinlocks
2262 -------------------------------------------------
2264 After a while, you will have a number of branches, and despite the
2265 well chosen names you picked for each of them, you may forget what
2266 they are for, or what status they are in.  To get a reminder of what
2267 changes are in a specific branch, use:
2269 -------------------------------------------------
2270 $ git log linux..branchname | git shortlog
2271 -------------------------------------------------
2273 To see whether it has already been merged into the test or release branches,
2274 use:
2276 -------------------------------------------------
2277 $ git log test..branchname
2278 -------------------------------------------------
2282 -------------------------------------------------
2283 $ git log release..branchname
2284 -------------------------------------------------
2286 (If this branch has not yet been merged, you will see some log entries.
2287 If it has been merged, then there will be no output.)
2289 Once a patch completes the great cycle (moving from test to release,
2290 then pulled by Linus, and finally coming back into your local
2291 "origin/master" branch), the branch for this change is no longer needed.
2292 You detect this when the output from:
2294 -------------------------------------------------
2295 $ git log origin..branchname
2296 -------------------------------------------------
2298 is empty.  At this point the branch can be deleted:
2300 -------------------------------------------------
2301 $ git branch -d branchname
2302 -------------------------------------------------
2304 Some changes are so trivial that it is not necessary to create a separate
2305 branch and then merge into each of the test and release branches.  For
2306 these changes, just apply directly to the "release" branch, and then
2307 merge that into the "test" branch.
2309 To create diffstat and shortlog summaries of changes to include in a "please
2310 pull" request to Linus you can use:
2312 -------------------------------------------------
2313 $ git diff --stat origin..release
2314 -------------------------------------------------
2318 -------------------------------------------------
2319 $ git log -p origin..release | git shortlog
2320 -------------------------------------------------
2322 Here are some of the scripts that simplify all this even further.
2324 -------------------------------------------------
2325 ==== update script ====
2326 # Update a branch in my GIT tree.  If the branch to be updated
2327 # is origin, then pull from kernel.org.  Otherwise merge
2328 # origin/master branch into test|release branch
2330 case "$1" in
2331 test|release)
2332         git checkout $1 && git pull . origin
2333         ;;
2334 origin)
2335         before=$(git rev-parse refs/remotes/origin/master)
2336         git fetch origin
2337         after=$(git rev-parse refs/remotes/origin/master)
2338         if [ $before != $after ]
2339         then
2340                 git log $before..$after | git shortlog
2341         fi
2342         ;;
2344         echo "Usage: $0 origin|test|release" 1>&2
2345         exit 1
2346         ;;
2347 esac
2348 -------------------------------------------------
2350 -------------------------------------------------
2351 ==== merge script ====
2352 # Merge a branch into either the test or release branch
2354 pname=$0
2356 usage()
2358         echo "Usage: $pname branch test|release" 1>&2
2359         exit 1
2362 git show-ref -q --verify -- refs/heads/"$1" || {
2363         echo "Can't see branch <$1>" 1>&2
2364         usage
2367 case "$2" in
2368 test|release)
2369         if [ $(git log $2..$1 | wc -c) -eq 0 ]
2370         then
2371                 echo $1 already merged into $2 1>&2
2372                 exit 1
2373         fi
2374         git checkout $2 && git pull . $1
2375         ;;
2377         usage
2378         ;;
2379 esac
2380 -------------------------------------------------
2382 -------------------------------------------------
2383 ==== status script ====
2384 # report on status of my ia64 GIT tree
2386 gb=$(tput setab 2)
2387 rb=$(tput setab 1)
2388 restore=$(tput setab 9)
2390 if [ `git rev-list test..release | wc -c` -gt 0 ]
2391 then
2392         echo $rb Warning: commits in release that are not in test $restore
2393         git log test..release
2396 for branch in `git show-ref --heads | sed 's|^.*/||'`
2398         if [ $branch = test -o $branch = release ]
2399         then
2400                 continue
2401         fi
2403         echo -n $gb ======= $branch ====== $restore " "
2404         status=
2405         for ref in test release origin/master
2406         do
2407                 if [ `git rev-list $ref..$branch | wc -c` -gt 0 ]
2408                 then
2409                         status=$status${ref:0:1}
2410                 fi
2411         done
2412         case $status in
2413         trl)
2414                 echo $rb Need to pull into test $restore
2415                 ;;
2416         rl)
2417                 echo "In test"
2418                 ;;
2419         l)
2420                 echo "Waiting for linus"
2421                 ;;
2422         "")
2423                 echo $rb All done $restore
2424                 ;;
2425         *)
2426                 echo $rb "<$status>" $restore
2427                 ;;
2428         esac
2429         git log origin/master..$branch | git shortlog
2430 done
2431 -------------------------------------------------
2434 [[cleaning-up-history]]
2435 Rewriting history and maintaining patch series
2436 ==============================================
2438 Normally commits are only added to a project, never taken away or
2439 replaced.  Git is designed with this assumption, and violating it will
2440 cause git's merge machinery (for example) to do the wrong thing.
2442 However, there is a situation in which it can be useful to violate this
2443 assumption.
2445 [[patch-series]]
2446 Creating the perfect patch series
2447 ---------------------------------
2449 Suppose you are a contributor to a large project, and you want to add a
2450 complicated feature, and to present it to the other developers in a way
2451 that makes it easy for them to read your changes, verify that they are
2452 correct, and understand why you made each change.
2454 If you present all of your changes as a single patch (or commit), they
2455 may find that it is too much to digest all at once.
2457 If you present them with the entire history of your work, complete with
2458 mistakes, corrections, and dead ends, they may be overwhelmed.
2460 So the ideal is usually to produce a series of patches such that:
2462         1. Each patch can be applied in order.
2464         2. Each patch includes a single logical change, together with a
2465            message explaining the change.
2467         3. No patch introduces a regression: after applying any initial
2468            part of the series, the resulting project still compiles and
2469            works, and has no bugs that it didn't have before.
2471         4. The complete series produces the same end result as your own
2472            (probably much messier!) development process did.
2474 We will introduce some tools that can help you do this, explain how to
2475 use them, and then explain some of the problems that can arise because
2476 you are rewriting history.
2478 [[using-git-rebase]]
2479 Keeping a patch series up to date using git rebase
2480 --------------------------------------------------
2482 Suppose that you create a branch "mywork" on a remote-tracking branch
2483 "origin", and create some commits on top of it:
2485 -------------------------------------------------
2486 $ git checkout -b mywork origin
2487 $ vi file.txt
2488 $ git commit
2489 $ vi otherfile.txt
2490 $ git commit
2492 -------------------------------------------------
2494 You have performed no merges into mywork, so it is just a simple linear
2495 sequence of patches on top of "origin":
2497 ................................................
2498  o--o--O <-- origin
2499         \
2500          a--b--c <-- mywork
2501 ................................................
2503 Some more interesting work has been done in the upstream project, and
2504 "origin" has advanced:
2506 ................................................
2507  o--o--O--o--o--o <-- origin
2508         \
2509          a--b--c <-- mywork
2510 ................................................
2512 At this point, you could use "pull" to merge your changes back in;
2513 the result would create a new merge commit, like this:
2515 ................................................
2516  o--o--O--o--o--o <-- origin
2517         \        \
2518          a--b--c--m <-- mywork
2519 ................................................
2521 However, if you prefer to keep the history in mywork a simple series of
2522 commits without any merges, you may instead choose to use
2523 linkgit:git-rebase[1]:
2525 -------------------------------------------------
2526 $ git checkout mywork
2527 $ git rebase origin
2528 -------------------------------------------------
2530 This will remove each of your commits from mywork, temporarily saving
2531 them as patches (in a directory named ".git/rebase-apply"), update mywork to
2532 point at the latest version of origin, then apply each of the saved
2533 patches to the new mywork.  The result will look like:
2536 ................................................
2537  o--o--O--o--o--o <-- origin
2538                  \
2539                   a'--b'--c' <-- mywork
2540 ................................................
2542 In the process, it may discover conflicts.  In that case it will stop
2543 and allow you to fix the conflicts; after fixing conflicts, use `git add`
2544 to update the index with those contents, and then, instead of
2545 running `git commit`, just run
2547 -------------------------------------------------
2548 $ git rebase --continue
2549 -------------------------------------------------
2551 and git will continue applying the rest of the patches.
2553 At any point you may use the `--abort` option to abort this process and
2554 return mywork to the state it had before you started the rebase:
2556 -------------------------------------------------
2557 $ git rebase --abort
2558 -------------------------------------------------
2560 [[rewriting-one-commit]]
2561 Rewriting a single commit
2562 -------------------------
2564 We saw in <<fixing-a-mistake-by-rewriting-history>> that you can replace the
2565 most recent commit using
2567 -------------------------------------------------
2568 $ git commit --amend
2569 -------------------------------------------------
2571 which will replace the old commit by a new commit incorporating your
2572 changes, giving you a chance to edit the old commit message first.
2574 You can also use a combination of this and linkgit:git-rebase[1] to
2575 replace a commit further back in your history and recreate the
2576 intervening changes on top of it.  First, tag the problematic commit
2577 with
2579 -------------------------------------------------
2580 $ git tag bad mywork~5
2581 -------------------------------------------------
2583 (Either gitk or `git log` may be useful for finding the commit.)
2585 Then check out that commit, edit it, and rebase the rest of the series
2586 on top of it (note that we could check out the commit on a temporary
2587 branch, but instead we're using a <<detached-head,detached head>>):
2589 -------------------------------------------------
2590 $ git checkout bad
2591 $ # make changes here and update the index
2592 $ git commit --amend
2593 $ git rebase --onto HEAD bad mywork
2594 -------------------------------------------------
2596 When you're done, you'll be left with mywork checked out, with the top
2597 patches on mywork reapplied on top of your modified commit.  You can
2598 then clean up with
2600 -------------------------------------------------
2601 $ git tag -d bad
2602 -------------------------------------------------
2604 Note that the immutable nature of git history means that you haven't really
2605 "modified" existing commits; instead, you have replaced the old commits with
2606 new commits having new object names.
2608 [[reordering-patch-series]]
2609 Reordering or selecting from a patch series
2610 -------------------------------------------
2612 Given one existing commit, the linkgit:git-cherry-pick[1] command
2613 allows you to apply the change introduced by that commit and create a
2614 new commit that records it.  So, for example, if "mywork" points to a
2615 series of patches on top of "origin", you might do something like:
2617 -------------------------------------------------
2618 $ git checkout -b mywork-new origin
2619 $ gitk origin..mywork &
2620 -------------------------------------------------
2622 and browse through the list of patches in the mywork branch using gitk,
2623 applying them (possibly in a different order) to mywork-new using
2624 cherry-pick, and possibly modifying them as you go using `git commit --amend`.
2625 The linkgit:git-gui[1] command may also help as it allows you to
2626 individually select diff hunks for inclusion in the index (by
2627 right-clicking on the diff hunk and choosing "Stage Hunk for Commit").
2629 Another technique is to use `git format-patch` to create a series of
2630 patches, then reset the state to before the patches:
2632 -------------------------------------------------
2633 $ git format-patch origin
2634 $ git reset --hard origin
2635 -------------------------------------------------
2637 Then modify, reorder, or eliminate patches as preferred before applying
2638 them again with linkgit:git-am[1].
2640 [[patch-series-tools]]
2641 Other tools
2642 -----------
2644 There are numerous other tools, such as StGit, which exist for the
2645 purpose of maintaining a patch series.  These are outside of the scope of
2646 this manual.
2648 [[problems-With-rewriting-history]]
2649 Problems with rewriting history
2650 -------------------------------
2652 The primary problem with rewriting the history of a branch has to do
2653 with merging.  Suppose somebody fetches your branch and merges it into
2654 their branch, with a result something like this:
2656 ................................................
2657  o--o--O--o--o--o <-- origin
2658         \        \
2659          t--t--t--m <-- their branch:
2660 ................................................
2662 Then suppose you modify the last three commits:
2664 ................................................
2665          o--o--o <-- new head of origin
2666         /
2667  o--o--O--o--o--o <-- old head of origin
2668 ................................................
2670 If we examined all this history together in one repository, it will
2671 look like:
2673 ................................................
2674          o--o--o <-- new head of origin
2675         /
2676  o--o--O--o--o--o <-- old head of origin
2677         \        \
2678          t--t--t--m <-- their branch:
2679 ................................................
2681 Git has no way of knowing that the new head is an updated version of
2682 the old head; it treats this situation exactly the same as it would if
2683 two developers had independently done the work on the old and new heads
2684 in parallel.  At this point, if someone attempts to merge the new head
2685 in to their branch, git will attempt to merge together the two (old and
2686 new) lines of development, instead of trying to replace the old by the
2687 new.  The results are likely to be unexpected.
2689 You may still choose to publish branches whose history is rewritten,
2690 and it may be useful for others to be able to fetch those branches in
2691 order to examine or test them, but they should not attempt to pull such
2692 branches into their own work.
2694 For true distributed development that supports proper merging,
2695 published branches should never be rewritten.
2697 [[bisect-merges]]
2698 Why bisecting merge commits can be harder than bisecting linear history
2699 -----------------------------------------------------------------------
2701 The linkgit:git-bisect[1] command correctly handles history that
2702 includes merge commits.  However, when the commit that it finds is a
2703 merge commit, the user may need to work harder than usual to figure out
2704 why that commit introduced a problem.
2706 Imagine this history:
2708 ................................................
2709       ---Z---o---X---...---o---A---C---D
2710           \                       /
2711            o---o---Y---...---o---B
2712 ................................................
2714 Suppose that on the upper line of development, the meaning of one
2715 of the functions that exists at Z is changed at commit X.  The
2716 commits from Z leading to A change both the function's
2717 implementation and all calling sites that exist at Z, as well
2718 as new calling sites they add, to be consistent.  There is no
2719 bug at A.
2721 Suppose that in the meantime on the lower line of development somebody
2722 adds a new calling site for that function at commit Y.  The
2723 commits from Z leading to B all assume the old semantics of that
2724 function and the callers and the callee are consistent with each
2725 other.  There is no bug at B, either.
2727 Suppose further that the two development lines merge cleanly at C,
2728 so no conflict resolution is required.
2730 Nevertheless, the code at C is broken, because the callers added
2731 on the lower line of development have not been converted to the new
2732 semantics introduced on the upper line of development.  So if all
2733 you know is that D is bad, that Z is good, and that
2734 linkgit:git-bisect[1] identifies C as the culprit, how will you
2735 figure out that the problem is due to this change in semantics?
2737 When the result of a `git bisect` is a non-merge commit, you should
2738 normally be able to discover the problem by examining just that commit.
2739 Developers can make this easy by breaking their changes into small
2740 self-contained commits.  That won't help in the case above, however,
2741 because the problem isn't obvious from examination of any single
2742 commit; instead, a global view of the development is required.  To
2743 make matters worse, the change in semantics in the problematic
2744 function may be just one small part of the changes in the upper
2745 line of development.
2747 On the other hand, if instead of merging at C you had rebased the
2748 history between Z to B on top of A, you would have gotten this
2749 linear history:
2751 ................................................................
2752     ---Z---o---X--...---o---A---o---o---Y*--...---o---B*--D*
2753 ................................................................
2755 Bisecting between Z and D* would hit a single culprit commit Y*,
2756 and understanding why Y* was broken would probably be easier.
2758 Partly for this reason, many experienced git users, even when
2759 working on an otherwise merge-heavy project, keep the history
2760 linear by rebasing against the latest upstream version before
2761 publishing.
2763 [[advanced-branch-management]]
2764 Advanced branch management
2765 ==========================
2767 [[fetching-individual-branches]]
2768 Fetching individual branches
2769 ----------------------------
2771 Instead of using linkgit:git-remote[1], you can also choose just
2772 to update one branch at a time, and to store it locally under an
2773 arbitrary name:
2775 -------------------------------------------------
2776 $ git fetch origin todo:my-todo-work
2777 -------------------------------------------------
2779 The first argument, "origin", just tells git to fetch from the
2780 repository you originally cloned from.  The second argument tells git
2781 to fetch the branch named "todo" from the remote repository, and to
2782 store it locally under the name refs/heads/my-todo-work.
2784 You can also fetch branches from other repositories; so
2786 -------------------------------------------------
2787 $ git fetch git://example.com/proj.git master:example-master
2788 -------------------------------------------------
2790 will create a new branch named "example-master" and store in it the
2791 branch named "master" from the repository at the given URL.  If you
2792 already have a branch named example-master, it will attempt to
2793 <<fast-forwards,fast-forward>> to the commit given by example.com's
2794 master branch.  In more detail:
2796 [[fetch-fast-forwards]]
2797 git fetch and fast-forwards
2798 ---------------------------
2800 In the previous example, when updating an existing branch, "git fetch"
2801 checks to make sure that the most recent commit on the remote
2802 branch is a descendant of the most recent commit on your copy of the
2803 branch before updating your copy of the branch to point at the new
2804 commit.  Git calls this process a <<fast-forwards,fast-forward>>.
2806 A fast-forward looks something like this:
2808 ................................................
2809  o--o--o--o <-- old head of the branch
2810            \
2811             o--o--o <-- new head of the branch
2812 ................................................
2815 In some cases it is possible that the new head will *not* actually be
2816 a descendant of the old head.  For example, the developer may have
2817 realized she made a serious mistake, and decided to backtrack,
2818 resulting in a situation like:
2820 ................................................
2821  o--o--o--o--a--b <-- old head of the branch
2822            \
2823             o--o--o <-- new head of the branch
2824 ................................................
2826 In this case, "git fetch" will fail, and print out a warning.
2828 In that case, you can still force git to update to the new head, as
2829 described in the following section.  However, note that in the
2830 situation above this may mean losing the commits labeled "a" and "b",
2831 unless you've already created a reference of your own pointing to
2832 them.
2834 [[forcing-fetch]]
2835 Forcing git fetch to do non-fast-forward updates
2836 ------------------------------------------------
2838 If git fetch fails because the new head of a branch is not a
2839 descendant of the old head, you may force the update with:
2841 -------------------------------------------------
2842 $ git fetch git://example.com/proj.git +master:refs/remotes/example/master
2843 -------------------------------------------------
2845 Note the addition of the "+" sign.  Alternatively, you can use the "-f"
2846 flag to force updates of all the fetched branches, as in:
2848 -------------------------------------------------
2849 $ git fetch -f origin
2850 -------------------------------------------------
2852 Be aware that commits that the old version of example/master pointed at
2853 may be lost, as we saw in the previous section.
2855 [[remote-branch-configuration]]
2856 Configuring remote-tracking branches
2857 ------------------------------------
2859 We saw above that "origin" is just a shortcut to refer to the
2860 repository that you originally cloned from.  This information is
2861 stored in git configuration variables, which you can see using
2862 linkgit:git-config[1]:
2864 -------------------------------------------------
2865 $ git config -l
2866 core.repositoryformatversion=0
2867 core.filemode=true
2868 core.logallrefupdates=true
2869 remote.origin.url=git://git.kernel.org/pub/scm/git/git.git
2870 remote.origin.fetch=+refs/heads/*:refs/remotes/origin/*
2871 branch.master.remote=origin
2872 branch.master.merge=refs/heads/master
2873 -------------------------------------------------
2875 If there are other repositories that you also use frequently, you can
2876 create similar configuration options to save typing; for example,
2878 -------------------------------------------------
2879 $ git remote add example git://example.com/proj.git
2880 -------------------------------------------------
2882 adds the following to `.git/config`:
2884 -------------------------------------------------
2885 [remote "example"]
2886         url = git://example.com/proj.git
2887         fetch = +refs/heads/*:refs/remotes/example/*
2888 -------------------------------------------------
2890 Also note that the above configuration can be performed by directly
2891 editing the file `.git/config` instead of using linkgit:git-remote[1].
2893 After configuring the remote, the following three commands will do the
2894 same thing:
2896 -------------------------------------------------
2897 $ git fetch git://example.com/proj.git +refs/heads/*:refs/remotes/example/*
2898 $ git fetch example +refs/heads/*:refs/remotes/example/*
2899 $ git fetch example
2900 -------------------------------------------------
2902 See linkgit:git-config[1] for more details on the configuration
2903 options mentioned above and linkgit:git-fetch[1] for more details on
2904 the refspec syntax.
2907 [[git-concepts]]
2908 Git concepts
2909 ============
2911 Git is built on a small number of simple but powerful ideas.  While it
2912 is possible to get things done without understanding them, you will find
2913 git much more intuitive if you do.
2915 We start with the most important, the  <<def_object_database,object
2916 database>> and the <<def_index,index>>.
2918 [[the-object-database]]
2919 The Object Database
2920 -------------------
2923 We already saw in <<understanding-commits>> that all commits are stored
2924 under a 40-digit "object name".  In fact, all the information needed to
2925 represent the history of a project is stored in objects with such names.
2926 In each case the name is calculated by taking the SHA-1 hash of the
2927 contents of the object.  The SHA-1 hash is a cryptographic hash function.
2928 What that means to us is that it is impossible to find two different
2929 objects with the same name.  This has a number of advantages; among
2930 others:
2932 - Git can quickly determine whether two objects are identical or not,
2933   just by comparing names.
2934 - Since object names are computed the same way in every repository, the
2935   same content stored in two repositories will always be stored under
2936   the same name.
2937 - Git can detect errors when it reads an object, by checking that the
2938   object's name is still the SHA-1 hash of its contents.
2940 (See <<object-details>> for the details of the object formatting and
2941 SHA-1 calculation.)
2943 There are four different types of objects: "blob", "tree", "commit", and
2944 "tag".
2946 - A <<def_blob_object,"blob" object>> is used to store file data.
2947 - A <<def_tree_object,"tree" object>> ties one or more
2948   "blob" objects into a directory structure. In addition, a tree object
2949   can refer to other tree objects, thus creating a directory hierarchy.
2950 - A <<def_commit_object,"commit" object>> ties such directory hierarchies
2951   together into a <<def_DAG,directed acyclic graph>> of revisions--each
2952   commit contains the object name of exactly one tree designating the
2953   directory hierarchy at the time of the commit. In addition, a commit
2954   refers to "parent" commit objects that describe the history of how we
2955   arrived at that directory hierarchy.
2956 - A <<def_tag_object,"tag" object>> symbolically identifies and can be
2957   used to sign other objects. It contains the object name and type of
2958   another object, a symbolic name (of course!) and, optionally, a
2959   signature.
2961 The object types in some more detail:
2963 [[commit-object]]
2964 Commit Object
2965 ~~~~~~~~~~~~~
2967 The "commit" object links a physical state of a tree with a description
2968 of how we got there and why.  Use the --pretty=raw option to
2969 linkgit:git-show[1] or linkgit:git-log[1] to examine your favorite
2970 commit:
2972 ------------------------------------------------
2973 $ git show -s --pretty=raw 2be7fcb476
2974 commit 2be7fcb4764f2dbcee52635b91fedb1b3dcf7ab4
2975 tree fb3a8bdd0ceddd019615af4d57a53f43d8cee2bf
2976 parent 257a84d9d02e90447b149af58b271c19405edb6a
2977 author Dave Watson <dwatson@mimvista.com> 1187576872 -0400
2978 committer Junio C Hamano <gitster@pobox.com> 1187591163 -0700
2980     Fix misspelling of 'suppress' in docs
2982     Signed-off-by: Junio C Hamano <gitster@pobox.com>
2983 ------------------------------------------------
2985 As you can see, a commit is defined by:
2987 - a tree: The SHA-1 name of a tree object (as defined below), representing
2988   the contents of a directory at a certain point in time.
2989 - parent(s): The SHA-1 name(s) of some number of commits which represent the
2990   immediately previous step(s) in the history of the project.  The
2991   example above has one parent; merge commits may have more than
2992   one.  A commit with no parents is called a "root" commit, and
2993   represents the initial revision of a project.  Each project must have
2994   at least one root.  A project can also have multiple roots, though
2995   that isn't common (or necessarily a good idea).
2996 - an author: The name of the person responsible for this change, together
2997   with its date.
2998 - a committer: The name of the person who actually created the commit,
2999   with the date it was done.  This may be different from the author, for
3000   example, if the author was someone who wrote a patch and emailed it
3001   to the person who used it to create the commit.
3002 - a comment describing this commit.
3004 Note that a commit does not itself contain any information about what
3005 actually changed; all changes are calculated by comparing the contents
3006 of the tree referred to by this commit with the trees associated with
3007 its parents.  In particular, git does not attempt to record file renames
3008 explicitly, though it can identify cases where the existence of the same
3009 file data at changing paths suggests a rename.  (See, for example, the
3010 -M option to linkgit:git-diff[1]).
3012 A commit is usually created by linkgit:git-commit[1], which creates a
3013 commit whose parent is normally the current HEAD, and whose tree is
3014 taken from the content currently stored in the index.
3016 [[tree-object]]
3017 Tree Object
3018 ~~~~~~~~~~~
3020 The ever-versatile linkgit:git-show[1] command can also be used to
3021 examine tree objects, but linkgit:git-ls-tree[1] will give you more
3022 details:
3024 ------------------------------------------------
3025 $ git ls-tree fb3a8bdd0ce
3026 100644 blob 63c918c667fa005ff12ad89437f2fdc80926e21c    .gitignore
3027 100644 blob 5529b198e8d14decbe4ad99db3f7fb632de0439d    .mailmap
3028 100644 blob 6ff87c4664981e4397625791c8ea3bbb5f2279a3    COPYING
3029 040000 tree 2fb783e477100ce076f6bf57e4a6f026013dc745    Documentation
3030 100755 blob 3c0032cec592a765692234f1cba47dfdcc3a9200    GIT-VERSION-GEN
3031 100644 blob 289b046a443c0647624607d471289b2c7dcd470b    INSTALL
3032 100644 blob 4eb463797adc693dc168b926b6932ff53f17d0b1    Makefile
3033 100644 blob 548142c327a6790ff8821d67c2ee1eff7a656b52    README
3035 ------------------------------------------------
3037 As you can see, a tree object contains a list of entries, each with a
3038 mode, object type, SHA-1 name, and name, sorted by name.  It represents
3039 the contents of a single directory tree.
3041 The object type may be a blob, representing the contents of a file, or
3042 another tree, representing the contents of a subdirectory.  Since trees
3043 and blobs, like all other objects, are named by the SHA-1 hash of their
3044 contents, two trees have the same SHA-1 name if and only if their
3045 contents (including, recursively, the contents of all subdirectories)
3046 are identical.  This allows git to quickly determine the differences
3047 between two related tree objects, since it can ignore any entries with
3048 identical object names.
3050 (Note: in the presence of submodules, trees may also have commits as
3051 entries.  See <<submodules>> for documentation.)
3053 Note that the files all have mode 644 or 755: git actually only pays
3054 attention to the executable bit.
3056 [[blob-object]]
3057 Blob Object
3058 ~~~~~~~~~~~
3060 You can use linkgit:git-show[1] to examine the contents of a blob; take,
3061 for example, the blob in the entry for "COPYING" from the tree above:
3063 ------------------------------------------------
3064 $ git show 6ff87c4664
3066  Note that the only valid version of the GPL as far as this project
3067  is concerned is _this_ particular version of the license (ie v2, not
3068  v2.2 or v3.x or whatever), unless explicitly otherwise stated.
3070 ------------------------------------------------
3072 A "blob" object is nothing but a binary blob of data.  It doesn't refer
3073 to anything else or have attributes of any kind.
3075 Since the blob is entirely defined by its data, if two files in a
3076 directory tree (or in multiple different versions of the repository)
3077 have the same contents, they will share the same blob object. The object
3078 is totally independent of its location in the directory tree, and
3079 renaming a file does not change the object that file is associated with.
3081 Note that any tree or blob object can be examined using
3082 linkgit:git-show[1] with the <revision>:<path> syntax.  This can
3083 sometimes be useful for browsing the contents of a tree that is not
3084 currently checked out.
3086 [[trust]]
3087 Trust
3088 ~~~~~
3090 If you receive the SHA-1 name of a blob from one source, and its contents
3091 from another (possibly untrusted) source, you can still trust that those
3092 contents are correct as long as the SHA-1 name agrees.  This is because
3093 the SHA-1 is designed so that it is infeasible to find different contents
3094 that produce the same hash.
3096 Similarly, you need only trust the SHA-1 name of a top-level tree object
3097 to trust the contents of the entire directory that it refers to, and if
3098 you receive the SHA-1 name of a commit from a trusted source, then you
3099 can easily verify the entire history of commits reachable through
3100 parents of that commit, and all of those contents of the trees referred
3101 to by those commits.
3103 So to introduce some real trust in the system, the only thing you need
3104 to do is to digitally sign just 'one' special note, which includes the
3105 name of a top-level commit.  Your digital signature shows others
3106 that you trust that commit, and the immutability of the history of
3107 commits tells others that they can trust the whole history.
3109 In other words, you can easily validate a whole archive by just
3110 sending out a single email that tells the people the name (SHA-1 hash)
3111 of the top commit, and digitally sign that email using something
3112 like GPG/PGP.
3114 To assist in this, git also provides the tag object...
3116 [[tag-object]]
3117 Tag Object
3118 ~~~~~~~~~~
3120 A tag object contains an object, object type, tag name, the name of the
3121 person ("tagger") who created the tag, and a message, which may contain
3122 a signature, as can be seen using linkgit:git-cat-file[1]:
3124 ------------------------------------------------
3125 $ git cat-file tag v1.5.0
3126 object 437b1b20df4b356c9342dac8d38849f24ef44f27
3127 type commit
3128 tag v1.5.0
3129 tagger Junio C Hamano <junkio@cox.net> 1171411200 +0000
3131 GIT 1.5.0
3132 -----BEGIN PGP SIGNATURE-----
3133 Version: GnuPG v1.4.6 (GNU/Linux)
3135 iD8DBQBF0lGqwMbZpPMRm5oRAuRiAJ9ohBLd7s2kqjkKlq1qqC57SbnmzQCdG4ui
3136 nLE/L9aUXdWeTFPron96DLA=
3137 =2E+0
3138 -----END PGP SIGNATURE-----
3139 ------------------------------------------------
3141 See the linkgit:git-tag[1] command to learn how to create and verify tag
3142 objects.  (Note that linkgit:git-tag[1] can also be used to create
3143 "lightweight tags", which are not tag objects at all, but just simple
3144 references whose names begin with "refs/tags/").
3146 [[pack-files]]
3147 How git stores objects efficiently: pack files
3148 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3150 Newly created objects are initially created in a file named after the
3151 object's SHA-1 hash (stored in .git/objects).
3153 Unfortunately this system becomes inefficient once a project has a
3154 lot of objects.  Try this on an old project:
3156 ------------------------------------------------
3157 $ git count-objects
3158 6930 objects, 47620 kilobytes
3159 ------------------------------------------------
3161 The first number is the number of objects which are kept in
3162 individual files.  The second is the amount of space taken up by
3163 those "loose" objects.
3165 You can save space and make git faster by moving these loose objects in
3166 to a "pack file", which stores a group of objects in an efficient
3167 compressed format; the details of how pack files are formatted can be
3168 found in link:technical/pack-format.txt[technical/pack-format.txt].
3170 To put the loose objects into a pack, just run git repack:
3172 ------------------------------------------------
3173 $ git repack
3174 Generating pack...
3175 Done counting 6020 objects.
3176 Deltifying 6020 objects.
3177  100% (6020/6020) done
3178 Writing 6020 objects.
3179  100% (6020/6020) done
3180 Total 6020, written 6020 (delta 4070), reused 0 (delta 0)
3181 Pack pack-3e54ad29d5b2e05838c75df582c65257b8d08e1c created.
3182 ------------------------------------------------
3184 You can then run
3186 ------------------------------------------------
3187 $ git prune
3188 ------------------------------------------------
3190 to remove any of the "loose" objects that are now contained in the
3191 pack.  This will also remove any unreferenced objects (which may be
3192 created when, for example, you use "git reset" to remove a commit).
3193 You can verify that the loose objects are gone by looking at the
3194 .git/objects directory or by running
3196 ------------------------------------------------
3197 $ git count-objects
3198 0 objects, 0 kilobytes
3199 ------------------------------------------------
3201 Although the object files are gone, any commands that refer to those
3202 objects will work exactly as they did before.
3204 The linkgit:git-gc[1] command performs packing, pruning, and more for
3205 you, so is normally the only high-level command you need.
3207 [[dangling-objects]]
3208 Dangling objects
3209 ~~~~~~~~~~~~~~~~
3211 The linkgit:git-fsck[1] command will sometimes complain about dangling
3212 objects.  They are not a problem.
3214 The most common cause of dangling objects is that you've rebased a
3215 branch, or you have pulled from somebody else who rebased a branch--see
3216 <<cleaning-up-history>>.  In that case, the old head of the original
3217 branch still exists, as does everything it pointed to. The branch
3218 pointer itself just doesn't, since you replaced it with another one.
3220 There are also other situations that cause dangling objects. For
3221 example, a "dangling blob" may arise because you did a "git add" of a
3222 file, but then, before you actually committed it and made it part of the
3223 bigger picture, you changed something else in that file and committed
3224 that *updated* thing--the old state that you added originally ends up
3225 not being pointed to by any commit or tree, so it's now a dangling blob
3226 object.
3228 Similarly, when the "recursive" merge strategy runs, and finds that
3229 there are criss-cross merges and thus more than one merge base (which is
3230 fairly unusual, but it does happen), it will generate one temporary
3231 midway tree (or possibly even more, if you had lots of criss-crossing
3232 merges and more than two merge bases) as a temporary internal merge
3233 base, and again, those are real objects, but the end result will not end
3234 up pointing to them, so they end up "dangling" in your repository.
3236 Generally, dangling objects aren't anything to worry about. They can
3237 even be very useful: if you screw something up, the dangling objects can
3238 be how you recover your old tree (say, you did a rebase, and realized
3239 that you really didn't want to--you can look at what dangling objects
3240 you have, and decide to reset your head to some old dangling state).
3242 For commits, you can just use:
3244 ------------------------------------------------
3245 $ gitk <dangling-commit-sha-goes-here> --not --all
3246 ------------------------------------------------
3248 This asks for all the history reachable from the given commit but not
3249 from any branch, tag, or other reference.  If you decide it's something
3250 you want, you can always create a new reference to it, e.g.,
3252 ------------------------------------------------
3253 $ git branch recovered-branch <dangling-commit-sha-goes-here>
3254 ------------------------------------------------
3256 For blobs and trees, you can't do the same, but you can still examine
3257 them.  You can just do
3259 ------------------------------------------------
3260 $ git show <dangling-blob/tree-sha-goes-here>
3261 ------------------------------------------------
3263 to show what the contents of the blob were (or, for a tree, basically
3264 what the "ls" for that directory was), and that may give you some idea
3265 of what the operation was that left that dangling object.
3267 Usually, dangling blobs and trees aren't very interesting. They're
3268 almost always the result of either being a half-way mergebase (the blob
3269 will often even have the conflict markers from a merge in it, if you
3270 have had conflicting merges that you fixed up by hand), or simply
3271 because you interrupted a "git fetch" with ^C or something like that,
3272 leaving _some_ of the new objects in the object database, but just
3273 dangling and useless.
3275 Anyway, once you are sure that you're not interested in any dangling
3276 state, you can just prune all unreachable objects:
3278 ------------------------------------------------
3279 $ git prune
3280 ------------------------------------------------
3282 and they'll be gone. But you should only run "git prune" on a quiescent
3283 repository--it's kind of like doing a filesystem fsck recovery: you
3284 don't want to do that while the filesystem is mounted.
3286 (The same is true of "git fsck" itself, btw, but since
3287 `git fsck` never actually *changes* the repository, it just reports
3288 on what it found, `git fsck` itself is never 'dangerous' to run.
3289 Running it while somebody is actually changing the repository can cause
3290 confusing and scary messages, but it won't actually do anything bad. In
3291 contrast, running "git prune" while somebody is actively changing the
3292 repository is a *BAD* idea).
3294 [[recovering-from-repository-corruption]]
3295 Recovering from repository corruption
3296 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3298 By design, git treats data trusted to it with caution.  However, even in
3299 the absence of bugs in git itself, it is still possible that hardware or
3300 operating system errors could corrupt data.
3302 The first defense against such problems is backups.  You can back up a
3303 git directory using clone, or just using cp, tar, or any other backup
3304 mechanism.
3306 As a last resort, you can search for the corrupted objects and attempt
3307 to replace them by hand.  Back up your repository before attempting this
3308 in case you corrupt things even more in the process.
3310 We'll assume that the problem is a single missing or corrupted blob,
3311 which is sometimes a solvable problem.  (Recovering missing trees and
3312 especially commits is *much* harder).
3314 Before starting, verify that there is corruption, and figure out where
3315 it is with linkgit:git-fsck[1]; this may be time-consuming.
3317 Assume the output looks like this:
3319 ------------------------------------------------
3320 $ git fsck --full --no-dangling
3321 broken link from    tree 2d9263c6d23595e7cb2a21e5ebbb53655278dff8
3322               to    blob 4b9458b3786228369c63936db65827de3cc06200
3323 missing blob 4b9458b3786228369c63936db65827de3cc06200
3324 ------------------------------------------------
3326 Now you know that blob 4b9458b3 is missing, and that the tree 2d9263c6
3327 points to it.  If you could find just one copy of that missing blob
3328 object, possibly in some other repository, you could move it into
3329 .git/objects/4b/9458b3... and be done.  Suppose you can't.  You can
3330 still examine the tree that pointed to it with linkgit:git-ls-tree[1],
3331 which might output something like:
3333 ------------------------------------------------
3334 $ git ls-tree 2d9263c6d23595e7cb2a21e5ebbb53655278dff8
3335 100644 blob 8d14531846b95bfa3564b58ccfb7913a034323b8    .gitignore
3336 100644 blob ebf9bf84da0aab5ed944264a5db2a65fe3a3e883    .mailmap
3337 100644 blob ca442d313d86dc67e0a2e5d584b465bd382cbf5c    COPYING
3339 100644 blob 4b9458b3786228369c63936db65827de3cc06200    myfile
3341 ------------------------------------------------
3343 So now you know that the missing blob was the data for a file named
3344 "myfile".  And chances are you can also identify the directory--let's
3345 say it's in "somedirectory".  If you're lucky the missing copy might be
3346 the same as the copy you have checked out in your working tree at
3347 "somedirectory/myfile"; you can test whether that's right with
3348 linkgit:git-hash-object[1]:
3350 ------------------------------------------------
3351 $ git hash-object -w somedirectory/myfile
3352 ------------------------------------------------
3354 which will create and store a blob object with the contents of
3355 somedirectory/myfile, and output the SHA-1 of that object.  if you're
3356 extremely lucky it might be 4b9458b3786228369c63936db65827de3cc06200, in
3357 which case you've guessed right, and the corruption is fixed!
3359 Otherwise, you need more information.  How do you tell which version of
3360 the file has been lost?
3362 The easiest way to do this is with:
3364 ------------------------------------------------
3365 $ git log --raw --all --full-history -- somedirectory/myfile
3366 ------------------------------------------------
3368 Because you're asking for raw output, you'll now get something like
3370 ------------------------------------------------
3371 commit abc
3372 Author:
3373 Date:
3375 :100644 100644 4b9458b... newsha... M somedirectory/myfile
3378 commit xyz
3379 Author:
3380 Date:
3383 :100644 100644 oldsha... 4b9458b... M somedirectory/myfile
3384 ------------------------------------------------
3386 This tells you that the immediately following version of the file was
3387 "newsha", and that the immediately preceding version was "oldsha".
3388 You also know the commit messages that went with the change from oldsha
3389 to 4b9458b and with the change from 4b9458b to newsha.
3391 If you've been committing small enough changes, you may now have a good
3392 shot at reconstructing the contents of the in-between state 4b9458b.
3394 If you can do that, you can now recreate the missing object with
3396 ------------------------------------------------
3397 $ git hash-object -w <recreated-file>
3398 ------------------------------------------------
3400 and your repository is good again!
3402 (Btw, you could have ignored the fsck, and started with doing a
3404 ------------------------------------------------
3405 $ git log --raw --all
3406 ------------------------------------------------
3408 and just looked for the sha of the missing object (4b9458b..) in that
3409 whole thing. It's up to you--Git does *have* a lot of information, it is
3410 just missing one particular blob version.
3412 [[the-index]]
3413 The index
3414 -----------
3416 The index is a binary file (generally kept in .git/index) containing a
3417 sorted list of path names, each with permissions and the SHA-1 of a blob
3418 object; linkgit:git-ls-files[1] can show you the contents of the index:
3420 -------------------------------------------------
3421 $ git ls-files --stage
3422 100644 63c918c667fa005ff12ad89437f2fdc80926e21c 0       .gitignore
3423 100644 5529b198e8d14decbe4ad99db3f7fb632de0439d 0       .mailmap
3424 100644 6ff87c4664981e4397625791c8ea3bbb5f2279a3 0       COPYING
3425 100644 a37b2152bd26be2c2289e1f57a292534a51a93c7 0       Documentation/.gitignore
3426 100644 fbefe9a45b00a54b58d94d06eca48b03d40a50e0 0       Documentation/Makefile
3428 100644 2511aef8d89ab52be5ec6a5e46236b4b6bcd07ea 0       xdiff/xtypes.h
3429 100644 2ade97b2574a9f77e7ae4002a4e07a6a38e46d07 0       xdiff/xutils.c
3430 100644 d5de8292e05e7c36c4b68857c1cf9855e3d2f70a 0       xdiff/xutils.h
3431 -------------------------------------------------
3433 Note that in older documentation you may see the index called the
3434 "current directory cache" or just the "cache".  It has three important
3435 properties:
3437 1. The index contains all the information necessary to generate a single
3438 (uniquely determined) tree object.
3440 For example, running linkgit:git-commit[1] generates this tree object
3441 from the index, stores it in the object database, and uses it as the
3442 tree object associated with the new commit.
3444 2. The index enables fast comparisons between the tree object it defines
3445 and the working tree.
3447 It does this by storing some additional data for each entry (such as
3448 the last modified time).  This data is not displayed above, and is not
3449 stored in the created tree object, but it can be used to determine
3450 quickly which files in the working directory differ from what was
3451 stored in the index, and thus save git from having to read all of the
3452 data from such files to look for changes.
3454 3. It can efficiently represent information about merge conflicts
3455 between different tree objects, allowing each pathname to be
3456 associated with sufficient information about the trees involved that
3457 you can create a three-way merge between them.
3459 We saw in <<conflict-resolution>> that during a merge the index can
3460 store multiple versions of a single file (called "stages").  The third
3461 column in the linkgit:git-ls-files[1] output above is the stage
3462 number, and will take on values other than 0 for files with merge
3463 conflicts.
3465 The index is thus a sort of temporary staging area, which is filled with
3466 a tree which you are in the process of working on.
3468 If you blow the index away entirely, you generally haven't lost any
3469 information as long as you have the name of the tree that it described.
3471 [[submodules]]
3472 Submodules
3473 ==========
3475 Large projects are often composed of smaller, self-contained modules.  For
3476 example, an embedded Linux distribution's source tree would include every
3477 piece of software in the distribution with some local modifications; a movie
3478 player might need to build against a specific, known-working version of a
3479 decompression library; several independent programs might all share the same
3480 build scripts.
3482 With centralized revision control systems this is often accomplished by
3483 including every module in one single repository.  Developers can check out
3484 all modules or only the modules they need to work with.  They can even modify
3485 files across several modules in a single commit while moving things around
3486 or updating APIs and translations.
3488 Git does not allow partial checkouts, so duplicating this approach in Git
3489 would force developers to keep a local copy of modules they are not
3490 interested in touching.  Commits in an enormous checkout would be slower
3491 than you'd expect as Git would have to scan every directory for changes.
3492 If modules have a lot of local history, clones would take forever.
3494 On the plus side, distributed revision control systems can much better
3495 integrate with external sources.  In a centralized model, a single arbitrary
3496 snapshot of the external project is exported from its own revision control
3497 and then imported into the local revision control on a vendor branch.  All
3498 the history is hidden.  With distributed revision control you can clone the
3499 entire external history and much more easily follow development and re-merge
3500 local changes.
3502 Git's submodule support allows a repository to contain, as a subdirectory, a
3503 checkout of an external project.  Submodules maintain their own identity;
3504 the submodule support just stores the submodule repository location and
3505 commit ID, so other developers who clone the containing project
3506 ("superproject") can easily clone all the submodules at the same revision.
3507 Partial checkouts of the superproject are possible: you can tell Git to
3508 clone none, some or all of the submodules.
3510 The linkgit:git-submodule[1] command is available since Git 1.5.3.  Users
3511 with Git 1.5.2 can look up the submodule commits in the repository and
3512 manually check them out; earlier versions won't recognize the submodules at
3513 all.
3515 To see how submodule support works, create (for example) four example
3516 repositories that can be used later as a submodule:
3518 -------------------------------------------------
3519 $ mkdir ~/git
3520 $ cd ~/git
3521 $ for i in a b c d
3523         mkdir $i
3524         cd $i
3525         git init
3526         echo "module $i" > $i.txt
3527         git add $i.txt
3528         git commit -m "Initial commit, submodule $i"
3529         cd ..
3530 done
3531 -------------------------------------------------
3533 Now create the superproject and add all the submodules:
3535 -------------------------------------------------
3536 $ mkdir super
3537 $ cd super
3538 $ git init
3539 $ for i in a b c d
3541         git submodule add ~/git/$i $i
3542 done
3543 -------------------------------------------------
3545 NOTE: Do not use local URLs here if you plan to publish your superproject!
3547 See what files `git submodule` created:
3549 -------------------------------------------------
3550 $ ls -a
3551 .  ..  .git  .gitmodules  a  b  c  d
3552 -------------------------------------------------
3554 The `git submodule add <repo> <path>` command does a couple of things:
3556 - It clones the submodule from <repo> to the given <path> under the
3557   current directory and by default checks out the master branch.
3558 - It adds the submodule's clone path to the linkgit:gitmodules[5] file and
3559   adds this file to the index, ready to be committed.
3560 - It adds the submodule's current commit ID to the index, ready to be
3561   committed.
3563 Commit the superproject:
3565 -------------------------------------------------
3566 $ git commit -m "Add submodules a, b, c and d."
3567 -------------------------------------------------
3569 Now clone the superproject:
3571 -------------------------------------------------
3572 $ cd ..
3573 $ git clone super cloned
3574 $ cd cloned
3575 -------------------------------------------------
3577 The submodule directories are there, but they're empty:
3579 -------------------------------------------------
3580 $ ls -a a
3581 .  ..
3582 $ git submodule status
3583 -d266b9873ad50488163457f025db7cdd9683d88b a
3584 -e81d457da15309b4fef4249aba9b50187999670d b
3585 -c1536a972b9affea0f16e0680ba87332dc059146 c
3586 -d96249ff5d57de5de093e6baff9e0aafa5276a74 d
3587 -------------------------------------------------
3589 NOTE: The commit object names shown above would be different for you, but they
3590 should match the HEAD commit object names of your repositories.  You can check
3591 it by running `git ls-remote ../a`.
3593 Pulling down the submodules is a two-step process. First run `git submodule
3594 init` to add the submodule repository URLs to `.git/config`:
3596 -------------------------------------------------
3597 $ git submodule init
3598 -------------------------------------------------
3600 Now use `git submodule update` to clone the repositories and check out the
3601 commits specified in the superproject:
3603 -------------------------------------------------
3604 $ git submodule update
3605 $ cd a
3606 $ ls -a
3607 .  ..  .git  a.txt
3608 -------------------------------------------------
3610 One major difference between `git submodule update` and `git submodule add` is
3611 that `git submodule update` checks out a specific commit, rather than the tip
3612 of a branch. It's like checking out a tag: the head is detached, so you're not
3613 working on a branch.
3615 -------------------------------------------------
3616 $ git branch
3617 * (no branch)
3618   master
3619 -------------------------------------------------
3621 If you want to make a change within a submodule and you have a detached head,
3622 then you should create or checkout a branch, make your changes, publish the
3623 change within the submodule, and then update the superproject to reference the
3624 new commit:
3626 -------------------------------------------------
3627 $ git checkout master
3628 -------------------------------------------------
3632 -------------------------------------------------
3633 $ git checkout -b fix-up
3634 -------------------------------------------------
3636 then
3638 -------------------------------------------------
3639 $ echo "adding a line again" >> a.txt
3640 $ git commit -a -m "Updated the submodule from within the superproject."
3641 $ git push
3642 $ cd ..
3643 $ git diff
3644 diff --git a/a b/a
3645 index d266b98..261dfac 160000
3646 --- a/a
3647 +++ b/a
3648 @@ -1 +1 @@
3649 -Subproject commit d266b9873ad50488163457f025db7cdd9683d88b
3650 +Subproject commit 261dfac35cb99d380eb966e102c1197139f7fa24
3651 $ git add a
3652 $ git commit -m "Updated submodule a."
3653 $ git push
3654 -------------------------------------------------
3656 You have to run `git submodule update` after `git pull` if you want to update
3657 submodules, too.
3659 Pitfalls with submodules
3660 ------------------------
3662 Always publish the submodule change before publishing the change to the
3663 superproject that references it. If you forget to publish the submodule change,
3664 others won't be able to clone the repository:
3666 -------------------------------------------------
3667 $ cd ~/git/super/a
3668 $ echo i added another line to this file >> a.txt
3669 $ git commit -a -m "doing it wrong this time"
3670 $ cd ..
3671 $ git add a
3672 $ git commit -m "Updated submodule a again."
3673 $ git push
3674 $ cd ~/git/cloned
3675 $ git pull
3676 $ git submodule update
3677 error: pathspec '261dfac35cb99d380eb966e102c1197139f7fa24' did not match any file(s) known to git.
3678 Did you forget to 'git add'?
3679 Unable to checkout '261dfac35cb99d380eb966e102c1197139f7fa24' in submodule path 'a'
3680 -------------------------------------------------
3682 In older git versions it could be easily forgotten to commit new or modified
3683 files in a submodule, which silently leads to similar problems as not pushing
3684 the submodule changes. Starting with git 1.7.0 both "git status" and "git diff"
3685 in the superproject show submodules as modified when they contain new or
3686 modified files to protect against accidentally committing such a state. "git
3687 diff" will also add a "-dirty" to the work tree side when generating patch
3688 output or used with the --submodule option:
3690 -------------------------------------------------
3691 $ git diff
3692 diff --git a/sub b/sub
3693 --- a/sub
3694 +++ b/sub
3695 @@ -1 +1 @@
3696 -Subproject commit 3f356705649b5d566d97ff843cf193359229a453
3697 +Subproject commit 3f356705649b5d566d97ff843cf193359229a453-dirty
3698 $ git diff --submodule
3699 Submodule sub 3f35670..3f35670-dirty:
3700 -------------------------------------------------
3702 You also should not rewind branches in a submodule beyond commits that were
3703 ever recorded in any superproject.
3705 It's not safe to run `git submodule update` if you've made and committed
3706 changes within a submodule without checking out a branch first. They will be
3707 silently overwritten:
3709 -------------------------------------------------
3710 $ cat a.txt
3711 module a
3712 $ echo line added from private2 >> a.txt
3713 $ git commit -a -m "line added inside private2"
3714 $ cd ..
3715 $ git submodule update
3716 Submodule path 'a': checked out 'd266b9873ad50488163457f025db7cdd9683d88b'
3717 $ cd a
3718 $ cat a.txt
3719 module a
3720 -------------------------------------------------
3722 NOTE: The changes are still visible in the submodule's reflog.
3724 This is not the case if you did not commit your changes.
3726 [[low-level-operations]]
3727 Low-level git operations
3728 ========================
3730 Many of the higher-level commands were originally implemented as shell
3731 scripts using a smaller core of low-level git commands.  These can still
3732 be useful when doing unusual things with git, or just as a way to
3733 understand its inner workings.
3735 [[object-manipulation]]
3736 Object access and manipulation
3737 ------------------------------
3739 The linkgit:git-cat-file[1] command can show the contents of any object,
3740 though the higher-level linkgit:git-show[1] is usually more useful.
3742 The linkgit:git-commit-tree[1] command allows constructing commits with
3743 arbitrary parents and trees.
3745 A tree can be created with linkgit:git-write-tree[1] and its data can be
3746 accessed by linkgit:git-ls-tree[1].  Two trees can be compared with
3747 linkgit:git-diff-tree[1].
3749 A tag is created with linkgit:git-mktag[1], and the signature can be
3750 verified by linkgit:git-verify-tag[1], though it is normally simpler to
3751 use linkgit:git-tag[1] for both.
3753 [[the-workflow]]
3754 The Workflow
3755 ------------
3757 High-level operations such as linkgit:git-commit[1],
3758 linkgit:git-checkout[1] and linkgit:git-reset[1] work by moving data
3759 between the working tree, the index, and the object database.  Git
3760 provides low-level operations which perform each of these steps
3761 individually.
3763 Generally, all "git" operations work on the index file. Some operations
3764 work *purely* on the index file (showing the current state of the
3765 index), but most operations move data between the index file and either
3766 the database or the working directory. Thus there are four main
3767 combinations:
3769 [[working-directory-to-index]]
3770 working directory -> index
3771 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3773 The linkgit:git-update-index[1] command updates the index with
3774 information from the working directory.  You generally update the
3775 index information by just specifying the filename you want to update,
3776 like so:
3778 -------------------------------------------------
3779 $ git update-index filename
3780 -------------------------------------------------
3782 but to avoid common mistakes with filename globbing etc, the command
3783 will not normally add totally new entries or remove old entries,
3784 i.e. it will normally just update existing cache entries.
3786 To tell git that yes, you really do realize that certain files no
3787 longer exist, or that new files should be added, you
3788 should use the `--remove` and `--add` flags respectively.
3790 NOTE! A `--remove` flag does 'not' mean that subsequent filenames will
3791 necessarily be removed: if the files still exist in your directory
3792 structure, the index will be updated with their new status, not
3793 removed. The only thing `--remove` means is that update-index will be
3794 considering a removed file to be a valid thing, and if the file really
3795 does not exist any more, it will update the index accordingly.
3797 As a special case, you can also do `git update-index --refresh`, which
3798 will refresh the "stat" information of each index to match the current
3799 stat information. It will 'not' update the object status itself, and
3800 it will only update the fields that are used to quickly test whether
3801 an object still matches its old backing store object.
3803 The previously introduced linkgit:git-add[1] is just a wrapper for
3804 linkgit:git-update-index[1].
3806 [[index-to-object-database]]
3807 index -> object database
3808 ~~~~~~~~~~~~~~~~~~~~~~~~
3810 You write your current index file to a "tree" object with the program
3812 -------------------------------------------------
3813 $ git write-tree
3814 -------------------------------------------------
3816 that doesn't come with any options--it will just write out the
3817 current index into the set of tree objects that describe that state,
3818 and it will return the name of the resulting top-level tree. You can
3819 use that tree to re-generate the index at any time by going in the
3820 other direction:
3822 [[object-database-to-index]]
3823 object database -> index
3824 ~~~~~~~~~~~~~~~~~~~~~~~~
3826 You read a "tree" file from the object database, and use that to
3827 populate (and overwrite--don't do this if your index contains any
3828 unsaved state that you might want to restore later!) your current
3829 index.  Normal operation is just
3831 -------------------------------------------------
3832 $ git read-tree <SHA-1 of tree>
3833 -------------------------------------------------
3835 and your index file will now be equivalent to the tree that you saved
3836 earlier. However, that is only your 'index' file: your working
3837 directory contents have not been modified.
3839 [[index-to-working-directory]]
3840 index -> working directory
3841 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3843 You update your working directory from the index by "checking out"
3844 files. This is not a very common operation, since normally you'd just
3845 keep your files updated, and rather than write to your working
3846 directory, you'd tell the index files about the changes in your
3847 working directory (i.e. `git update-index`).
3849 However, if you decide to jump to a new version, or check out somebody
3850 else's version, or just restore a previous tree, you'd populate your
3851 index file with read-tree, and then you need to check out the result
3852 with
3854 -------------------------------------------------
3855 $ git checkout-index filename
3856 -------------------------------------------------
3858 or, if you want to check out all of the index, use `-a`.
3860 NOTE! `git checkout-index` normally refuses to overwrite old files, so
3861 if you have an old version of the tree already checked out, you will
3862 need to use the "-f" flag ('before' the "-a" flag or the filename) to
3863 'force' the checkout.
3866 Finally, there are a few odds and ends which are not purely moving
3867 from one representation to the other:
3869 [[tying-it-all-together]]
3870 Tying it all together
3871 ~~~~~~~~~~~~~~~~~~~~~
3873 To commit a tree you have instantiated with "git write-tree", you'd
3874 create a "commit" object that refers to that tree and the history
3875 behind it--most notably the "parent" commits that preceded it in
3876 history.
3878 Normally a "commit" has one parent: the previous state of the tree
3879 before a certain change was made. However, sometimes it can have two
3880 or more parent commits, in which case we call it a "merge", due to the
3881 fact that such a commit brings together ("merges") two or more
3882 previous states represented by other commits.
3884 In other words, while a "tree" represents a particular directory state
3885 of a working directory, a "commit" represents that state in "time",
3886 and explains how we got there.
3888 You create a commit object by giving it the tree that describes the
3889 state at the time of the commit, and a list of parents:
3891 -------------------------------------------------
3892 $ git commit-tree <tree> -p <parent> [(-p <parent2>)...]
3893 -------------------------------------------------
3895 and then giving the reason for the commit on stdin (either through
3896 redirection from a pipe or file, or by just typing it at the tty).
3898 `git commit-tree` will return the name of the object that represents
3899 that commit, and you should save it away for later use. Normally,
3900 you'd commit a new `HEAD` state, and while git doesn't care where you
3901 save the note about that state, in practice we tend to just write the
3902 result to the file pointed at by `.git/HEAD`, so that we can always see
3903 what the last committed state was.
3905 Here is an ASCII art by Jon Loeliger that illustrates how
3906 various pieces fit together.
3908 ------------
3910                      commit-tree
3911                       commit obj
3912                        +----+
3913                        |    |
3914                        |    |
3915                        V    V
3916                     +-----------+
3917                     | Object DB |
3918                     |  Backing  |
3919                     |   Store   |
3920                     +-----------+
3921                        ^
3922            write-tree  |     |
3923              tree obj  |     |
3924                        |     |  read-tree
3925                        |     |  tree obj
3926                              V
3927                     +-----------+
3928                     |   Index   |
3929                     |  "cache"  |
3930                     +-----------+
3931          update-index  ^
3932              blob obj  |     |
3933                        |     |
3934     checkout-index -u  |     |  checkout-index
3935              stat      |     |  blob obj
3936                              V
3937                     +-----------+
3938                     |  Working  |
3939                     | Directory |
3940                     +-----------+
3942 ------------
3945 [[examining-the-data]]
3946 Examining the data
3947 ------------------
3949 You can examine the data represented in the object database and the
3950 index with various helper tools. For every object, you can use
3951 linkgit:git-cat-file[1] to examine details about the
3952 object:
3954 -------------------------------------------------
3955 $ git cat-file -t <objectname>
3956 -------------------------------------------------
3958 shows the type of the object, and once you have the type (which is
3959 usually implicit in where you find the object), you can use
3961 -------------------------------------------------
3962 $ git cat-file blob|tree|commit|tag <objectname>
3963 -------------------------------------------------
3965 to show its contents. NOTE! Trees have binary content, and as a result
3966 there is a special helper for showing that content, called
3967 `git ls-tree`, which turns the binary content into a more easily
3968 readable form.
3970 It's especially instructive to look at "commit" objects, since those
3971 tend to be small and fairly self-explanatory. In particular, if you
3972 follow the convention of having the top commit name in `.git/HEAD`,
3973 you can do
3975 -------------------------------------------------
3976 $ git cat-file commit HEAD
3977 -------------------------------------------------
3979 to see what the top commit was.
3981 [[merging-multiple-trees]]
3982 Merging multiple trees
3983 ----------------------
3985 Git helps you do a three-way merge, which you can expand to n-way by
3986 repeating the merge procedure arbitrary times until you finally
3987 "commit" the state.  The normal situation is that you'd only do one
3988 three-way merge (two parents), and commit it, but if you like to, you
3989 can do multiple parents in one go.
3991 To do a three-way merge, you need the two sets of "commit" objects
3992 that you want to merge, use those to find the closest common parent (a
3993 third "commit" object), and then use those commit objects to find the
3994 state of the directory ("tree" object) at these points.
3996 To get the "base" for the merge, you first look up the common parent
3997 of two commits with
3999 -------------------------------------------------
4000 $ git merge-base <commit1> <commit2>
4001 -------------------------------------------------
4003 which will return you the commit they are both based on.  You should
4004 now look up the "tree" objects of those commits, which you can easily
4005 do with (for example)
4007 -------------------------------------------------
4008 $ git cat-file commit <commitname> | head -1
4009 -------------------------------------------------
4011 since the tree object information is always the first line in a commit
4012 object.
4014 Once you know the three trees you are going to merge (the one "original"
4015 tree, aka the common tree, and the two "result" trees, aka the branches
4016 you want to merge), you do a "merge" read into the index. This will
4017 complain if it has to throw away your old index contents, so you should
4018 make sure that you've committed those--in fact you would normally
4019 always do a merge against your last commit (which should thus match what
4020 you have in your current index anyway).
4022 To do the merge, do
4024 -------------------------------------------------
4025 $ git read-tree -m -u <origtree> <yourtree> <targettree>
4026 -------------------------------------------------
4028 which will do all trivial merge operations for you directly in the
4029 index file, and you can just write the result out with
4030 `git write-tree`.
4033 [[merging-multiple-trees-2]]
4034 Merging multiple trees, continued
4035 ---------------------------------
4037 Sadly, many merges aren't trivial. If there are files that have
4038 been added, moved or removed, or if both branches have modified the
4039 same file, you will be left with an index tree that contains "merge
4040 entries" in it. Such an index tree can 'NOT' be written out to a tree
4041 object, and you will have to resolve any such merge clashes using
4042 other tools before you can write out the result.
4044 You can examine such index state with `git ls-files --unmerged`
4045 command.  An example:
4047 ------------------------------------------------
4048 $ git read-tree -m $orig HEAD $target
4049 $ git ls-files --unmerged
4050 100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1       hello.c
4051 100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2       hello.c
4052 100644 cc44c73eb783565da5831b4d820c962954019b69 3       hello.c
4053 ------------------------------------------------
4055 Each line of the `git ls-files --unmerged` output begins with
4056 the blob mode bits, blob SHA-1, 'stage number', and the
4057 filename.  The 'stage number' is git's way to say which tree it
4058 came from: stage 1 corresponds to the `$orig` tree, stage 2 to
4059 the `HEAD` tree, and stage 3 to the `$target` tree.
4061 Earlier we said that trivial merges are done inside
4062 `git read-tree -m`.  For example, if the file did not change
4063 from `$orig` to `HEAD` nor `$target`, or if the file changed
4064 from `$orig` to `HEAD` and `$orig` to `$target` the same way,
4065 obviously the final outcome is what is in `HEAD`.  What the
4066 above example shows is that file `hello.c` was changed from
4067 `$orig` to `HEAD` and `$orig` to `$target` in a different way.
4068 You could resolve this by running your favorite 3-way merge
4069 program, e.g.  `diff3`, `merge`, or git's own merge-file, on
4070 the blob objects from these three stages yourself, like this:
4072 ------------------------------------------------
4073 $ git cat-file blob 263414f... >hello.c~1
4074 $ git cat-file blob 06fa6a2... >hello.c~2
4075 $ git cat-file blob cc44c73... >hello.c~3
4076 $ git merge-file hello.c~2 hello.c~1 hello.c~3
4077 ------------------------------------------------
4079 This would leave the merge result in `hello.c~2` file, along
4080 with conflict markers if there are conflicts.  After verifying
4081 the merge result makes sense, you can tell git what the final
4082 merge result for this file is by:
4084 -------------------------------------------------
4085 $ mv -f hello.c~2 hello.c
4086 $ git update-index hello.c
4087 -------------------------------------------------
4089 When a path is in the "unmerged" state, running `git update-index` for
4090 that path tells git to mark the path resolved.
4092 The above is the description of a git merge at the lowest level,
4093 to help you understand what conceptually happens under the hood.
4094 In practice, nobody, not even git itself, runs `git cat-file` three times
4095 for this.  There is a `git merge-index` program that extracts the
4096 stages to temporary files and calls a "merge" script on it:
4098 -------------------------------------------------
4099 $ git merge-index git-merge-one-file hello.c
4100 -------------------------------------------------
4102 and that is what higher level `git merge -s resolve` is implemented with.
4104 [[hacking-git]]
4105 Hacking git
4106 ===========
4108 This chapter covers internal details of the git implementation which
4109 probably only git developers need to understand.
4111 [[object-details]]
4112 Object storage format
4113 ---------------------
4115 All objects have a statically determined "type" which identifies the
4116 format of the object (i.e. how it is used, and how it can refer to other
4117 objects).  There are currently four different object types: "blob",
4118 "tree", "commit", and "tag".
4120 Regardless of object type, all objects share the following
4121 characteristics: they are all deflated with zlib, and have a header
4122 that not only specifies their type, but also provides size information
4123 about the data in the object.  It's worth noting that the SHA-1 hash
4124 that is used to name the object is the hash of the original data
4125 plus this header, so `sha1sum` 'file' does not match the object name
4126 for 'file'.
4127 (Historical note: in the dawn of the age of git the hash
4128 was the SHA-1 of the 'compressed' object.)
4130 As a result, the general consistency of an object can always be tested
4131 independently of the contents or the type of the object: all objects can
4132 be validated by verifying that (a) their hashes match the content of the
4133 file and (b) the object successfully inflates to a stream of bytes that
4134 forms a sequence of <ascii type without space> {plus} <space> {plus} <ascii decimal
4135 size> {plus} <byte\0> {plus} <binary object data>.
4137 The structured objects can further have their structure and
4138 connectivity to other objects verified. This is generally done with
4139 the `git fsck` program, which generates a full dependency graph
4140 of all objects, and verifies their internal consistency (in addition
4141 to just verifying their superficial consistency through the hash).
4143 [[birdview-on-the-source-code]]
4144 A birds-eye view of Git's source code
4145 -------------------------------------
4147 It is not always easy for new developers to find their way through Git's
4148 source code.  This section gives you a little guidance to show where to
4149 start.
4151 A good place to start is with the contents of the initial commit, with:
4153 ----------------------------------------------------
4154 $ git checkout e83c5163
4155 ----------------------------------------------------
4157 The initial revision lays the foundation for almost everything git has
4158 today, but is small enough to read in one sitting.
4160 Note that terminology has changed since that revision.  For example, the
4161 README in that revision uses the word "changeset" to describe what we
4162 now call a <<def_commit_object,commit>>.
4164 Also, we do not call it "cache" any more, but rather "index"; however, the
4165 file is still called `cache.h`.  Remark: Not much reason to change it now,
4166 especially since there is no good single name for it anyway, because it is
4167 basically _the_ header file which is included by _all_ of Git's C sources.
4169 If you grasp the ideas in that initial commit, you should check out a
4170 more recent version and skim `cache.h`, `object.h` and `commit.h`.
4172 In the early days, Git (in the tradition of UNIX) was a bunch of programs
4173 which were extremely simple, and which you used in scripts, piping the
4174 output of one into another. This turned out to be good for initial
4175 development, since it was easier to test new things.  However, recently
4176 many of these parts have become builtins, and some of the core has been
4177 "libified", i.e. put into libgit.a for performance, portability reasons,
4178 and to avoid code duplication.
4180 By now, you know what the index is (and find the corresponding data
4181 structures in `cache.h`), and that there are just a couple of object types
4182 (blobs, trees, commits and tags) which inherit their common structure from
4183 `struct object`, which is their first member (and thus, you can cast e.g.
4184 `(struct object *)commit` to achieve the _same_ as `&commit->object`, i.e.
4185 get at the object name and flags).
4187 Now is a good point to take a break to let this information sink in.
4189 Next step: get familiar with the object naming.  Read <<naming-commits>>.
4190 There are quite a few ways to name an object (and not only revisions!).
4191 All of these are handled in `sha1_name.c`. Just have a quick look at
4192 the function `get_sha1()`. A lot of the special handling is done by
4193 functions like `get_sha1_basic()` or the likes.
4195 This is just to get you into the groove for the most libified part of Git:
4196 the revision walker.
4198 Basically, the initial version of `git log` was a shell script:
4200 ----------------------------------------------------------------
4201 $ git-rev-list --pretty $(git-rev-parse --default HEAD "$@") | \
4202         LESS=-S ${PAGER:-less}
4203 ----------------------------------------------------------------
4205 What does this mean?
4207 `git rev-list` is the original version of the revision walker, which
4208 _always_ printed a list of revisions to stdout.  It is still functional,
4209 and needs to, since most new Git commands start out as scripts using
4210 `git rev-list`.
4212 `git rev-parse` is not as important any more; it was only used to filter out
4213 options that were relevant for the different plumbing commands that were
4214 called by the script.
4216 Most of what `git rev-list` did is contained in `revision.c` and
4217 `revision.h`.  It wraps the options in a struct named `rev_info`, which
4218 controls how and what revisions are walked, and more.
4220 The original job of `git rev-parse` is now taken by the function
4221 `setup_revisions()`, which parses the revisions and the common command line
4222 options for the revision walker. This information is stored in the struct
4223 `rev_info` for later consumption. You can do your own command line option
4224 parsing after calling `setup_revisions()`. After that, you have to call
4225 `prepare_revision_walk()` for initialization, and then you can get the
4226 commits one by one with the function `get_revision()`.
4228 If you are interested in more details of the revision walking process,
4229 just have a look at the first implementation of `cmd_log()`; call
4230 `git show v1.3.0~155^2~4` and scroll down to that function (note that you
4231 no longer need to call `setup_pager()` directly).
4233 Nowadays, `git log` is a builtin, which means that it is _contained_ in the
4234 command `git`.  The source side of a builtin is
4236 - a function called `cmd_<bla>`, typically defined in `builtin-<bla>.c`,
4237   and declared in `builtin.h`,
4239 - an entry in the `commands[]` array in `git.c`, and
4241 - an entry in `BUILTIN_OBJECTS` in the `Makefile`.
4243 Sometimes, more than one builtin is contained in one source file.  For
4244 example, `cmd_whatchanged()` and `cmd_log()` both reside in `builtin-log.c`,
4245 since they share quite a bit of code.  In that case, the commands which are
4246 _not_ named like the `.c` file in which they live have to be listed in
4247 `BUILT_INS` in the `Makefile`.
4249 `git log` looks more complicated in C than it does in the original script,
4250 but that allows for a much greater flexibility and performance.
4252 Here again it is a good point to take a pause.
4254 Lesson three is: study the code.  Really, it is the best way to learn about
4255 the organization of Git (after you know the basic concepts).
4257 So, think about something which you are interested in, say, "how can I
4258 access a blob just knowing the object name of it?".  The first step is to
4259 find a Git command with which you can do it.  In this example, it is either
4260 `git show` or `git cat-file`.
4262 For the sake of clarity, let's stay with `git cat-file`, because it
4264 - is plumbing, and
4266 - was around even in the initial commit (it literally went only through
4267   some 20 revisions as `cat-file.c`, was renamed to `builtin-cat-file.c`
4268   when made a builtin, and then saw less than 10 versions).
4270 So, look into `builtin-cat-file.c`, search for `cmd_cat_file()` and look what
4271 it does.
4273 ------------------------------------------------------------------
4274         git_config(git_default_config);
4275         if (argc != 3)
4276                 usage("git cat-file [-t|-s|-e|-p|<type>] <sha1>");
4277         if (get_sha1(argv[2], sha1))
4278                 die("Not a valid object name %s", argv[2]);
4279 ------------------------------------------------------------------
4281 Let's skip over the obvious details; the only really interesting part
4282 here is the call to `get_sha1()`.  It tries to interpret `argv[2]` as an
4283 object name, and if it refers to an object which is present in the current
4284 repository, it writes the resulting SHA-1 into the variable `sha1`.
4286 Two things are interesting here:
4288 - `get_sha1()` returns 0 on _success_.  This might surprise some new
4289   Git hackers, but there is a long tradition in UNIX to return different
4290   negative numbers in case of different errors--and 0 on success.
4292 - the variable `sha1` in the function signature of `get_sha1()` is `unsigned
4293   char *`, but is actually expected to be a pointer to `unsigned
4294   char[20]`.  This variable will contain the 160-bit SHA-1 of the given
4295   commit.  Note that whenever a SHA-1 is passed as `unsigned char *`, it
4296   is the binary representation, as opposed to the ASCII representation in
4297   hex characters, which is passed as `char *`.
4299 You will see both of these things throughout the code.
4301 Now, for the meat:
4303 -----------------------------------------------------------------------------
4304         case 0:
4305                 buf = read_object_with_reference(sha1, argv[1], &size, NULL);
4306 -----------------------------------------------------------------------------
4308 This is how you read a blob (actually, not only a blob, but any type of
4309 object).  To know how the function `read_object_with_reference()` actually
4310 works, find the source code for it (something like `git grep
4311 read_object_with | grep ":[a-z]"` in the git repository), and read
4312 the source.
4314 To find out how the result can be used, just read on in `cmd_cat_file()`:
4316 -----------------------------------
4317         write_or_die(1, buf, size);
4318 -----------------------------------
4320 Sometimes, you do not know where to look for a feature.  In many such cases,
4321 it helps to search through the output of `git log`, and then `git show` the
4322 corresponding commit.
4324 Example: If you know that there was some test case for `git bundle`, but
4325 do not remember where it was (yes, you _could_ `git grep bundle t/`, but that
4326 does not illustrate the point!):
4328 ------------------------
4329 $ git log --no-merges t/
4330 ------------------------
4332 In the pager (`less`), just search for "bundle", go a few lines back,
4333 and see that it is in commit 18449ab0...  Now just copy this object name,
4334 and paste it into the command line
4336 -------------------
4337 $ git show 18449ab0
4338 -------------------
4340 Voila.
4342 Another example: Find out what to do in order to make some script a
4343 builtin:
4345 -------------------------------------------------
4346 $ git log --no-merges --diff-filter=A builtin-*.c
4347 -------------------------------------------------
4349 You see, Git is actually the best tool to find out about the source of Git
4350 itself!
4352 [[glossary]]
4353 Git Glossary
4354 ============
4356 include::glossary-content.txt[]
4358 [[git-quick-start]]
4359 Appendix A: Git Quick Reference
4360 ===============================
4362 This is a quick summary of the major commands; the previous chapters
4363 explain how these work in more detail.
4365 [[quick-creating-a-new-repository]]
4366 Creating a new repository
4367 -------------------------
4369 From a tarball:
4371 -----------------------------------------------
4372 $ tar xzf project.tar.gz
4373 $ cd project
4374 $ git init
4375 Initialized empty Git repository in .git/
4376 $ git add .
4377 $ git commit
4378 -----------------------------------------------
4380 From a remote repository:
4382 -----------------------------------------------
4383 $ git clone git://example.com/pub/project.git
4384 $ cd project
4385 -----------------------------------------------
4387 [[managing-branches]]
4388 Managing branches
4389 -----------------
4391 -----------------------------------------------
4392 $ git branch         # list all local branches in this repo
4393 $ git checkout test  # switch working directory to branch "test"
4394 $ git branch new     # create branch "new" starting at current HEAD
4395 $ git branch -d new  # delete branch "new"
4396 -----------------------------------------------
4398 Instead of basing a new branch on current HEAD (the default), use:
4400 -----------------------------------------------
4401 $ git branch new test    # branch named "test"
4402 $ git branch new v2.6.15 # tag named v2.6.15
4403 $ git branch new HEAD^   # commit before the most recent
4404 $ git branch new HEAD^^  # commit before that
4405 $ git branch new test~10 # ten commits before tip of branch "test"
4406 -----------------------------------------------
4408 Create and switch to a new branch at the same time:
4410 -----------------------------------------------
4411 $ git checkout -b new v2.6.15
4412 -----------------------------------------------
4414 Update and examine branches from the repository you cloned from:
4416 -----------------------------------------------
4417 $ git fetch             # update
4418 $ git branch -r         # list
4419   origin/master
4420   origin/next
4421   ...
4422 $ git checkout -b masterwork origin/master