.gitignore: "git-verify-commit" is a generated file
[git.git] / Documentation / user-manual.txt
blob7330d880f373fcb067c1dec954ddd60cda370c5d
1 Git User Manual
2 ===============
4 Git is a fast distributed revision control system.
6 This manual is designed to be readable by someone with basic UNIX
7 command-line skills, but no previous knowledge of Git.
9 <<repositories-and-branches>> and <<exploring-git-history>> explain how
10 to fetch and study a project using git--read these chapters to learn how
11 to build and test a particular version of a software project, search for
12 regressions, and so on.
14 People needing to do actual development will also want to read
15 <<Developing-With-git>> and <<sharing-development>>.
17 Further chapters cover more specialized topics.
19 Comprehensive reference documentation is available through the man
20 pages, or linkgit:git-help[1] command.  For example, for the command
21 `git clone <repo>`, you can either use:
23 ------------------------------------------------
24 $ man git-clone
25 ------------------------------------------------
27 or:
29 ------------------------------------------------
30 $ git help clone
31 ------------------------------------------------
33 With the latter, you can use the manual viewer of your choice; see
34 linkgit:git-help[1] for more information.
36 See also <<git-quick-start>> for a brief overview of Git commands,
37 without any explanation.
39 Finally, see <<todo>> for ways that you can help make this manual more
40 complete.
43 [[repositories-and-branches]]
44 Repositories and Branches
45 =========================
47 [[how-to-get-a-git-repository]]
48 How to get a Git repository
49 ---------------------------
51 It will be useful to have a Git repository to experiment with as you
52 read this manual.
54 The best way to get one is by using the linkgit:git-clone[1] command to
55 download a copy of an existing repository.  If you don't already have a
56 project in mind, here are some interesting examples:
58 ------------------------------------------------
59         # Git itself (approx. 40MB download):
60 $ git clone git://git.kernel.org/pub/scm/git/git.git
61         # the Linux kernel (approx. 640MB download):
62 $ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
63 ------------------------------------------------
65 The initial clone may be time-consuming for a large project, but you
66 will only need to clone once.
68 The clone command creates a new directory named after the project
69 (`git` or `linux` in the examples above).  After you cd into this
70 directory, you will see that it contains a copy of the project files,
71 called the <<def_working_tree,working tree>>, together with a special
72 top-level directory named `.git`, which contains all the information
73 about the history of the project.
75 [[how-to-check-out]]
76 How to check out a different version of a project
77 -------------------------------------------------
79 Git is best thought of as a tool for storing the history of a collection
80 of files.  It stores the history as a compressed collection of
81 interrelated snapshots of the project's contents.  In Git each such
82 version is called a <<def_commit,commit>>.
84 Those snapshots aren't necessarily all arranged in a single line from
85 oldest to newest; instead, work may simultaneously proceed along
86 parallel lines of development, called <<def_branch,branches>>, which may
87 merge and diverge.
89 A single Git repository can track development on multiple branches.  It
90 does this by keeping a list of <<def_head,heads>> which reference the
91 latest commit on each branch; the linkgit:git-branch[1] command shows
92 you the list of branch heads:
94 ------------------------------------------------
95 $ git branch
96 * master
97 ------------------------------------------------
99 A freshly cloned repository contains a single branch head, by default
100 named "master", with the working directory initialized to the state of
101 the project referred to by that branch head.
103 Most projects also use <<def_tag,tags>>.  Tags, like heads, are
104 references into the project's history, and can be listed using the
105 linkgit:git-tag[1] command:
107 ------------------------------------------------
108 $ git tag -l
109 v2.6.11
110 v2.6.11-tree
111 v2.6.12
112 v2.6.12-rc2
113 v2.6.12-rc3
114 v2.6.12-rc4
115 v2.6.12-rc5
116 v2.6.12-rc6
117 v2.6.13
119 ------------------------------------------------
121 Tags are expected to always point at the same version of a project,
122 while heads are expected to advance as development progresses.
124 Create a new branch head pointing to one of these versions and check it
125 out using linkgit:git-checkout[1]:
127 ------------------------------------------------
128 $ git checkout -b new v2.6.13
129 ------------------------------------------------
131 The working directory then reflects the contents that the project had
132 when it was tagged v2.6.13, and linkgit:git-branch[1] shows two
133 branches, with an asterisk marking the currently checked-out branch:
135 ------------------------------------------------
136 $ git branch
137   master
138 * new
139 ------------------------------------------------
141 If you decide that you'd rather see version 2.6.17, you can modify
142 the current branch to point at v2.6.17 instead, with
144 ------------------------------------------------
145 $ git reset --hard v2.6.17
146 ------------------------------------------------
148 Note that if the current branch head was your only reference to a
149 particular point in history, then resetting that branch may leave you
150 with no way to find the history it used to point to; so use this command
151 carefully.
153 [[understanding-commits]]
154 Understanding History: Commits
155 ------------------------------
157 Every change in the history of a project is represented by a commit.
158 The linkgit:git-show[1] command shows the most recent commit on the
159 current branch:
161 ------------------------------------------------
162 $ git show
163 commit 17cf781661e6d38f737f15f53ab552f1e95960d7
164 Author: Linus Torvalds <torvalds@ppc970.osdl.org.(none)>
165 Date:   Tue Apr 19 14:11:06 2005 -0700
167     Remove duplicate getenv(DB_ENVIRONMENT) call
169     Noted by Tony Luck.
171 diff --git a/init-db.c b/init-db.c
172 index 65898fa..b002dc6 100644
173 --- a/init-db.c
174 +++ b/init-db.c
175 @@ -7,7 +7,7 @@
177  int main(int argc, char **argv)
179 -       char *sha1_dir = getenv(DB_ENVIRONMENT), *path;
180 +       char *sha1_dir, *path;
181         int len, i;
183         if (mkdir(".git", 0755) < 0) {
184 ------------------------------------------------
186 As you can see, a commit shows who made the latest change, what they
187 did, and why.
189 Every commit has a 40-hexdigit id, sometimes called the "object name" or the
190 "SHA-1 id", shown on the first line of the `git show` output.  You can usually
191 refer to a commit by a shorter name, such as a tag or a branch name, but this
192 longer name can also be useful.  Most importantly, it is a globally unique
193 name for this commit: so if you tell somebody else the object name (for
194 example in email), then you are guaranteed that name will refer to the same
195 commit in their repository that it does in yours (assuming their repository
196 has that commit at all).  Since the object name is computed as a hash over the
197 contents of the commit, you are guaranteed that the commit can never change
198 without its name also changing.
200 In fact, in <<git-concepts>> we shall see that everything stored in Git
201 history, including file data and directory contents, is stored in an object
202 with a name that is a hash of its contents.
204 [[understanding-reachability]]
205 Understanding history: commits, parents, and reachability
206 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
208 Every commit (except the very first commit in a project) also has a
209 parent commit which shows what happened before this commit.
210 Following the chain of parents will eventually take you back to the
211 beginning of the project.
213 However, the commits do not form a simple list; Git allows lines of
214 development to diverge and then reconverge, and the point where two
215 lines of development reconverge is called a "merge".  The commit
216 representing a merge can therefore have more than one parent, with
217 each parent representing the most recent commit on one of the lines
218 of development leading to that point.
220 The best way to see how this works is using the linkgit:gitk[1]
221 command; running gitk now on a Git repository and looking for merge
222 commits will help understand how Git organizes history.
224 In the following, we say that commit X is "reachable" from commit Y
225 if commit X is an ancestor of commit Y.  Equivalently, you could say
226 that Y is a descendant of X, or that there is a chain of parents
227 leading from commit Y to commit X.
229 [[history-diagrams]]
230 Understanding history: History diagrams
231 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
233 We will sometimes represent Git history using diagrams like the one
234 below.  Commits are shown as "o", and the links between them with
235 lines drawn with - / and \.  Time goes left to right:
238 ................................................
239          o--o--o <-- Branch A
240         /
241  o--o--o <-- master
242         \
243          o--o--o <-- Branch B
244 ................................................
246 If we need to talk about a particular commit, the character "o" may
247 be replaced with another letter or number.
249 [[what-is-a-branch]]
250 Understanding history: What is a branch?
251 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
253 When we need to be precise, we will use the word "branch" to mean a line
254 of development, and "branch head" (or just "head") to mean a reference
255 to the most recent commit on a branch.  In the example above, the branch
256 head named "A" is a pointer to one particular commit, but we refer to
257 the line of three commits leading up to that point as all being part of
258 "branch A".
260 However, when no confusion will result, we often just use the term
261 "branch" both for branches and for branch heads.
263 [[manipulating-branches]]
264 Manipulating branches
265 ---------------------
267 Creating, deleting, and modifying branches is quick and easy; here's
268 a summary of the commands:
270 `git branch`::
271         list all branches.
272 `git branch <branch>`::
273         create a new branch named `<branch>`, referencing the same
274         point in history as the current branch.
275 `git branch <branch> <start-point>`::
276         create a new branch named `<branch>`, referencing
277         `<start-point>`, which may be specified any way you like,
278         including using a branch name or a tag name.
279 `git branch -d <branch>`::
280         delete the branch `<branch>`; if the branch is not fully
281         merged in its upstream branch or contained in the current branch,
282         this command will fail with a warning.
283 `git branch -D <branch>`::
284         delete the branch `<branch>` irrespective of its merged status.
285 `git checkout <branch>`::
286         make the current branch `<branch>`, updating the working
287         directory to reflect the version referenced by `<branch>`.
288 `git checkout -b <new> <start-point>`::
289         create a new branch `<new>` referencing `<start-point>`, and
290         check it out.
292 The special symbol "HEAD" can always be used to refer to the current
293 branch.  In fact, Git uses a file named `HEAD` in the `.git` directory
294 to remember which branch is current:
296 ------------------------------------------------
297 $ cat .git/HEAD
298 ref: refs/heads/master
299 ------------------------------------------------
301 [[detached-head]]
302 Examining an old version without creating a new branch
303 ------------------------------------------------------
305 The `git checkout` command normally expects a branch head, but will also
306 accept an arbitrary commit; for example, you can check out the commit
307 referenced by a tag:
309 ------------------------------------------------
310 $ git checkout v2.6.17
311 Note: checking out 'v2.6.17'.
313 You are in 'detached HEAD' state. You can look around, make experimental
314 changes and commit them, and you can discard any commits you make in this
315 state without impacting any branches by performing another checkout.
317 If you want to create a new branch to retain commits you create, you may
318 do so (now or later) by using -b with the checkout command again. Example:
320   git checkout -b new_branch_name
322 HEAD is now at 427abfa... Linux v2.6.17
323 ------------------------------------------------
325 The HEAD then refers to the SHA-1 of the commit instead of to a branch,
326 and git branch shows that you are no longer on a branch:
328 ------------------------------------------------
329 $ cat .git/HEAD
330 427abfa28afedffadfca9dd8b067eb6d36bac53f
331 $ git branch
332 * (detached from v2.6.17)
333   master
334 ------------------------------------------------
336 In this case we say that the HEAD is "detached".
338 This is an easy way to check out a particular version without having to
339 make up a name for the new branch.   You can still create a new branch
340 (or tag) for this version later if you decide to.
342 [[examining-remote-branches]]
343 Examining branches from a remote repository
344 -------------------------------------------
346 The "master" branch that was created at the time you cloned is a copy
347 of the HEAD in the repository that you cloned from.  That repository
348 may also have had other branches, though, and your local repository
349 keeps branches which track each of those remote branches, called
350 remote-tracking branches, which you
351 can view using the `-r` option to linkgit:git-branch[1]:
353 ------------------------------------------------
354 $ git branch -r
355   origin/HEAD
356   origin/html
357   origin/maint
358   origin/man
359   origin/master
360   origin/next
361   origin/pu
362   origin/todo
363 ------------------------------------------------
365 In this example, "origin" is called a remote repository, or "remote"
366 for short. The branches of this repository are called "remote
367 branches" from our point of view. The remote-tracking branches listed
368 above were created based on the remote branches at clone time and will
369 be updated by `git fetch` (hence `git pull`) and `git push`. See
370 <<Updating-a-repository-With-git-fetch>> for details.
372 You might want to build on one of these remote-tracking branches
373 on a branch of your own, just as you would for a tag:
375 ------------------------------------------------
376 $ git checkout -b my-todo-copy origin/todo
377 ------------------------------------------------
379 You can also check out `origin/todo` directly to examine it or
380 write a one-off patch.  See <<detached-head,detached head>>.
382 Note that the name "origin" is just the name that Git uses by default
383 to refer to the repository that you cloned from.
385 [[how-git-stores-references]]
386 Naming branches, tags, and other references
387 -------------------------------------------
389 Branches, remote-tracking branches, and tags are all references to
390 commits.  All references are named with a slash-separated path name
391 starting with `refs`; the names we've been using so far are actually
392 shorthand:
394         - The branch `test` is short for `refs/heads/test`.
395         - The tag `v2.6.18` is short for `refs/tags/v2.6.18`.
396         - `origin/master` is short for `refs/remotes/origin/master`.
398 The full name is occasionally useful if, for example, there ever
399 exists a tag and a branch with the same name.
401 (Newly created refs are actually stored in the `.git/refs` directory,
402 under the path given by their name.  However, for efficiency reasons
403 they may also be packed together in a single file; see
404 linkgit:git-pack-refs[1]).
406 As another useful shortcut, the "HEAD" of a repository can be referred
407 to just using the name of that repository.  So, for example, "origin"
408 is usually a shortcut for the HEAD branch in the repository "origin".
410 For the complete list of paths which Git checks for references, and
411 the order it uses to decide which to choose when there are multiple
412 references with the same shorthand name, see the "SPECIFYING
413 REVISIONS" section of linkgit:gitrevisions[7].
415 [[Updating-a-repository-With-git-fetch]]
416 Updating a repository with git fetch
417 ------------------------------------
419 After you clone a repository and commit a few changes of your own, you
420 may wish to check the original repository for updates.
422 The `git-fetch` command, with no arguments, will update all of the
423 remote-tracking branches to the latest version found in the original
424 repository.  It will not touch any of your own branches--not even the
425 "master" branch that was created for you on clone.
427 [[fetching-branches]]
428 Fetching branches from other repositories
429 -----------------------------------------
431 You can also track branches from repositories other than the one you
432 cloned from, using linkgit:git-remote[1]:
434 -------------------------------------------------
435 $ git remote add staging git://git.kernel.org/.../gregkh/staging.git
436 $ git fetch staging
438 From git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging
439  * [new branch]      master     -> staging/master
440  * [new branch]      staging-linus -> staging/staging-linus
441  * [new branch]      staging-next -> staging/staging-next
442 -------------------------------------------------
444 New remote-tracking branches will be stored under the shorthand name
445 that you gave `git remote add`, in this case `staging`:
447 -------------------------------------------------
448 $ git branch -r
449   origin/HEAD -> origin/master
450   origin/master
451   staging/master
452   staging/staging-linus
453   staging/staging-next
454 -------------------------------------------------
456 If you run `git fetch <remote>` later, the remote-tracking branches
457 for the named `<remote>` will be updated.
459 If you examine the file `.git/config`, you will see that Git has added
460 a new stanza:
462 -------------------------------------------------
463 $ cat .git/config
465 [remote "staging"]
466         url = git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging.git
467         fetch = +refs/heads/*:refs/remotes/staging/*
469 -------------------------------------------------
471 This is what causes Git to track the remote's branches; you may modify
472 or delete these configuration options by editing `.git/config` with a
473 text editor.  (See the "CONFIGURATION FILE" section of
474 linkgit:git-config[1] for details.)
476 [[exploring-git-history]]
477 Exploring Git history
478 =====================
480 Git is best thought of as a tool for storing the history of a
481 collection of files.  It does this by storing compressed snapshots of
482 the contents of a file hierarchy, together with "commits" which show
483 the relationships between these snapshots.
485 Git provides extremely flexible and fast tools for exploring the
486 history of a project.
488 We start with one specialized tool that is useful for finding the
489 commit that introduced a bug into a project.
491 [[using-bisect]]
492 How to use bisect to find a regression
493 --------------------------------------
495 Suppose version 2.6.18 of your project worked, but the version at
496 "master" crashes.  Sometimes the best way to find the cause of such a
497 regression is to perform a brute-force search through the project's
498 history to find the particular commit that caused the problem.  The
499 linkgit:git-bisect[1] command can help you do this:
501 -------------------------------------------------
502 $ git bisect start
503 $ git bisect good v2.6.18
504 $ git bisect bad master
505 Bisecting: 3537 revisions left to test after this
506 [65934a9a028b88e83e2b0f8b36618fe503349f8e] BLOCK: Make USB storage depend on SCSI rather than selecting it [try #6]
507 -------------------------------------------------
509 If you run `git branch` at this point, you'll see that Git has
510 temporarily moved you in "(no branch)". HEAD is now detached from any
511 branch and points directly to a commit (with commit id 65934...) that
512 is reachable from "master" but not from v2.6.18. Compile and test it,
513 and see whether it crashes. Assume it does crash. Then:
515 -------------------------------------------------
516 $ git bisect bad
517 Bisecting: 1769 revisions left to test after this
518 [7eff82c8b1511017ae605f0c99ac275a7e21b867] i2c-core: Drop useless bitmaskings
519 -------------------------------------------------
521 checks out an older version.  Continue like this, telling Git at each
522 stage whether the version it gives you is good or bad, and notice
523 that the number of revisions left to test is cut approximately in
524 half each time.
526 After about 13 tests (in this case), it will output the commit id of
527 the guilty commit.  You can then examine the commit with
528 linkgit:git-show[1], find out who wrote it, and mail them your bug
529 report with the commit id.  Finally, run
531 -------------------------------------------------
532 $ git bisect reset
533 -------------------------------------------------
535 to return you to the branch you were on before.
537 Note that the version which `git bisect` checks out for you at each
538 point is just a suggestion, and you're free to try a different
539 version if you think it would be a good idea.  For example,
540 occasionally you may land on a commit that broke something unrelated;
543 -------------------------------------------------
544 $ git bisect visualize
545 -------------------------------------------------
547 which will run gitk and label the commit it chose with a marker that
548 says "bisect".  Choose a safe-looking commit nearby, note its commit
549 id, and check it out with:
551 -------------------------------------------------
552 $ git reset --hard fb47ddb2db...
553 -------------------------------------------------
555 then test, run `bisect good` or `bisect bad` as appropriate, and
556 continue.
558 Instead of `git bisect visualize` and then `git reset --hard
559 fb47ddb2db...`, you might just want to tell Git that you want to skip
560 the current commit:
562 -------------------------------------------------
563 $ git bisect skip
564 -------------------------------------------------
566 In this case, though, Git may not eventually be able to tell the first
567 bad one between some first skipped commits and a later bad commit.
569 There are also ways to automate the bisecting process if you have a
570 test script that can tell a good from a bad commit. See
571 linkgit:git-bisect[1] for more information about this and other `git
572 bisect` features.
574 [[naming-commits]]
575 Naming commits
576 --------------
578 We have seen several ways of naming commits already:
580         - 40-hexdigit object name
581         - branch name: refers to the commit at the head of the given
582           branch
583         - tag name: refers to the commit pointed to by the given tag
584           (we've seen branches and tags are special cases of
585           <<how-git-stores-references,references>>).
586         - HEAD: refers to the head of the current branch
588 There are many more; see the "SPECIFYING REVISIONS" section of the
589 linkgit:gitrevisions[7] man page for the complete list of ways to
590 name revisions.  Some examples:
592 -------------------------------------------------
593 $ git show fb47ddb2 # the first few characters of the object name
594                     # are usually enough to specify it uniquely
595 $ git show HEAD^    # the parent of the HEAD commit
596 $ git show HEAD^^   # the grandparent
597 $ git show HEAD~4   # the great-great-grandparent
598 -------------------------------------------------
600 Recall that merge commits may have more than one parent; by default,
601 `^` and `~` follow the first parent listed in the commit, but you can
602 also choose:
604 -------------------------------------------------
605 $ git show HEAD^1   # show the first parent of HEAD
606 $ git show HEAD^2   # show the second parent of HEAD
607 -------------------------------------------------
609 In addition to HEAD, there are several other special names for
610 commits:
612 Merges (to be discussed later), as well as operations such as
613 `git reset`, which change the currently checked-out commit, generally
614 set ORIG_HEAD to the value HEAD had before the current operation.
616 The `git fetch` operation always stores the head of the last fetched
617 branch in FETCH_HEAD.  For example, if you run `git fetch` without
618 specifying a local branch as the target of the operation
620 -------------------------------------------------
621 $ git fetch git://example.com/proj.git theirbranch
622 -------------------------------------------------
624 the fetched commits will still be available from FETCH_HEAD.
626 When we discuss merges we'll also see the special name MERGE_HEAD,
627 which refers to the other branch that we're merging in to the current
628 branch.
630 The linkgit:git-rev-parse[1] command is a low-level command that is
631 occasionally useful for translating some name for a commit to the object
632 name for that commit:
634 -------------------------------------------------
635 $ git rev-parse origin
636 e05db0fd4f31dde7005f075a84f96b360d05984b
637 -------------------------------------------------
639 [[creating-tags]]
640 Creating tags
641 -------------
643 We can also create a tag to refer to a particular commit; after
644 running
646 -------------------------------------------------
647 $ git tag stable-1 1b2e1d63ff
648 -------------------------------------------------
650 You can use `stable-1` to refer to the commit 1b2e1d63ff.
652 This creates a "lightweight" tag.  If you would also like to include a
653 comment with the tag, and possibly sign it cryptographically, then you
654 should create a tag object instead; see the linkgit:git-tag[1] man page
655 for details.
657 [[browsing-revisions]]
658 Browsing revisions
659 ------------------
661 The linkgit:git-log[1] command can show lists of commits.  On its
662 own, it shows all commits reachable from the parent commit; but you
663 can also make more specific requests:
665 -------------------------------------------------
666 $ git log v2.5..        # commits since (not reachable from) v2.5
667 $ git log test..master  # commits reachable from master but not test
668 $ git log master..test  # ...reachable from test but not master
669 $ git log master...test # ...reachable from either test or master,
670                         #    but not both
671 $ git log --since="2 weeks ago" # commits from the last 2 weeks
672 $ git log Makefile      # commits which modify Makefile
673 $ git log fs/           # ... which modify any file under fs/
674 $ git log -S'foo()'     # commits which add or remove any file data
675                         # matching the string 'foo()'
676 -------------------------------------------------
678 And of course you can combine all of these; the following finds
679 commits since v2.5 which touch the `Makefile` or any file under `fs`:
681 -------------------------------------------------
682 $ git log v2.5.. Makefile fs/
683 -------------------------------------------------
685 You can also ask git log to show patches:
687 -------------------------------------------------
688 $ git log -p
689 -------------------------------------------------
691 See the `--pretty` option in the linkgit:git-log[1] man page for more
692 display options.
694 Note that git log starts with the most recent commit and works
695 backwards through the parents; however, since Git history can contain
696 multiple independent lines of development, the particular order that
697 commits are listed in may be somewhat arbitrary.
699 [[generating-diffs]]
700 Generating diffs
701 ----------------
703 You can generate diffs between any two versions using
704 linkgit:git-diff[1]:
706 -------------------------------------------------
707 $ git diff master..test
708 -------------------------------------------------
710 That will produce the diff between the tips of the two branches.  If
711 you'd prefer to find the diff from their common ancestor to test, you
712 can use three dots instead of two:
714 -------------------------------------------------
715 $ git diff master...test
716 -------------------------------------------------
718 Sometimes what you want instead is a set of patches; for this you can
719 use linkgit:git-format-patch[1]:
721 -------------------------------------------------
722 $ git format-patch master..test
723 -------------------------------------------------
725 will generate a file with a patch for each commit reachable from test
726 but not from master.
728 [[viewing-old-file-versions]]
729 Viewing old file versions
730 -------------------------
732 You can always view an old version of a file by just checking out the
733 correct revision first.  But sometimes it is more convenient to be
734 able to view an old version of a single file without checking
735 anything out; this command does that:
737 -------------------------------------------------
738 $ git show v2.5:fs/locks.c
739 -------------------------------------------------
741 Before the colon may be anything that names a commit, and after it
742 may be any path to a file tracked by Git.
744 [[history-examples]]
745 Examples
746 --------
748 [[counting-commits-on-a-branch]]
749 Counting the number of commits on a branch
750 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
752 Suppose you want to know how many commits you've made on `mybranch`
753 since it diverged from `origin`:
755 -------------------------------------------------
756 $ git log --pretty=oneline origin..mybranch | wc -l
757 -------------------------------------------------
759 Alternatively, you may often see this sort of thing done with the
760 lower-level command linkgit:git-rev-list[1], which just lists the SHA-1's
761 of all the given commits:
763 -------------------------------------------------
764 $ git rev-list origin..mybranch | wc -l
765 -------------------------------------------------
767 [[checking-for-equal-branches]]
768 Check whether two branches point at the same history
769 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
771 Suppose you want to check whether two branches point at the same point
772 in history.
774 -------------------------------------------------
775 $ git diff origin..master
776 -------------------------------------------------
778 will tell you whether the contents of the project are the same at the
779 two branches; in theory, however, it's possible that the same project
780 contents could have been arrived at by two different historical
781 routes.  You could compare the object names:
783 -------------------------------------------------
784 $ git rev-list origin
785 e05db0fd4f31dde7005f075a84f96b360d05984b
786 $ git rev-list master
787 e05db0fd4f31dde7005f075a84f96b360d05984b
788 -------------------------------------------------
790 Or you could recall that the `...` operator selects all commits
791 reachable from either one reference or the other but not
792 both; so
794 -------------------------------------------------
795 $ git log origin...master
796 -------------------------------------------------
798 will return no commits when the two branches are equal.
800 [[finding-tagged-descendants]]
801 Find first tagged version including a given fix
802 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
804 Suppose you know that the commit e05db0fd fixed a certain problem.
805 You'd like to find the earliest tagged release that contains that
806 fix.
808 Of course, there may be more than one answer--if the history branched
809 after commit e05db0fd, then there could be multiple "earliest" tagged
810 releases.
812 You could just visually inspect the commits since e05db0fd:
814 -------------------------------------------------
815 $ gitk e05db0fd..
816 -------------------------------------------------
818 or you can use linkgit:git-name-rev[1], which will give the commit a
819 name based on any tag it finds pointing to one of the commit's
820 descendants:
822 -------------------------------------------------
823 $ git name-rev --tags e05db0fd
824 e05db0fd tags/v1.5.0-rc1^0~23
825 -------------------------------------------------
827 The linkgit:git-describe[1] command does the opposite, naming the
828 revision using a tag on which the given commit is based:
830 -------------------------------------------------
831 $ git describe e05db0fd
832 v1.5.0-rc0-260-ge05db0f
833 -------------------------------------------------
835 but that may sometimes help you guess which tags might come after the
836 given commit.
838 If you just want to verify whether a given tagged version contains a
839 given commit, you could use linkgit:git-merge-base[1]:
841 -------------------------------------------------
842 $ git merge-base e05db0fd v1.5.0-rc1
843 e05db0fd4f31dde7005f075a84f96b360d05984b
844 -------------------------------------------------
846 The merge-base command finds a common ancestor of the given commits,
847 and always returns one or the other in the case where one is a
848 descendant of the other; so the above output shows that e05db0fd
849 actually is an ancestor of v1.5.0-rc1.
851 Alternatively, note that
853 -------------------------------------------------
854 $ git log v1.5.0-rc1..e05db0fd
855 -------------------------------------------------
857 will produce empty output if and only if v1.5.0-rc1 includes e05db0fd,
858 because it outputs only commits that are not reachable from v1.5.0-rc1.
860 As yet another alternative, the linkgit:git-show-branch[1] command lists
861 the commits reachable from its arguments with a display on the left-hand
862 side that indicates which arguments that commit is reachable from.
863 So, if you run something like
865 -------------------------------------------------
866 $ git show-branch e05db0fd v1.5.0-rc0 v1.5.0-rc1 v1.5.0-rc2
867 ! [e05db0fd] Fix warnings in sha1_file.c - use C99 printf format if
868 available
869  ! [v1.5.0-rc0] GIT v1.5.0 preview
870   ! [v1.5.0-rc1] GIT v1.5.0-rc1
871    ! [v1.5.0-rc2] GIT v1.5.0-rc2
873 -------------------------------------------------
875 then a line like
877 -------------------------------------------------
878 + ++ [e05db0fd] Fix warnings in sha1_file.c - use C99 printf format if
879 available
880 -------------------------------------------------
882 shows that e05db0fd is reachable from itself, from v1.5.0-rc1,
883 and from v1.5.0-rc2, and not from v1.5.0-rc0.
885 [[showing-commits-unique-to-a-branch]]
886 Showing commits unique to a given branch
887 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
889 Suppose you would like to see all the commits reachable from the branch
890 head named `master` but not from any other head in your repository.
892 We can list all the heads in this repository with
893 linkgit:git-show-ref[1]:
895 -------------------------------------------------
896 $ git show-ref --heads
897 bf62196b5e363d73353a9dcf094c59595f3153b7 refs/heads/core-tutorial
898 db768d5504c1bb46f63ee9d6e1772bd047e05bf9 refs/heads/maint
899 a07157ac624b2524a059a3414e99f6f44bebc1e7 refs/heads/master
900 24dbc180ea14dc1aebe09f14c8ecf32010690627 refs/heads/tutorial-2
901 1e87486ae06626c2f31eaa63d26fc0fd646c8af2 refs/heads/tutorial-fixes
902 -------------------------------------------------
904 We can get just the branch-head names, and remove `master`, with
905 the help of the standard utilities cut and grep:
907 -------------------------------------------------
908 $ git show-ref --heads | cut -d' ' -f2 | grep -v '^refs/heads/master'
909 refs/heads/core-tutorial
910 refs/heads/maint
911 refs/heads/tutorial-2
912 refs/heads/tutorial-fixes
913 -------------------------------------------------
915 And then we can ask to see all the commits reachable from master
916 but not from these other heads:
918 -------------------------------------------------
919 $ gitk master --not $( git show-ref --heads | cut -d' ' -f2 |
920                                 grep -v '^refs/heads/master' )
921 -------------------------------------------------
923 Obviously, endless variations are possible; for example, to see all
924 commits reachable from some head but not from any tag in the repository:
926 -------------------------------------------------
927 $ gitk $( git show-ref --heads ) --not  $( git show-ref --tags )
928 -------------------------------------------------
930 (See linkgit:gitrevisions[7] for explanations of commit-selecting
931 syntax such as `--not`.)
933 [[making-a-release]]
934 Creating a changelog and tarball for a software release
935 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
937 The linkgit:git-archive[1] command can create a tar or zip archive from
938 any version of a project; for example:
940 -------------------------------------------------
941 $ git archive -o latest.tar.gz --prefix=project/ HEAD
942 -------------------------------------------------
944 will use HEAD to produce a gzipped tar archive in which each filename
945 is preceded by `project/`.  The output file format is inferred from
946 the output file extension if possible, see linkgit:git-archive[1] for
947 details.
949 Versions of Git older than 1.7.7 don't know about the `tar.gz` format,
950 you'll need to use gzip explicitly:
952 -------------------------------------------------
953 $ git archive --format=tar --prefix=project/ HEAD | gzip >latest.tar.gz
954 -------------------------------------------------
956 If you're releasing a new version of a software project, you may want
957 to simultaneously make a changelog to include in the release
958 announcement.
960 Linus Torvalds, for example, makes new kernel releases by tagging them,
961 then running:
963 -------------------------------------------------
964 $ release-script 2.6.12 2.6.13-rc6 2.6.13-rc7
965 -------------------------------------------------
967 where release-script is a shell script that looks like:
969 -------------------------------------------------
970 #!/bin/sh
971 stable="$1"
972 last="$2"
973 new="$3"
974 echo "# git tag v$new"
975 echo "git archive --prefix=linux-$new/ v$new | gzip -9 > ../linux-$new.tar.gz"
976 echo "git diff v$stable v$new | gzip -9 > ../patch-$new.gz"
977 echo "git log --no-merges v$new ^v$last > ../ChangeLog-$new"
978 echo "git shortlog --no-merges v$new ^v$last > ../ShortLog"
979 echo "git diff --stat --summary -M v$last v$new > ../diffstat-$new"
980 -------------------------------------------------
982 and then he just cut-and-pastes the output commands after verifying that
983 they look OK.
985 [[Finding-commits-With-given-Content]]
986 Finding commits referencing a file with given content
987 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
989 Somebody hands you a copy of a file, and asks which commits modified a
990 file such that it contained the given content either before or after the
991 commit.  You can find out with this:
993 -------------------------------------------------
994 $  git log --raw --abbrev=40 --pretty=oneline |
995         grep -B 1 `git hash-object filename`
996 -------------------------------------------------
998 Figuring out why this works is left as an exercise to the (advanced)
999 student.  The linkgit:git-log[1], linkgit:git-diff-tree[1], and
1000 linkgit:git-hash-object[1] man pages may prove helpful.
1002 [[Developing-With-git]]
1003 Developing with Git
1004 ===================
1006 [[telling-git-your-name]]
1007 Telling Git your name
1008 ---------------------
1010 Before creating any commits, you should introduce yourself to Git.
1011 The easiest way to do so is to use linkgit:git-config[1]:
1013 ------------------------------------------------
1014 $ git config --global user.name 'Your Name Comes Here'
1015 $ git config --global user.email 'you@yourdomain.example.com'
1016 ------------------------------------------------
1018 Which will add the following to a file named `.gitconfig` in your
1019 home directory:
1021 ------------------------------------------------
1022 [user]
1023         name = Your Name Comes Here
1024         email = you@yourdomain.example.com
1025 ------------------------------------------------
1027 See the "CONFIGURATION FILE" section of linkgit:git-config[1] for
1028 details on the configuration file.  The file is plain text, so you can
1029 also edit it with your favorite editor.
1032 [[creating-a-new-repository]]
1033 Creating a new repository
1034 -------------------------
1036 Creating a new repository from scratch is very easy:
1038 -------------------------------------------------
1039 $ mkdir project
1040 $ cd project
1041 $ git init
1042 -------------------------------------------------
1044 If you have some initial content (say, a tarball):
1046 -------------------------------------------------
1047 $ tar xzvf project.tar.gz
1048 $ cd project
1049 $ git init
1050 $ git add . # include everything below ./ in the first commit:
1051 $ git commit
1052 -------------------------------------------------
1054 [[how-to-make-a-commit]]
1055 How to make a commit
1056 --------------------
1058 Creating a new commit takes three steps:
1060         1. Making some changes to the working directory using your
1061            favorite editor.
1062         2. Telling Git about your changes.
1063         3. Creating the commit using the content you told Git about
1064            in step 2.
1066 In practice, you can interleave and repeat steps 1 and 2 as many
1067 times as you want: in order to keep track of what you want committed
1068 at step 3, Git maintains a snapshot of the tree's contents in a
1069 special staging area called "the index."
1071 At the beginning, the content of the index will be identical to
1072 that of the HEAD.  The command `git diff --cached`, which shows
1073 the difference between the HEAD and the index, should therefore
1074 produce no output at that point.
1076 Modifying the index is easy:
1078 To update the index with the contents of a new or modified file, use
1080 -------------------------------------------------
1081 $ git add path/to/file
1082 -------------------------------------------------
1084 To remove a file from the index and from the working tree, use
1086 -------------------------------------------------
1087 $ git rm path/to/file
1088 -------------------------------------------------
1090 After each step you can verify that
1092 -------------------------------------------------
1093 $ git diff --cached
1094 -------------------------------------------------
1096 always shows the difference between the HEAD and the index file--this
1097 is what you'd commit if you created the commit now--and that
1099 -------------------------------------------------
1100 $ git diff
1101 -------------------------------------------------
1103 shows the difference between the working tree and the index file.
1105 Note that `git add` always adds just the current contents of a file
1106 to the index; further changes to the same file will be ignored unless
1107 you run `git add` on the file again.
1109 When you're ready, just run
1111 -------------------------------------------------
1112 $ git commit
1113 -------------------------------------------------
1115 and Git will prompt you for a commit message and then create the new
1116 commit.  Check to make sure it looks like what you expected with
1118 -------------------------------------------------
1119 $ git show
1120 -------------------------------------------------
1122 As a special shortcut,
1124 -------------------------------------------------
1125 $ git commit -a
1126 -------------------------------------------------
1128 will update the index with any files that you've modified or removed
1129 and create a commit, all in one step.
1131 A number of commands are useful for keeping track of what you're
1132 about to commit:
1134 -------------------------------------------------
1135 $ git diff --cached # difference between HEAD and the index; what
1136                     # would be committed if you ran "commit" now.
1137 $ git diff          # difference between the index file and your
1138                     # working directory; changes that would not
1139                     # be included if you ran "commit" now.
1140 $ git diff HEAD     # difference between HEAD and working tree; what
1141                     # would be committed if you ran "commit -a" now.
1142 $ git status        # a brief per-file summary of the above.
1143 -------------------------------------------------
1145 You can also use linkgit:git-gui[1] to create commits, view changes in
1146 the index and the working tree files, and individually select diff hunks
1147 for inclusion in the index (by right-clicking on the diff hunk and
1148 choosing "Stage Hunk For Commit").
1150 [[creating-good-commit-messages]]
1151 Creating good commit messages
1152 -----------------------------
1154 Though not required, it's a good idea to begin the commit message
1155 with a single short (less than 50 character) line summarizing the
1156 change, followed by a blank line and then a more thorough
1157 description.  The text up to the first blank line in a commit
1158 message is treated as the commit title, and that title is used
1159 throughout Git.  For example, linkgit:git-format-patch[1] turns a
1160 commit into email, and it uses the title on the Subject line and the
1161 rest of the commit in the body.
1164 [[ignoring-files]]
1165 Ignoring files
1166 --------------
1168 A project will often generate files that you do 'not' want to track with Git.
1169 This typically includes files generated by a build process or temporary
1170 backup files made by your editor. Of course, 'not' tracking files with Git
1171 is just a matter of 'not' calling `git add` on them. But it quickly becomes
1172 annoying to have these untracked files lying around; e.g. they make
1173 `git add .` practically useless, and they keep showing up in the output of
1174 `git status`.
1176 You can tell Git to ignore certain files by creating a file called
1177 `.gitignore` in the top level of your working directory, with contents
1178 such as:
1180 -------------------------------------------------
1181 # Lines starting with '#' are considered comments.
1182 # Ignore any file named foo.txt.
1183 foo.txt
1184 # Ignore (generated) html files,
1185 *.html
1186 # except foo.html which is maintained by hand.
1187 !foo.html
1188 # Ignore objects and archives.
1189 *.[oa]
1190 -------------------------------------------------
1192 See linkgit:gitignore[5] for a detailed explanation of the syntax.  You can
1193 also place .gitignore files in other directories in your working tree, and they
1194 will apply to those directories and their subdirectories.  The `.gitignore`
1195 files can be added to your repository like any other files (just run `git add
1196 .gitignore` and `git commit`, as usual), which is convenient when the exclude
1197 patterns (such as patterns matching build output files) would also make sense
1198 for other users who clone your repository.
1200 If you wish the exclude patterns to affect only certain repositories
1201 (instead of every repository for a given project), you may instead put
1202 them in a file in your repository named `.git/info/exclude`, or in any
1203 file specified by the `core.excludesfile` configuration variable.
1204 Some Git commands can also take exclude patterns directly on the
1205 command line.  See linkgit:gitignore[5] for the details.
1207 [[how-to-merge]]
1208 How to merge
1209 ------------
1211 You can rejoin two diverging branches of development using
1212 linkgit:git-merge[1]:
1214 -------------------------------------------------
1215 $ git merge branchname
1216 -------------------------------------------------
1218 merges the development in the branch `branchname` into the current
1219 branch.
1221 A merge is made by combining the changes made in `branchname` and the
1222 changes made up to the latest commit in your current branch since
1223 their histories forked. The work tree is overwritten by the result of
1224 the merge when this combining is done cleanly, or overwritten by a
1225 half-merged results when this combining results in conflicts.
1226 Therefore, if you have uncommitted changes touching the same files as
1227 the ones impacted by the merge, Git will refuse to proceed. Most of
1228 the time, you will want to commit your changes before you can merge,
1229 and if you don't, then linkgit:git-stash[1] can take these changes
1230 away while you're doing the merge, and reapply them afterwards.
1232 If the changes are independent enough, Git will automatically complete
1233 the merge and commit the result (or reuse an existing commit in case
1234 of <<fast-forwards,fast-forward>>, see below). On the other hand,
1235 if there are conflicts--for example, if the same file is
1236 modified in two different ways in the remote branch and the local
1237 branch--then you are warned; the output may look something like this:
1239 -------------------------------------------------
1240 $ git merge next
1241  100% (4/4) done
1242 Auto-merged file.txt
1243 CONFLICT (content): Merge conflict in file.txt
1244 Automatic merge failed; fix conflicts and then commit the result.
1245 -------------------------------------------------
1247 Conflict markers are left in the problematic files, and after
1248 you resolve the conflicts manually, you can update the index
1249 with the contents and run Git commit, as you normally would when
1250 creating a new file.
1252 If you examine the resulting commit using gitk, you will see that it
1253 has two parents, one pointing to the top of the current branch, and
1254 one to the top of the other branch.
1256 [[resolving-a-merge]]
1257 Resolving a merge
1258 -----------------
1260 When a merge isn't resolved automatically, Git leaves the index and
1261 the working tree in a special state that gives you all the
1262 information you need to help resolve the merge.
1264 Files with conflicts are marked specially in the index, so until you
1265 resolve the problem and update the index, linkgit:git-commit[1] will
1266 fail:
1268 -------------------------------------------------
1269 $ git commit
1270 file.txt: needs merge
1271 -------------------------------------------------
1273 Also, linkgit:git-status[1] will list those files as "unmerged", and the
1274 files with conflicts will have conflict markers added, like this:
1276 -------------------------------------------------
1277 <<<<<<< HEAD:file.txt
1278 Hello world
1279 =======
1280 Goodbye
1281 >>>>>>> 77976da35a11db4580b80ae27e8d65caf5208086:file.txt
1282 -------------------------------------------------
1284 All you need to do is edit the files to resolve the conflicts, and then
1286 -------------------------------------------------
1287 $ git add file.txt
1288 $ git commit
1289 -------------------------------------------------
1291 Note that the commit message will already be filled in for you with
1292 some information about the merge.  Normally you can just use this
1293 default message unchanged, but you may add additional commentary of
1294 your own if desired.
1296 The above is all you need to know to resolve a simple merge.  But Git
1297 also provides more information to help resolve conflicts:
1299 [[conflict-resolution]]
1300 Getting conflict-resolution help during a merge
1301 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1303 All of the changes that Git was able to merge automatically are
1304 already added to the index file, so linkgit:git-diff[1] shows only
1305 the conflicts.  It uses an unusual syntax:
1307 -------------------------------------------------
1308 $ git diff
1309 diff --cc file.txt
1310 index 802992c,2b60207..0000000
1311 --- a/file.txt
1312 +++ b/file.txt
1313 @@@ -1,1 -1,1 +1,5 @@@
1314 ++<<<<<<< HEAD:file.txt
1315  +Hello world
1316 ++=======
1317 + Goodbye
1318 ++>>>>>>> 77976da35a11db4580b80ae27e8d65caf5208086:file.txt
1319 -------------------------------------------------
1321 Recall that the commit which will be committed after we resolve this
1322 conflict will have two parents instead of the usual one: one parent
1323 will be HEAD, the tip of the current branch; the other will be the
1324 tip of the other branch, which is stored temporarily in MERGE_HEAD.
1326 During the merge, the index holds three versions of each file.  Each of
1327 these three "file stages" represents a different version of the file:
1329 -------------------------------------------------
1330 $ git show :1:file.txt  # the file in a common ancestor of both branches
1331 $ git show :2:file.txt  # the version from HEAD.
1332 $ git show :3:file.txt  # the version from MERGE_HEAD.
1333 -------------------------------------------------
1335 When you ask linkgit:git-diff[1] to show the conflicts, it runs a
1336 three-way diff between the conflicted merge results in the work tree with
1337 stages 2 and 3 to show only hunks whose contents come from both sides,
1338 mixed (in other words, when a hunk's merge results come only from stage 2,
1339 that part is not conflicting and is not shown.  Same for stage 3).
1341 The diff above shows the differences between the working-tree version of
1342 file.txt and the stage 2 and stage 3 versions.  So instead of preceding
1343 each line by a single `+` or `-`, it now uses two columns: the first
1344 column is used for differences between the first parent and the working
1345 directory copy, and the second for differences between the second parent
1346 and the working directory copy.  (See the "COMBINED DIFF FORMAT" section
1347 of linkgit:git-diff-files[1] for a details of the format.)
1349 After resolving the conflict in the obvious way (but before updating the
1350 index), the diff will look like:
1352 -------------------------------------------------
1353 $ git diff
1354 diff --cc file.txt
1355 index 802992c,2b60207..0000000
1356 --- a/file.txt
1357 +++ b/file.txt
1358 @@@ -1,1 -1,1 +1,1 @@@
1359 - Hello world
1360  -Goodbye
1361 ++Goodbye world
1362 -------------------------------------------------
1364 This shows that our resolved version deleted "Hello world" from the
1365 first parent, deleted "Goodbye" from the second parent, and added
1366 "Goodbye world", which was previously absent from both.
1368 Some special diff options allow diffing the working directory against
1369 any of these stages:
1371 -------------------------------------------------
1372 $ git diff -1 file.txt          # diff against stage 1
1373 $ git diff --base file.txt      # same as the above
1374 $ git diff -2 file.txt          # diff against stage 2
1375 $ git diff --ours file.txt      # same as the above
1376 $ git diff -3 file.txt          # diff against stage 3
1377 $ git diff --theirs file.txt    # same as the above.
1378 -------------------------------------------------
1380 The linkgit:git-log[1] and linkgit:gitk[1] commands also provide special help
1381 for merges:
1383 -------------------------------------------------
1384 $ git log --merge
1385 $ gitk --merge
1386 -------------------------------------------------
1388 These will display all commits which exist only on HEAD or on
1389 MERGE_HEAD, and which touch an unmerged file.
1391 You may also use linkgit:git-mergetool[1], which lets you merge the
1392 unmerged files using external tools such as Emacs or kdiff3.
1394 Each time you resolve the conflicts in a file and update the index:
1396 -------------------------------------------------
1397 $ git add file.txt
1398 -------------------------------------------------
1400 the different stages of that file will be "collapsed", after which
1401 `git diff` will (by default) no longer show diffs for that file.
1403 [[undoing-a-merge]]
1404 Undoing a merge
1405 ---------------
1407 If you get stuck and decide to just give up and throw the whole mess
1408 away, you can always return to the pre-merge state with
1410 -------------------------------------------------
1411 $ git reset --hard HEAD
1412 -------------------------------------------------
1414 Or, if you've already committed the merge that you want to throw away,
1416 -------------------------------------------------
1417 $ git reset --hard ORIG_HEAD
1418 -------------------------------------------------
1420 However, this last command can be dangerous in some cases--never
1421 throw away a commit you have already committed if that commit may
1422 itself have been merged into another branch, as doing so may confuse
1423 further merges.
1425 [[fast-forwards]]
1426 Fast-forward merges
1427 -------------------
1429 There is one special case not mentioned above, which is treated
1430 differently.  Normally, a merge results in a merge commit, with two
1431 parents, one pointing at each of the two lines of development that
1432 were merged.
1434 However, if the current branch is a descendant of the other--so every
1435 commit present in the one is already contained in the other--then Git
1436 just performs a "fast-forward"; the head of the current branch is moved
1437 forward to point at the head of the merged-in branch, without any new
1438 commits being created.
1440 [[fixing-mistakes]]
1441 Fixing mistakes
1442 ---------------
1444 If you've messed up the working tree, but haven't yet committed your
1445 mistake, you can return the entire working tree to the last committed
1446 state with
1448 -------------------------------------------------
1449 $ git reset --hard HEAD
1450 -------------------------------------------------
1452 If you make a commit that you later wish you hadn't, there are two
1453 fundamentally different ways to fix the problem:
1455         1. You can create a new commit that undoes whatever was done
1456         by the old commit.  This is the correct thing if your
1457         mistake has already been made public.
1459         2. You can go back and modify the old commit.  You should
1460         never do this if you have already made the history public;
1461         Git does not normally expect the "history" of a project to
1462         change, and cannot correctly perform repeated merges from
1463         a branch that has had its history changed.
1465 [[reverting-a-commit]]
1466 Fixing a mistake with a new commit
1467 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1469 Creating a new commit that reverts an earlier change is very easy;
1470 just pass the linkgit:git-revert[1] command a reference to the bad
1471 commit; for example, to revert the most recent commit:
1473 -------------------------------------------------
1474 $ git revert HEAD
1475 -------------------------------------------------
1477 This will create a new commit which undoes the change in HEAD.  You
1478 will be given a chance to edit the commit message for the new commit.
1480 You can also revert an earlier change, for example, the next-to-last:
1482 -------------------------------------------------
1483 $ git revert HEAD^
1484 -------------------------------------------------
1486 In this case Git will attempt to undo the old change while leaving
1487 intact any changes made since then.  If more recent changes overlap
1488 with the changes to be reverted, then you will be asked to fix
1489 conflicts manually, just as in the case of <<resolving-a-merge,
1490 resolving a merge>>.
1492 [[fixing-a-mistake-by-rewriting-history]]
1493 Fixing a mistake by rewriting history
1494 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1496 If the problematic commit is the most recent commit, and you have not
1497 yet made that commit public, then you may just
1498 <<undoing-a-merge,destroy it using `git reset`>>.
1500 Alternatively, you
1501 can edit the working directory and update the index to fix your
1502 mistake, just as if you were going to <<how-to-make-a-commit,create a
1503 new commit>>, then run
1505 -------------------------------------------------
1506 $ git commit --amend
1507 -------------------------------------------------
1509 which will replace the old commit by a new commit incorporating your
1510 changes, giving you a chance to edit the old commit message first.
1512 Again, you should never do this to a commit that may already have
1513 been merged into another branch; use linkgit:git-revert[1] instead in
1514 that case.
1516 It is also possible to replace commits further back in the history, but
1517 this is an advanced topic to be left for
1518 <<cleaning-up-history,another chapter>>.
1520 [[checkout-of-path]]
1521 Checking out an old version of a file
1522 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1524 In the process of undoing a previous bad change, you may find it
1525 useful to check out an older version of a particular file using
1526 linkgit:git-checkout[1].  We've used `git checkout` before to switch
1527 branches, but it has quite different behavior if it is given a path
1528 name: the command
1530 -------------------------------------------------
1531 $ git checkout HEAD^ path/to/file
1532 -------------------------------------------------
1534 replaces path/to/file by the contents it had in the commit HEAD^, and
1535 also updates the index to match.  It does not change branches.
1537 If you just want to look at an old version of the file, without
1538 modifying the working directory, you can do that with
1539 linkgit:git-show[1]:
1541 -------------------------------------------------
1542 $ git show HEAD^:path/to/file
1543 -------------------------------------------------
1545 which will display the given version of the file.
1547 [[interrupted-work]]
1548 Temporarily setting aside work in progress
1549 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1551 While you are in the middle of working on something complicated, you
1552 find an unrelated but obvious and trivial bug.  You would like to fix it
1553 before continuing.  You can use linkgit:git-stash[1] to save the current
1554 state of your work, and after fixing the bug (or, optionally after doing
1555 so on a different branch and then coming back), unstash the
1556 work-in-progress changes.
1558 ------------------------------------------------
1559 $ git stash save "work in progress for foo feature"
1560 ------------------------------------------------
1562 This command will save your changes away to the `stash`, and
1563 reset your working tree and the index to match the tip of your
1564 current branch.  Then you can make your fix as usual.
1566 ------------------------------------------------
1567 ... edit and test ...
1568 $ git commit -a -m "blorpl: typofix"
1569 ------------------------------------------------
1571 After that, you can go back to what you were working on with
1572 `git stash pop`:
1574 ------------------------------------------------
1575 $ git stash pop
1576 ------------------------------------------------
1579 [[ensuring-good-performance]]
1580 Ensuring good performance
1581 -------------------------
1583 On large repositories, Git depends on compression to keep the history
1584 information from taking up too much space on disk or in memory.  Some
1585 Git commands may automatically run linkgit:git-gc[1], so you don't
1586 have to worry about running it manually.  However, compressing a large
1587 repository may take a while, so you may want to call `gc` explicitly
1588 to avoid automatic compression kicking in when it is not convenient.
1591 [[ensuring-reliability]]
1592 Ensuring reliability
1593 --------------------
1595 [[checking-for-corruption]]
1596 Checking the repository for corruption
1597 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1599 The linkgit:git-fsck[1] command runs a number of self-consistency checks
1600 on the repository, and reports on any problems.  This may take some
1601 time.
1603 -------------------------------------------------
1604 $ git fsck
1605 dangling commit 7281251ddd2a61e38657c827739c57015671a6b3
1606 dangling commit 2706a059f258c6b245f298dc4ff2ccd30ec21a63
1607 dangling commit 13472b7c4b80851a1bc551779171dcb03655e9b5
1608 dangling blob 218761f9d90712d37a9c5e36f406f92202db07eb
1609 dangling commit bf093535a34a4d35731aa2bd90fe6b176302f14f
1610 dangling commit 8e4bec7f2ddaa268bef999853c25755452100f8e
1611 dangling tree d50bb86186bf27b681d25af89d3b5b68382e4085
1612 dangling tree b24c2473f1fd3d91352a624795be026d64c8841f
1614 -------------------------------------------------
1616 You will see informational messages on dangling objects. They are objects
1617 that still exist in the repository but are no longer referenced by any of
1618 your branches, and can (and will) be removed after a while with `gc`.
1619 You can run `git fsck --no-dangling` to suppress these messages, and still
1620 view real errors.
1622 [[recovering-lost-changes]]
1623 Recovering lost changes
1624 ~~~~~~~~~~~~~~~~~~~~~~~
1626 [[reflogs]]
1627 Reflogs
1628 ^^^^^^^
1630 Say you modify a branch with <<fixing-mistakes,`git reset --hard`>>,
1631 and then realize that the branch was the only reference you had to
1632 that point in history.
1634 Fortunately, Git also keeps a log, called a "reflog", of all the
1635 previous values of each branch.  So in this case you can still find the
1636 old history using, for example,
1638 -------------------------------------------------
1639 $ git log master@{1}
1640 -------------------------------------------------
1642 This lists the commits reachable from the previous version of the
1643 `master` branch head.  This syntax can be used with any Git command
1644 that accepts a commit, not just with `git log`.  Some other examples:
1646 -------------------------------------------------
1647 $ git show master@{2}           # See where the branch pointed 2,
1648 $ git show master@{3}           # 3, ... changes ago.
1649 $ gitk master@{yesterday}       # See where it pointed yesterday,
1650 $ gitk master@{"1 week ago"}    # ... or last week
1651 $ git log --walk-reflogs master # show reflog entries for master
1652 -------------------------------------------------
1654 A separate reflog is kept for the HEAD, so
1656 -------------------------------------------------
1657 $ git show HEAD@{"1 week ago"}
1658 -------------------------------------------------
1660 will show what HEAD pointed to one week ago, not what the current branch
1661 pointed to one week ago.  This allows you to see the history of what
1662 you've checked out.
1664 The reflogs are kept by default for 30 days, after which they may be
1665 pruned.  See linkgit:git-reflog[1] and linkgit:git-gc[1] to learn
1666 how to control this pruning, and see the "SPECIFYING REVISIONS"
1667 section of linkgit:gitrevisions[7] for details.
1669 Note that the reflog history is very different from normal Git history.
1670 While normal history is shared by every repository that works on the
1671 same project, the reflog history is not shared: it tells you only about
1672 how the branches in your local repository have changed over time.
1674 [[dangling-object-recovery]]
1675 Examining dangling objects
1676 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1678 In some situations the reflog may not be able to save you.  For example,
1679 suppose you delete a branch, then realize you need the history it
1680 contained.  The reflog is also deleted; however, if you have not yet
1681 pruned the repository, then you may still be able to find the lost
1682 commits in the dangling objects that `git fsck` reports.  See
1683 <<dangling-objects>> for the details.
1685 -------------------------------------------------
1686 $ git fsck
1687 dangling commit 7281251ddd2a61e38657c827739c57015671a6b3
1688 dangling commit 2706a059f258c6b245f298dc4ff2ccd30ec21a63
1689 dangling commit 13472b7c4b80851a1bc551779171dcb03655e9b5
1691 -------------------------------------------------
1693 You can examine
1694 one of those dangling commits with, for example,
1696 ------------------------------------------------
1697 $ gitk 7281251ddd --not --all
1698 ------------------------------------------------
1700 which does what it sounds like: it says that you want to see the commit
1701 history that is described by the dangling commit(s), but not the
1702 history that is described by all your existing branches and tags.  Thus
1703 you get exactly the history reachable from that commit that is lost.
1704 (And notice that it might not be just one commit: we only report the
1705 "tip of the line" as being dangling, but there might be a whole deep
1706 and complex commit history that was dropped.)
1708 If you decide you want the history back, you can always create a new
1709 reference pointing to it, for example, a new branch:
1711 ------------------------------------------------
1712 $ git branch recovered-branch 7281251ddd
1713 ------------------------------------------------
1715 Other types of dangling objects (blobs and trees) are also possible, and
1716 dangling objects can arise in other situations.
1719 [[sharing-development]]
1720 Sharing development with others
1721 ===============================
1723 [[getting-updates-With-git-pull]]
1724 Getting updates with git pull
1725 -----------------------------
1727 After you clone a repository and commit a few changes of your own, you
1728 may wish to check the original repository for updates and merge them
1729 into your own work.
1731 We have already seen <<Updating-a-repository-With-git-fetch,how to
1732 keep remote-tracking branches up to date>> with linkgit:git-fetch[1],
1733 and how to merge two branches.  So you can merge in changes from the
1734 original repository's master branch with:
1736 -------------------------------------------------
1737 $ git fetch
1738 $ git merge origin/master
1739 -------------------------------------------------
1741 However, the linkgit:git-pull[1] command provides a way to do this in
1742 one step:
1744 -------------------------------------------------
1745 $ git pull origin master
1746 -------------------------------------------------
1748 In fact, if you have `master` checked out, then this branch has been
1749 configured by `git clone` to get changes from the HEAD branch of the
1750 origin repository.  So often you can
1751 accomplish the above with just a simple
1753 -------------------------------------------------
1754 $ git pull
1755 -------------------------------------------------
1757 This command will fetch changes from the remote branches to your
1758 remote-tracking branches `origin/*`, and merge the default branch into
1759 the current branch.
1761 More generally, a branch that is created from a remote-tracking branch
1762 will pull
1763 by default from that branch.  See the descriptions of the
1764 `branch.<name>.remote` and `branch.<name>.merge` options in
1765 linkgit:git-config[1], and the discussion of the `--track` option in
1766 linkgit:git-checkout[1], to learn how to control these defaults.
1768 In addition to saving you keystrokes, `git pull` also helps you by
1769 producing a default commit message documenting the branch and
1770 repository that you pulled from.
1772 (But note that no such commit will be created in the case of a
1773 <<fast-forwards,fast-forward>>; instead, your branch will just be
1774 updated to point to the latest commit from the upstream branch.)
1776 The `git pull` command can also be given `.` as the "remote" repository,
1777 in which case it just merges in a branch from the current repository; so
1778 the commands
1780 -------------------------------------------------
1781 $ git pull . branch
1782 $ git merge branch
1783 -------------------------------------------------
1785 are roughly equivalent.
1787 [[submitting-patches]]
1788 Submitting patches to a project
1789 -------------------------------
1791 If you just have a few changes, the simplest way to submit them may
1792 just be to send them as patches in email:
1794 First, use linkgit:git-format-patch[1]; for example:
1796 -------------------------------------------------
1797 $ git format-patch origin
1798 -------------------------------------------------
1800 will produce a numbered series of files in the current directory, one
1801 for each patch in the current branch but not in `origin/HEAD`.
1803 `git format-patch` can include an initial "cover letter". You can insert
1804 commentary on individual patches after the three dash line which
1805 `format-patch` places after the commit message but before the patch
1806 itself.  If you use `git notes` to track your cover letter material,
1807 `git format-patch --notes` will include the commit's notes in a similar
1808 manner.
1810 You can then import these into your mail client and send them by
1811 hand.  However, if you have a lot to send at once, you may prefer to
1812 use the linkgit:git-send-email[1] script to automate the process.
1813 Consult the mailing list for your project first to determine
1814 their requirements for submitting patches.
1816 [[importing-patches]]
1817 Importing patches to a project
1818 ------------------------------
1820 Git also provides a tool called linkgit:git-am[1] (am stands for
1821 "apply mailbox"), for importing such an emailed series of patches.
1822 Just save all of the patch-containing messages, in order, into a
1823 single mailbox file, say `patches.mbox`, then run
1825 -------------------------------------------------
1826 $ git am -3 patches.mbox
1827 -------------------------------------------------
1829 Git will apply each patch in order; if any conflicts are found, it
1830 will stop, and you can fix the conflicts as described in
1831 "<<resolving-a-merge,Resolving a merge>>".  (The `-3` option tells
1832 Git to perform a merge; if you would prefer it just to abort and
1833 leave your tree and index untouched, you may omit that option.)
1835 Once the index is updated with the results of the conflict
1836 resolution, instead of creating a new commit, just run
1838 -------------------------------------------------
1839 $ git am --continue
1840 -------------------------------------------------
1842 and Git will create the commit for you and continue applying the
1843 remaining patches from the mailbox.
1845 The final result will be a series of commits, one for each patch in
1846 the original mailbox, with authorship and commit log message each
1847 taken from the message containing each patch.
1849 [[public-repositories]]
1850 Public Git repositories
1851 -----------------------
1853 Another way to submit changes to a project is to tell the maintainer
1854 of that project to pull the changes from your repository using
1855 linkgit:git-pull[1].  In the section "<<getting-updates-With-git-pull,
1856 Getting updates with `git pull`>>" we described this as a way to get
1857 updates from the "main" repository, but it works just as well in the
1858 other direction.
1860 If you and the maintainer both have accounts on the same machine, then
1861 you can just pull changes from each other's repositories directly;
1862 commands that accept repository URLs as arguments will also accept a
1863 local directory name:
1865 -------------------------------------------------
1866 $ git clone /path/to/repository
1867 $ git pull /path/to/other/repository
1868 -------------------------------------------------
1870 or an ssh URL:
1872 -------------------------------------------------
1873 $ git clone ssh://yourhost/~you/repository
1874 -------------------------------------------------
1876 For projects with few developers, or for synchronizing a few private
1877 repositories, this may be all you need.
1879 However, the more common way to do this is to maintain a separate public
1880 repository (usually on a different host) for others to pull changes
1881 from.  This is usually more convenient, and allows you to cleanly
1882 separate private work in progress from publicly visible work.
1884 You will continue to do your day-to-day work in your personal
1885 repository, but periodically "push" changes from your personal
1886 repository into your public repository, allowing other developers to
1887 pull from that repository.  So the flow of changes, in a situation
1888 where there is one other developer with a public repository, looks
1889 like this:
1891                         you push
1892   your personal repo ------------------> your public repo
1893         ^                                     |
1894         |                                     |
1895         | you pull                            | they pull
1896         |                                     |
1897         |                                     |
1898         |               they push             V
1899   their public repo <------------------- their repo
1901 We explain how to do this in the following sections.
1903 [[setting-up-a-public-repository]]
1904 Setting up a public repository
1905 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1907 Assume your personal repository is in the directory `~/proj`.  We
1908 first create a new clone of the repository and tell `git daemon` that it
1909 is meant to be public:
1911 -------------------------------------------------
1912 $ git clone --bare ~/proj proj.git
1913 $ touch proj.git/git-daemon-export-ok
1914 -------------------------------------------------
1916 The resulting directory proj.git contains a "bare" git repository--it is
1917 just the contents of the `.git` directory, without any files checked out
1918 around it.
1920 Next, copy `proj.git` to the server where you plan to host the
1921 public repository.  You can use scp, rsync, or whatever is most
1922 convenient.
1924 [[exporting-via-git]]
1925 Exporting a Git repository via the Git protocol
1926 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1928 This is the preferred method.
1930 If someone else administers the server, they should tell you what
1931 directory to put the repository in, and what `git://` URL it will
1932 appear at.  You can then skip to the section
1933 "<<pushing-changes-to-a-public-repository,Pushing changes to a public
1934 repository>>", below.
1936 Otherwise, all you need to do is start linkgit:git-daemon[1]; it will
1937 listen on port 9418.  By default, it will allow access to any directory
1938 that looks like a Git directory and contains the magic file
1939 git-daemon-export-ok.  Passing some directory paths as `git daemon`
1940 arguments will further restrict the exports to those paths.
1942 You can also run `git daemon` as an inetd service; see the
1943 linkgit:git-daemon[1] man page for details.  (See especially the
1944 examples section.)
1946 [[exporting-via-http]]
1947 Exporting a git repository via HTTP
1948 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1950 The Git protocol gives better performance and reliability, but on a
1951 host with a web server set up, HTTP exports may be simpler to set up.
1953 All you need to do is place the newly created bare Git repository in
1954 a directory that is exported by the web server, and make some
1955 adjustments to give web clients some extra information they need:
1957 -------------------------------------------------
1958 $ mv proj.git /home/you/public_html/proj.git
1959 $ cd proj.git
1960 $ git --bare update-server-info
1961 $ mv hooks/post-update.sample hooks/post-update
1962 -------------------------------------------------
1964 (For an explanation of the last two lines, see
1965 linkgit:git-update-server-info[1] and linkgit:githooks[5].)
1967 Advertise the URL of `proj.git`.  Anybody else should then be able to
1968 clone or pull from that URL, for example with a command line like:
1970 -------------------------------------------------
1971 $ git clone http://yourserver.com/~you/proj.git
1972 -------------------------------------------------
1974 (See also
1975 link:howto/setup-git-server-over-http.html[setup-git-server-over-http]
1976 for a slightly more sophisticated setup using WebDAV which also
1977 allows pushing over HTTP.)
1979 [[pushing-changes-to-a-public-repository]]
1980 Pushing changes to a public repository
1981 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1983 Note that the two techniques outlined above (exporting via
1984 <<exporting-via-http,http>> or <<exporting-via-git,git>>) allow other
1985 maintainers to fetch your latest changes, but they do not allow write
1986 access, which you will need to update the public repository with the
1987 latest changes created in your private repository.
1989 The simplest way to do this is using linkgit:git-push[1] and ssh; to
1990 update the remote branch named `master` with the latest state of your
1991 branch named `master`, run
1993 -------------------------------------------------
1994 $ git push ssh://yourserver.com/~you/proj.git master:master
1995 -------------------------------------------------
1997 or just
1999 -------------------------------------------------
2000 $ git push ssh://yourserver.com/~you/proj.git master
2001 -------------------------------------------------
2003 As with `git fetch`, `git push` will complain if this does not result in a
2004 <<fast-forwards,fast-forward>>; see the following section for details on
2005 handling this case.
2007 Note that the target of a `push` is normally a
2008 <<def_bare_repository,bare>> repository.  You can also push to a
2009 repository that has a checked-out working tree, but a push to update the
2010 currently checked-out branch is denied by default to prevent confusion.
2011 See the description of the receive.denyCurrentBranch option
2012 in linkgit:git-config[1] for details.
2014 As with `git fetch`, you may also set up configuration options to
2015 save typing; so, for example:
2017 -------------------------------------------------
2018 $ git remote add public-repo ssh://yourserver.com/~you/proj.git
2019 -------------------------------------------------
2021 adds the following to `.git/config`:
2023 -------------------------------------------------
2024 [remote "public-repo"]
2025         url = yourserver.com:proj.git
2026         fetch = +refs/heads/*:refs/remotes/example/*
2027 -------------------------------------------------
2029 which lets you do the same push with just
2031 -------------------------------------------------
2032 $ git push public-repo master
2033 -------------------------------------------------
2035 See the explanations of the `remote.<name>.url`,
2036 `branch.<name>.remote`, and `remote.<name>.push` options in
2037 linkgit:git-config[1] for details.
2039 [[forcing-push]]
2040 What to do when a push fails
2041 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2043 If a push would not result in a <<fast-forwards,fast-forward>> of the
2044 remote branch, then it will fail with an error like:
2046 -------------------------------------------------
2047 error: remote 'refs/heads/master' is not an ancestor of
2048  local  'refs/heads/master'.
2049  Maybe you are not up-to-date and need to pull first?
2050 error: failed to push to 'ssh://yourserver.com/~you/proj.git'
2051 -------------------------------------------------
2053 This can happen, for example, if you:
2055         - use `git reset --hard` to remove already-published commits, or
2056         - use `git commit --amend` to replace already-published commits
2057           (as in <<fixing-a-mistake-by-rewriting-history>>), or
2058         - use `git rebase` to rebase any already-published commits (as
2059           in <<using-git-rebase>>).
2061 You may force `git push` to perform the update anyway by preceding the
2062 branch name with a plus sign:
2064 -------------------------------------------------
2065 $ git push ssh://yourserver.com/~you/proj.git +master
2066 -------------------------------------------------
2068 Note the addition of the `+` sign.  Alternatively, you can use the
2069 `-f` flag to force the remote update, as in:
2071 -------------------------------------------------
2072 $ git push -f ssh://yourserver.com/~you/proj.git master
2073 -------------------------------------------------
2075 Normally whenever a branch head in a public repository is modified, it
2076 is modified to point to a descendant of the commit that it pointed to
2077 before.  By forcing a push in this situation, you break that convention.
2078 (See <<problems-With-rewriting-history>>.)
2080 Nevertheless, this is a common practice for people that need a simple
2081 way to publish a work-in-progress patch series, and it is an acceptable
2082 compromise as long as you warn other developers that this is how you
2083 intend to manage the branch.
2085 It's also possible for a push to fail in this way when other people have
2086 the right to push to the same repository.  In that case, the correct
2087 solution is to retry the push after first updating your work: either by a
2088 pull, or by a fetch followed by a rebase; see the
2089 <<setting-up-a-shared-repository,next section>> and
2090 linkgit:gitcvs-migration[7] for more.
2092 [[setting-up-a-shared-repository]]
2093 Setting up a shared repository
2094 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2096 Another way to collaborate is by using a model similar to that
2097 commonly used in CVS, where several developers with special rights
2098 all push to and pull from a single shared repository.  See
2099 linkgit:gitcvs-migration[7] for instructions on how to
2100 set this up.
2102 However, while there is nothing wrong with Git's support for shared
2103 repositories, this mode of operation is not generally recommended,
2104 simply because the mode of collaboration that Git supports--by
2105 exchanging patches and pulling from public repositories--has so many
2106 advantages over the central shared repository:
2108         - Git's ability to quickly import and merge patches allows a
2109           single maintainer to process incoming changes even at very
2110           high rates.  And when that becomes too much, `git pull` provides
2111           an easy way for that maintainer to delegate this job to other
2112           maintainers while still allowing optional review of incoming
2113           changes.
2114         - Since every developer's repository has the same complete copy
2115           of the project history, no repository is special, and it is
2116           trivial for another developer to take over maintenance of a
2117           project, either by mutual agreement, or because a maintainer
2118           becomes unresponsive or difficult to work with.
2119         - The lack of a central group of "committers" means there is
2120           less need for formal decisions about who is "in" and who is
2121           "out".
2123 [[setting-up-gitweb]]
2124 Allowing web browsing of a repository
2125 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2127 The gitweb cgi script provides users an easy way to browse your
2128 project's files and history without having to install Git; see the file
2129 gitweb/INSTALL in the Git source tree for instructions on setting it up.
2131 [[sharing-development-examples]]
2132 Examples
2133 --------
2135 [[maintaining-topic-branches]]
2136 Maintaining topic branches for a Linux subsystem maintainer
2137 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2139 This describes how Tony Luck uses Git in his role as maintainer of the
2140 IA64 architecture for the Linux kernel.
2142 He uses two public branches:
2144  - A "test" tree into which patches are initially placed so that they
2145    can get some exposure when integrated with other ongoing development.
2146    This tree is available to Andrew for pulling into -mm whenever he
2147    wants.
2149  - A "release" tree into which tested patches are moved for final sanity
2150    checking, and as a vehicle to send them upstream to Linus (by sending
2151    him a "please pull" request.)
2153 He also uses a set of temporary branches ("topic branches"), each
2154 containing a logical grouping of patches.
2156 To set this up, first create your work tree by cloning Linus's public
2157 tree:
2159 -------------------------------------------------
2160 $ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git work
2161 $ cd work
2162 -------------------------------------------------
2164 Linus's tree will be stored in the remote-tracking branch named origin/master,
2165 and can be updated using linkgit:git-fetch[1]; you can track other
2166 public trees using linkgit:git-remote[1] to set up a "remote" and
2167 linkgit:git-fetch[1] to keep them up-to-date; see
2168 <<repositories-and-branches>>.
2170 Now create the branches in which you are going to work; these start out
2171 at the current tip of origin/master branch, and should be set up (using
2172 the `--track` option to linkgit:git-branch[1]) to merge changes in from
2173 Linus by default.
2175 -------------------------------------------------
2176 $ git branch --track test origin/master
2177 $ git branch --track release origin/master
2178 -------------------------------------------------
2180 These can be easily kept up to date using linkgit:git-pull[1].
2182 -------------------------------------------------
2183 $ git checkout test && git pull
2184 $ git checkout release && git pull
2185 -------------------------------------------------
2187 Important note!  If you have any local changes in these branches, then
2188 this merge will create a commit object in the history (with no local
2189 changes Git will simply do a "fast-forward" merge).  Many people dislike
2190 the "noise" that this creates in the Linux history, so you should avoid
2191 doing this capriciously in the `release` branch, as these noisy commits
2192 will become part of the permanent history when you ask Linus to pull
2193 from the release branch.
2195 A few configuration variables (see linkgit:git-config[1]) can
2196 make it easy to push both branches to your public tree.  (See
2197 <<setting-up-a-public-repository>>.)
2199 -------------------------------------------------
2200 $ cat >> .git/config <<EOF
2201 [remote "mytree"]
2202         url =  master.kernel.org:/pub/scm/linux/kernel/git/aegl/linux.git
2203         push = release
2204         push = test
2206 -------------------------------------------------
2208 Then you can push both the test and release trees using
2209 linkgit:git-push[1]:
2211 -------------------------------------------------
2212 $ git push mytree
2213 -------------------------------------------------
2215 or push just one of the test and release branches using:
2217 -------------------------------------------------
2218 $ git push mytree test
2219 -------------------------------------------------
2223 -------------------------------------------------
2224 $ git push mytree release
2225 -------------------------------------------------
2227 Now to apply some patches from the community.  Think of a short
2228 snappy name for a branch to hold this patch (or related group of
2229 patches), and create a new branch from a recent stable tag of
2230 Linus's branch. Picking a stable base for your branch will:
2231 1) help you: by avoiding inclusion of unrelated and perhaps lightly
2232 tested changes
2233 2) help future bug hunters that use `git bisect` to find problems
2235 -------------------------------------------------
2236 $ git checkout -b speed-up-spinlocks v2.6.35
2237 -------------------------------------------------
2239 Now you apply the patch(es), run some tests, and commit the change(s).  If
2240 the patch is a multi-part series, then you should apply each as a separate
2241 commit to this branch.
2243 -------------------------------------------------
2244 $ ... patch ... test  ... commit [ ... patch ... test ... commit ]*
2245 -------------------------------------------------
2247 When you are happy with the state of this change, you can merge it into the
2248 "test" branch in preparation to make it public:
2250 -------------------------------------------------
2251 $ git checkout test && git merge speed-up-spinlocks
2252 -------------------------------------------------
2254 It is unlikely that you would have any conflicts here ... but you might if you
2255 spent a while on this step and had also pulled new versions from upstream.
2257 Sometime later when enough time has passed and testing done, you can pull the
2258 same branch into the `release` tree ready to go upstream.  This is where you
2259 see the value of keeping each patch (or patch series) in its own branch.  It
2260 means that the patches can be moved into the `release` tree in any order.
2262 -------------------------------------------------
2263 $ git checkout release && git merge speed-up-spinlocks
2264 -------------------------------------------------
2266 After a while, you will have a number of branches, and despite the
2267 well chosen names you picked for each of them, you may forget what
2268 they are for, or what status they are in.  To get a reminder of what
2269 changes are in a specific branch, use:
2271 -------------------------------------------------
2272 $ git log linux..branchname | git shortlog
2273 -------------------------------------------------
2275 To see whether it has already been merged into the test or release branches,
2276 use:
2278 -------------------------------------------------
2279 $ git log test..branchname
2280 -------------------------------------------------
2284 -------------------------------------------------
2285 $ git log release..branchname
2286 -------------------------------------------------
2288 (If this branch has not yet been merged, you will see some log entries.
2289 If it has been merged, then there will be no output.)
2291 Once a patch completes the great cycle (moving from test to release,
2292 then pulled by Linus, and finally coming back into your local
2293 `origin/master` branch), the branch for this change is no longer needed.
2294 You detect this when the output from:
2296 -------------------------------------------------
2297 $ git log origin..branchname
2298 -------------------------------------------------
2300 is empty.  At this point the branch can be deleted:
2302 -------------------------------------------------
2303 $ git branch -d branchname
2304 -------------------------------------------------
2306 Some changes are so trivial that it is not necessary to create a separate
2307 branch and then merge into each of the test and release branches.  For
2308 these changes, just apply directly to the `release` branch, and then
2309 merge that into the `test` branch.
2311 After pushing your work to `mytree`, you can use
2312 linkgit:git-request-pull[1] to prepare a "please pull" request message
2313 to send to Linus:
2315 -------------------------------------------------
2316 $ git push mytree
2317 $ git request-pull origin mytree release
2318 -------------------------------------------------
2320 Here are some of the scripts that simplify all this even further.
2322 -------------------------------------------------
2323 ==== update script ====
2324 # Update a branch in my Git tree.  If the branch to be updated
2325 # is origin, then pull from kernel.org.  Otherwise merge
2326 # origin/master branch into test|release branch
2328 case "$1" in
2329 test|release)
2330         git checkout $1 && git pull . origin
2331         ;;
2332 origin)
2333         before=$(git rev-parse refs/remotes/origin/master)
2334         git fetch origin
2335         after=$(git rev-parse refs/remotes/origin/master)
2336         if [ $before != $after ]
2337         then
2338                 git log $before..$after | git shortlog
2339         fi
2340         ;;
2342         echo "usage: $0 origin|test|release" 1>&2
2343         exit 1
2344         ;;
2345 esac
2346 -------------------------------------------------
2348 -------------------------------------------------
2349 ==== merge script ====
2350 # Merge a branch into either the test or release branch
2352 pname=$0
2354 usage()
2356         echo "usage: $pname branch test|release" 1>&2
2357         exit 1
2360 git show-ref -q --verify -- refs/heads/"$1" || {
2361         echo "Can't see branch <$1>" 1>&2
2362         usage
2365 case "$2" in
2366 test|release)
2367         if [ $(git log $2..$1 | wc -c) -eq 0 ]
2368         then
2369                 echo $1 already merged into $2 1>&2
2370                 exit 1
2371         fi
2372         git checkout $2 && git pull . $1
2373         ;;
2375         usage
2376         ;;
2377 esac
2378 -------------------------------------------------
2380 -------------------------------------------------
2381 ==== status script ====
2382 # report on status of my ia64 Git tree
2384 gb=$(tput setab 2)
2385 rb=$(tput setab 1)
2386 restore=$(tput setab 9)
2388 if [ `git rev-list test..release | wc -c` -gt 0 ]
2389 then
2390         echo $rb Warning: commits in release that are not in test $restore
2391         git log test..release
2394 for branch in `git show-ref --heads | sed 's|^.*/||'`
2396         if [ $branch = test -o $branch = release ]
2397         then
2398                 continue
2399         fi
2401         echo -n $gb ======= $branch ====== $restore " "
2402         status=
2403         for ref in test release origin/master
2404         do
2405                 if [ `git rev-list $ref..$branch | wc -c` -gt 0 ]
2406                 then
2407                         status=$status${ref:0:1}
2408                 fi
2409         done
2410         case $status in
2411         trl)
2412                 echo $rb Need to pull into test $restore
2413                 ;;
2414         rl)
2415                 echo "In test"
2416                 ;;
2417         l)
2418                 echo "Waiting for linus"
2419                 ;;
2420         "")
2421                 echo $rb All done $restore
2422                 ;;
2423         *)
2424                 echo $rb "<$status>" $restore
2425                 ;;
2426         esac
2427         git log origin/master..$branch | git shortlog
2428 done
2429 -------------------------------------------------
2432 [[cleaning-up-history]]
2433 Rewriting history and maintaining patch series
2434 ==============================================
2436 Normally commits are only added to a project, never taken away or
2437 replaced.  Git is designed with this assumption, and violating it will
2438 cause Git's merge machinery (for example) to do the wrong thing.
2440 However, there is a situation in which it can be useful to violate this
2441 assumption.
2443 [[patch-series]]
2444 Creating the perfect patch series
2445 ---------------------------------
2447 Suppose you are a contributor to a large project, and you want to add a
2448 complicated feature, and to present it to the other developers in a way
2449 that makes it easy for them to read your changes, verify that they are
2450 correct, and understand why you made each change.
2452 If you present all of your changes as a single patch (or commit), they
2453 may find that it is too much to digest all at once.
2455 If you present them with the entire history of your work, complete with
2456 mistakes, corrections, and dead ends, they may be overwhelmed.
2458 So the ideal is usually to produce a series of patches such that:
2460         1. Each patch can be applied in order.
2462         2. Each patch includes a single logical change, together with a
2463            message explaining the change.
2465         3. No patch introduces a regression: after applying any initial
2466            part of the series, the resulting project still compiles and
2467            works, and has no bugs that it didn't have before.
2469         4. The complete series produces the same end result as your own
2470            (probably much messier!) development process did.
2472 We will introduce some tools that can help you do this, explain how to
2473 use them, and then explain some of the problems that can arise because
2474 you are rewriting history.
2476 [[using-git-rebase]]
2477 Keeping a patch series up to date using git rebase
2478 --------------------------------------------------
2480 Suppose that you create a branch `mywork` on a remote-tracking branch
2481 `origin`, and create some commits on top of it:
2483 -------------------------------------------------
2484 $ git checkout -b mywork origin
2485 $ vi file.txt
2486 $ git commit
2487 $ vi otherfile.txt
2488 $ git commit
2490 -------------------------------------------------
2492 You have performed no merges into mywork, so it is just a simple linear
2493 sequence of patches on top of `origin`:
2495 ................................................
2496  o--o--O <-- origin
2497         \
2498          a--b--c <-- mywork
2499 ................................................
2501 Some more interesting work has been done in the upstream project, and
2502 `origin` has advanced:
2504 ................................................
2505  o--o--O--o--o--o <-- origin
2506         \
2507          a--b--c <-- mywork
2508 ................................................
2510 At this point, you could use `pull` to merge your changes back in;
2511 the result would create a new merge commit, like this:
2513 ................................................
2514  o--o--O--o--o--o <-- origin
2515         \        \
2516          a--b--c--m <-- mywork
2517 ................................................
2519 However, if you prefer to keep the history in mywork a simple series of
2520 commits without any merges, you may instead choose to use
2521 linkgit:git-rebase[1]:
2523 -------------------------------------------------
2524 $ git checkout mywork
2525 $ git rebase origin
2526 -------------------------------------------------
2528 This will remove each of your commits from mywork, temporarily saving
2529 them as patches (in a directory named `.git/rebase-apply`), update mywork to
2530 point at the latest version of origin, then apply each of the saved
2531 patches to the new mywork.  The result will look like:
2534 ................................................
2535  o--o--O--o--o--o <-- origin
2536                  \
2537                   a'--b'--c' <-- mywork
2538 ................................................
2540 In the process, it may discover conflicts.  In that case it will stop
2541 and allow you to fix the conflicts; after fixing conflicts, use `git add`
2542 to update the index with those contents, and then, instead of
2543 running `git commit`, just run
2545 -------------------------------------------------
2546 $ git rebase --continue
2547 -------------------------------------------------
2549 and Git will continue applying the rest of the patches.
2551 At any point you may use the `--abort` option to abort this process and
2552 return mywork to the state it had before you started the rebase:
2554 -------------------------------------------------
2555 $ git rebase --abort
2556 -------------------------------------------------
2558 If you need to reorder or edit a number of commits in a branch, it may
2559 be easier to use `git rebase -i`, which allows you to reorder and
2560 squash commits, as well as marking them for individual editing during
2561 the rebase.  See <<interactive-rebase>> for details, and
2562 <<reordering-patch-series>> for alternatives.
2564 [[rewriting-one-commit]]
2565 Rewriting a single commit
2566 -------------------------
2568 We saw in <<fixing-a-mistake-by-rewriting-history>> that you can replace the
2569 most recent commit using
2571 -------------------------------------------------
2572 $ git commit --amend
2573 -------------------------------------------------
2575 which will replace the old commit by a new commit incorporating your
2576 changes, giving you a chance to edit the old commit message first.
2577 This is useful for fixing typos in your last commit, or for adjusting
2578 the patch contents of a poorly staged commit.
2580 If you need to amend commits from deeper in your history, you can
2581 use <<interactive-rebase,interactive rebase's `edit` instruction>>.
2583 [[reordering-patch-series]]
2584 Reordering or selecting from a patch series
2585 -------------------------------------------
2587 Sometimes you want to edit a commit deeper in your history.  One
2588 approach is to use `git format-patch` to create a series of patches
2589 and then reset the state to before the patches:
2591 -------------------------------------------------
2592 $ git format-patch origin
2593 $ git reset --hard origin
2594 -------------------------------------------------
2596 Then modify, reorder, or eliminate patches as needed before applying
2597 them again with linkgit:git-am[1]:
2599 -------------------------------------------------
2600 $ git am *.patch
2601 -------------------------------------------------
2603 [[interactive-rebase]]
2604 Using interactive rebases
2605 -------------------------
2607 You can also edit a patch series with an interactive rebase.  This is
2608 the same as <<reordering-patch-series,reordering a patch series using
2609 `format-patch`>>, so use whichever interface you like best.
2611 Rebase your current HEAD on the last commit you want to retain as-is.
2612 For example, if you want to reorder the last 5 commits, use:
2614 -------------------------------------------------
2615 $ git rebase -i HEAD~5
2616 -------------------------------------------------
2618 This will open your editor with a list of steps to be taken to perform
2619 your rebase.
2621 -------------------------------------------------
2622 pick deadbee The oneline of this commit
2623 pick fa1afe1 The oneline of the next commit
2626 # Rebase c0ffeee..deadbee onto c0ffeee
2628 # Commands:
2629 #  p, pick = use commit
2630 #  r, reword = use commit, but edit the commit message
2631 #  e, edit = use commit, but stop for amending
2632 #  s, squash = use commit, but meld into previous commit
2633 #  f, fixup = like "squash", but discard this commit's log message
2634 #  x, exec = run command (the rest of the line) using shell
2636 # These lines can be re-ordered; they are executed from top to bottom.
2638 # If you remove a line here THAT COMMIT WILL BE LOST.
2640 # However, if you remove everything, the rebase will be aborted.
2642 # Note that empty commits are commented out
2643 -------------------------------------------------
2645 As explained in the comments, you can reorder commits, squash them
2646 together, edit commit messages, etc. by editing the list.  Once you
2647 are satisfied, save the list and close your editor, and the rebase
2648 will begin.
2650 The rebase will stop where `pick` has been replaced with `edit` or
2651 when a step in the list fails to mechanically resolve conflicts and
2652 needs your help.  When you are done editing and/or resolving conflicts
2653 you can continue with `git rebase --continue`.  If you decide that
2654 things are getting too hairy, you can always bail out with `git rebase
2655 --abort`.  Even after the rebase is complete, you can still recover
2656 the original branch by using the <<reflogs,reflog>>.
2658 For a more detailed discussion of the procedure and additional tips,
2659 see the "INTERACTIVE MODE" section of linkgit:git-rebase[1].
2661 [[patch-series-tools]]
2662 Other tools
2663 -----------
2665 There are numerous other tools, such as StGit, which exist for the
2666 purpose of maintaining a patch series.  These are outside of the scope of
2667 this manual.
2669 [[problems-With-rewriting-history]]
2670 Problems with rewriting history
2671 -------------------------------
2673 The primary problem with rewriting the history of a branch has to do
2674 with merging.  Suppose somebody fetches your branch and merges it into
2675 their branch, with a result something like this:
2677 ................................................
2678  o--o--O--o--o--o <-- origin
2679         \        \
2680          t--t--t--m <-- their branch:
2681 ................................................
2683 Then suppose you modify the last three commits:
2685 ................................................
2686          o--o--o <-- new head of origin
2687         /
2688  o--o--O--o--o--o <-- old head of origin
2689 ................................................
2691 If we examined all this history together in one repository, it will
2692 look like:
2694 ................................................
2695          o--o--o <-- new head of origin
2696         /
2697  o--o--O--o--o--o <-- old head of origin
2698         \        \
2699          t--t--t--m <-- their branch:
2700 ................................................
2702 Git has no way of knowing that the new head is an updated version of
2703 the old head; it treats this situation exactly the same as it would if
2704 two developers had independently done the work on the old and new heads
2705 in parallel.  At this point, if someone attempts to merge the new head
2706 in to their branch, Git will attempt to merge together the two (old and
2707 new) lines of development, instead of trying to replace the old by the
2708 new.  The results are likely to be unexpected.
2710 You may still choose to publish branches whose history is rewritten,
2711 and it may be useful for others to be able to fetch those branches in
2712 order to examine or test them, but they should not attempt to pull such
2713 branches into their own work.
2715 For true distributed development that supports proper merging,
2716 published branches should never be rewritten.
2718 [[bisect-merges]]
2719 Why bisecting merge commits can be harder than bisecting linear history
2720 -----------------------------------------------------------------------
2722 The linkgit:git-bisect[1] command correctly handles history that
2723 includes merge commits.  However, when the commit that it finds is a
2724 merge commit, the user may need to work harder than usual to figure out
2725 why that commit introduced a problem.
2727 Imagine this history:
2729 ................................................
2730       ---Z---o---X---...---o---A---C---D
2731           \                       /
2732            o---o---Y---...---o---B
2733 ................................................
2735 Suppose that on the upper line of development, the meaning of one
2736 of the functions that exists at Z is changed at commit X.  The
2737 commits from Z leading to A change both the function's
2738 implementation and all calling sites that exist at Z, as well
2739 as new calling sites they add, to be consistent.  There is no
2740 bug at A.
2742 Suppose that in the meantime on the lower line of development somebody
2743 adds a new calling site for that function at commit Y.  The
2744 commits from Z leading to B all assume the old semantics of that
2745 function and the callers and the callee are consistent with each
2746 other.  There is no bug at B, either.
2748 Suppose further that the two development lines merge cleanly at C,
2749 so no conflict resolution is required.
2751 Nevertheless, the code at C is broken, because the callers added
2752 on the lower line of development have not been converted to the new
2753 semantics introduced on the upper line of development.  So if all
2754 you know is that D is bad, that Z is good, and that
2755 linkgit:git-bisect[1] identifies C as the culprit, how will you
2756 figure out that the problem is due to this change in semantics?
2758 When the result of a `git bisect` is a non-merge commit, you should
2759 normally be able to discover the problem by examining just that commit.
2760 Developers can make this easy by breaking their changes into small
2761 self-contained commits.  That won't help in the case above, however,
2762 because the problem isn't obvious from examination of any single
2763 commit; instead, a global view of the development is required.  To
2764 make matters worse, the change in semantics in the problematic
2765 function may be just one small part of the changes in the upper
2766 line of development.
2768 On the other hand, if instead of merging at C you had rebased the
2769 history between Z to B on top of A, you would have gotten this
2770 linear history:
2772 ................................................................
2773     ---Z---o---X--...---o---A---o---o---Y*--...---o---B*--D*
2774 ................................................................
2776 Bisecting between Z and D* would hit a single culprit commit Y*,
2777 and understanding why Y* was broken would probably be easier.
2779 Partly for this reason, many experienced Git users, even when
2780 working on an otherwise merge-heavy project, keep the history
2781 linear by rebasing against the latest upstream version before
2782 publishing.
2784 [[advanced-branch-management]]
2785 Advanced branch management
2786 ==========================
2788 [[fetching-individual-branches]]
2789 Fetching individual branches
2790 ----------------------------
2792 Instead of using linkgit:git-remote[1], you can also choose just
2793 to update one branch at a time, and to store it locally under an
2794 arbitrary name:
2796 -------------------------------------------------
2797 $ git fetch origin todo:my-todo-work
2798 -------------------------------------------------
2800 The first argument, `origin`, just tells Git to fetch from the
2801 repository you originally cloned from.  The second argument tells Git
2802 to fetch the branch named `todo` from the remote repository, and to
2803 store it locally under the name `refs/heads/my-todo-work`.
2805 You can also fetch branches from other repositories; so
2807 -------------------------------------------------
2808 $ git fetch git://example.com/proj.git master:example-master
2809 -------------------------------------------------
2811 will create a new branch named `example-master` and store in it the
2812 branch named `master` from the repository at the given URL.  If you
2813 already have a branch named example-master, it will attempt to
2814 <<fast-forwards,fast-forward>> to the commit given by example.com's
2815 master branch.  In more detail:
2817 [[fetch-fast-forwards]]
2818 git fetch and fast-forwards
2819 ---------------------------
2821 In the previous example, when updating an existing branch, `git fetch`
2822 checks to make sure that the most recent commit on the remote
2823 branch is a descendant of the most recent commit on your copy of the
2824 branch before updating your copy of the branch to point at the new
2825 commit.  Git calls this process a <<fast-forwards,fast-forward>>.
2827 A fast-forward looks something like this:
2829 ................................................
2830  o--o--o--o <-- old head of the branch
2831            \
2832             o--o--o <-- new head of the branch
2833 ................................................
2836 In some cases it is possible that the new head will *not* actually be
2837 a descendant of the old head.  For example, the developer may have
2838 realized she made a serious mistake, and decided to backtrack,
2839 resulting in a situation like:
2841 ................................................
2842  o--o--o--o--a--b <-- old head of the branch
2843            \
2844             o--o--o <-- new head of the branch
2845 ................................................
2847 In this case, `git fetch` will fail, and print out a warning.
2849 In that case, you can still force Git to update to the new head, as
2850 described in the following section.  However, note that in the
2851 situation above this may mean losing the commits labeled `a` and `b`,
2852 unless you've already created a reference of your own pointing to
2853 them.
2855 [[forcing-fetch]]
2856 Forcing git fetch to do non-fast-forward updates
2857 ------------------------------------------------
2859 If git fetch fails because the new head of a branch is not a
2860 descendant of the old head, you may force the update with:
2862 -------------------------------------------------
2863 $ git fetch git://example.com/proj.git +master:refs/remotes/example/master
2864 -------------------------------------------------
2866 Note the addition of the `+` sign.  Alternatively, you can use the `-f`
2867 flag to force updates of all the fetched branches, as in:
2869 -------------------------------------------------
2870 $ git fetch -f origin
2871 -------------------------------------------------
2873 Be aware that commits that the old version of example/master pointed at
2874 may be lost, as we saw in the previous section.
2876 [[remote-branch-configuration]]
2877 Configuring remote-tracking branches
2878 ------------------------------------
2880 We saw above that `origin` is just a shortcut to refer to the
2881 repository that you originally cloned from.  This information is
2882 stored in Git configuration variables, which you can see using
2883 linkgit:git-config[1]:
2885 -------------------------------------------------
2886 $ git config -l
2887 core.repositoryformatversion=0
2888 core.filemode=true
2889 core.logallrefupdates=true
2890 remote.origin.url=git://git.kernel.org/pub/scm/git/git.git
2891 remote.origin.fetch=+refs/heads/*:refs/remotes/origin/*
2892 branch.master.remote=origin
2893 branch.master.merge=refs/heads/master
2894 -------------------------------------------------
2896 If there are other repositories that you also use frequently, you can
2897 create similar configuration options to save typing; for example,
2899 -------------------------------------------------
2900 $ git remote add example git://example.com/proj.git
2901 -------------------------------------------------
2903 adds the following to `.git/config`:
2905 -------------------------------------------------
2906 [remote "example"]
2907         url = git://example.com/proj.git
2908         fetch = +refs/heads/*:refs/remotes/example/*
2909 -------------------------------------------------
2911 Also note that the above configuration can be performed by directly
2912 editing the file `.git/config` instead of using linkgit:git-remote[1].
2914 After configuring the remote, the following three commands will do the
2915 same thing:
2917 -------------------------------------------------
2918 $ git fetch git://example.com/proj.git +refs/heads/*:refs/remotes/example/*
2919 $ git fetch example +refs/heads/*:refs/remotes/example/*
2920 $ git fetch example
2921 -------------------------------------------------
2923 See linkgit:git-config[1] for more details on the configuration
2924 options mentioned above and linkgit:git-fetch[1] for more details on
2925 the refspec syntax.
2928 [[git-concepts]]
2929 Git concepts
2930 ============
2932 Git is built on a small number of simple but powerful ideas.  While it
2933 is possible to get things done without understanding them, you will find
2934 Git much more intuitive if you do.
2936 We start with the most important, the  <<def_object_database,object
2937 database>> and the <<def_index,index>>.
2939 [[the-object-database]]
2940 The Object Database
2941 -------------------
2944 We already saw in <<understanding-commits>> that all commits are stored
2945 under a 40-digit "object name".  In fact, all the information needed to
2946 represent the history of a project is stored in objects with such names.
2947 In each case the name is calculated by taking the SHA-1 hash of the
2948 contents of the object.  The SHA-1 hash is a cryptographic hash function.
2949 What that means to us is that it is impossible to find two different
2950 objects with the same name.  This has a number of advantages; among
2951 others:
2953 - Git can quickly determine whether two objects are identical or not,
2954   just by comparing names.
2955 - Since object names are computed the same way in every repository, the
2956   same content stored in two repositories will always be stored under
2957   the same name.
2958 - Git can detect errors when it reads an object, by checking that the
2959   object's name is still the SHA-1 hash of its contents.
2961 (See <<object-details>> for the details of the object formatting and
2962 SHA-1 calculation.)
2964 There are four different types of objects: "blob", "tree", "commit", and
2965 "tag".
2967 - A <<def_blob_object,"blob" object>> is used to store file data.
2968 - A <<def_tree_object,"tree" object>> ties one or more
2969   "blob" objects into a directory structure. In addition, a tree object
2970   can refer to other tree objects, thus creating a directory hierarchy.
2971 - A <<def_commit_object,"commit" object>> ties such directory hierarchies
2972   together into a <<def_DAG,directed acyclic graph>> of revisions--each
2973   commit contains the object name of exactly one tree designating the
2974   directory hierarchy at the time of the commit. In addition, a commit
2975   refers to "parent" commit objects that describe the history of how we
2976   arrived at that directory hierarchy.
2977 - A <<def_tag_object,"tag" object>> symbolically identifies and can be
2978   used to sign other objects. It contains the object name and type of
2979   another object, a symbolic name (of course!) and, optionally, a
2980   signature.
2982 The object types in some more detail:
2984 [[commit-object]]
2985 Commit Object
2986 ~~~~~~~~~~~~~
2988 The "commit" object links a physical state of a tree with a description
2989 of how we got there and why.  Use the `--pretty=raw` option to
2990 linkgit:git-show[1] or linkgit:git-log[1] to examine your favorite
2991 commit:
2993 ------------------------------------------------
2994 $ git show -s --pretty=raw 2be7fcb476
2995 commit 2be7fcb4764f2dbcee52635b91fedb1b3dcf7ab4
2996 tree fb3a8bdd0ceddd019615af4d57a53f43d8cee2bf
2997 parent 257a84d9d02e90447b149af58b271c19405edb6a
2998 author Dave Watson <dwatson@mimvista.com> 1187576872 -0400
2999 committer Junio C Hamano <gitster@pobox.com> 1187591163 -0700
3001     Fix misspelling of 'suppress' in docs
3003     Signed-off-by: Junio C Hamano <gitster@pobox.com>
3004 ------------------------------------------------
3006 As you can see, a commit is defined by:
3008 - a tree: The SHA-1 name of a tree object (as defined below), representing
3009   the contents of a directory at a certain point in time.
3010 - parent(s): The SHA-1 name(s) of some number of commits which represent the
3011   immediately previous step(s) in the history of the project.  The
3012   example above has one parent; merge commits may have more than
3013   one.  A commit with no parents is called a "root" commit, and
3014   represents the initial revision of a project.  Each project must have
3015   at least one root.  A project can also have multiple roots, though
3016   that isn't common (or necessarily a good idea).
3017 - an author: The name of the person responsible for this change, together
3018   with its date.
3019 - a committer: The name of the person who actually created the commit,
3020   with the date it was done.  This may be different from the author, for
3021   example, if the author was someone who wrote a patch and emailed it
3022   to the person who used it to create the commit.
3023 - a comment describing this commit.
3025 Note that a commit does not itself contain any information about what
3026 actually changed; all changes are calculated by comparing the contents
3027 of the tree referred to by this commit with the trees associated with
3028 its parents.  In particular, Git does not attempt to record file renames
3029 explicitly, though it can identify cases where the existence of the same
3030 file data at changing paths suggests a rename.  (See, for example, the
3031 `-M` option to linkgit:git-diff[1]).
3033 A commit is usually created by linkgit:git-commit[1], which creates a
3034 commit whose parent is normally the current HEAD, and whose tree is
3035 taken from the content currently stored in the index.
3037 [[tree-object]]
3038 Tree Object
3039 ~~~~~~~~~~~
3041 The ever-versatile linkgit:git-show[1] command can also be used to
3042 examine tree objects, but linkgit:git-ls-tree[1] will give you more
3043 details:
3045 ------------------------------------------------
3046 $ git ls-tree fb3a8bdd0ce
3047 100644 blob 63c918c667fa005ff12ad89437f2fdc80926e21c    .gitignore
3048 100644 blob 5529b198e8d14decbe4ad99db3f7fb632de0439d    .mailmap
3049 100644 blob 6ff87c4664981e4397625791c8ea3bbb5f2279a3    COPYING
3050 040000 tree 2fb783e477100ce076f6bf57e4a6f026013dc745    Documentation
3051 100755 blob 3c0032cec592a765692234f1cba47dfdcc3a9200    GIT-VERSION-GEN
3052 100644 blob 289b046a443c0647624607d471289b2c7dcd470b    INSTALL
3053 100644 blob 4eb463797adc693dc168b926b6932ff53f17d0b1    Makefile
3054 100644 blob 548142c327a6790ff8821d67c2ee1eff7a656b52    README
3056 ------------------------------------------------
3058 As you can see, a tree object contains a list of entries, each with a
3059 mode, object type, SHA-1 name, and name, sorted by name.  It represents
3060 the contents of a single directory tree.
3062 The object type may be a blob, representing the contents of a file, or
3063 another tree, representing the contents of a subdirectory.  Since trees
3064 and blobs, like all other objects, are named by the SHA-1 hash of their
3065 contents, two trees have the same SHA-1 name if and only if their
3066 contents (including, recursively, the contents of all subdirectories)
3067 are identical.  This allows Git to quickly determine the differences
3068 between two related tree objects, since it can ignore any entries with
3069 identical object names.
3071 (Note: in the presence of submodules, trees may also have commits as
3072 entries.  See <<submodules>> for documentation.)
3074 Note that the files all have mode 644 or 755: Git actually only pays
3075 attention to the executable bit.
3077 [[blob-object]]
3078 Blob Object
3079 ~~~~~~~~~~~
3081 You can use linkgit:git-show[1] to examine the contents of a blob; take,
3082 for example, the blob in the entry for `COPYING` from the tree above:
3084 ------------------------------------------------
3085 $ git show 6ff87c4664
3087  Note that the only valid version of the GPL as far as this project
3088  is concerned is _this_ particular version of the license (ie v2, not
3089  v2.2 or v3.x or whatever), unless explicitly otherwise stated.
3091 ------------------------------------------------
3093 A "blob" object is nothing but a binary blob of data.  It doesn't refer
3094 to anything else or have attributes of any kind.
3096 Since the blob is entirely defined by its data, if two files in a
3097 directory tree (or in multiple different versions of the repository)
3098 have the same contents, they will share the same blob object. The object
3099 is totally independent of its location in the directory tree, and
3100 renaming a file does not change the object that file is associated with.
3102 Note that any tree or blob object can be examined using
3103 linkgit:git-show[1] with the <revision>:<path> syntax.  This can
3104 sometimes be useful for browsing the contents of a tree that is not
3105 currently checked out.
3107 [[trust]]
3108 Trust
3109 ~~~~~
3111 If you receive the SHA-1 name of a blob from one source, and its contents
3112 from another (possibly untrusted) source, you can still trust that those
3113 contents are correct as long as the SHA-1 name agrees.  This is because
3114 the SHA-1 is designed so that it is infeasible to find different contents
3115 that produce the same hash.
3117 Similarly, you need only trust the SHA-1 name of a top-level tree object
3118 to trust the contents of the entire directory that it refers to, and if
3119 you receive the SHA-1 name of a commit from a trusted source, then you
3120 can easily verify the entire history of commits reachable through
3121 parents of that commit, and all of those contents of the trees referred
3122 to by those commits.
3124 So to introduce some real trust in the system, the only thing you need
3125 to do is to digitally sign just 'one' special note, which includes the
3126 name of a top-level commit.  Your digital signature shows others
3127 that you trust that commit, and the immutability of the history of
3128 commits tells others that they can trust the whole history.
3130 In other words, you can easily validate a whole archive by just
3131 sending out a single email that tells the people the name (SHA-1 hash)
3132 of the top commit, and digitally sign that email using something
3133 like GPG/PGP.
3135 To assist in this, Git also provides the tag object...
3137 [[tag-object]]
3138 Tag Object
3139 ~~~~~~~~~~
3141 A tag object contains an object, object type, tag name, the name of the
3142 person ("tagger") who created the tag, and a message, which may contain
3143 a signature, as can be seen using linkgit:git-cat-file[1]:
3145 ------------------------------------------------
3146 $ git cat-file tag v1.5.0
3147 object 437b1b20df4b356c9342dac8d38849f24ef44f27
3148 type commit
3149 tag v1.5.0
3150 tagger Junio C Hamano <junkio@cox.net> 1171411200 +0000
3152 GIT 1.5.0
3153 -----BEGIN PGP SIGNATURE-----
3154 Version: GnuPG v1.4.6 (GNU/Linux)
3156 iD8DBQBF0lGqwMbZpPMRm5oRAuRiAJ9ohBLd7s2kqjkKlq1qqC57SbnmzQCdG4ui
3157 nLE/L9aUXdWeTFPron96DLA=
3158 =2E+0
3159 -----END PGP SIGNATURE-----
3160 ------------------------------------------------
3162 See the linkgit:git-tag[1] command to learn how to create and verify tag
3163 objects.  (Note that linkgit:git-tag[1] can also be used to create
3164 "lightweight tags", which are not tag objects at all, but just simple
3165 references whose names begin with `refs/tags/`).
3167 [[pack-files]]
3168 How Git stores objects efficiently: pack files
3169 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3171 Newly created objects are initially created in a file named after the
3172 object's SHA-1 hash (stored in `.git/objects`).
3174 Unfortunately this system becomes inefficient once a project has a
3175 lot of objects.  Try this on an old project:
3177 ------------------------------------------------
3178 $ git count-objects
3179 6930 objects, 47620 kilobytes
3180 ------------------------------------------------
3182 The first number is the number of objects which are kept in
3183 individual files.  The second is the amount of space taken up by
3184 those "loose" objects.
3186 You can save space and make Git faster by moving these loose objects in
3187 to a "pack file", which stores a group of objects in an efficient
3188 compressed format; the details of how pack files are formatted can be
3189 found in link:technical/pack-format.html[pack format].
3191 To put the loose objects into a pack, just run git repack:
3193 ------------------------------------------------
3194 $ git repack
3195 Counting objects: 6020, done.
3196 Delta compression using up to 4 threads.
3197 Compressing objects: 100% (6020/6020), done.
3198 Writing objects: 100% (6020/6020), done.
3199 Total 6020 (delta 4070), reused 0 (delta 0)
3200 ------------------------------------------------
3202 This creates a single "pack file" in .git/objects/pack/
3203 containing all currently unpacked objects.  You can then run
3205 ------------------------------------------------
3206 $ git prune
3207 ------------------------------------------------
3209 to remove any of the "loose" objects that are now contained in the
3210 pack.  This will also remove any unreferenced objects (which may be
3211 created when, for example, you use `git reset` to remove a commit).
3212 You can verify that the loose objects are gone by looking at the
3213 `.git/objects` directory or by running
3215 ------------------------------------------------
3216 $ git count-objects
3217 0 objects, 0 kilobytes
3218 ------------------------------------------------
3220 Although the object files are gone, any commands that refer to those
3221 objects will work exactly as they did before.
3223 The linkgit:git-gc[1] command performs packing, pruning, and more for
3224 you, so is normally the only high-level command you need.
3226 [[dangling-objects]]
3227 Dangling objects
3228 ~~~~~~~~~~~~~~~~
3230 The linkgit:git-fsck[1] command will sometimes complain about dangling
3231 objects.  They are not a problem.
3233 The most common cause of dangling objects is that you've rebased a
3234 branch, or you have pulled from somebody else who rebased a branch--see
3235 <<cleaning-up-history>>.  In that case, the old head of the original
3236 branch still exists, as does everything it pointed to. The branch
3237 pointer itself just doesn't, since you replaced it with another one.
3239 There are also other situations that cause dangling objects. For
3240 example, a "dangling blob" may arise because you did a `git add` of a
3241 file, but then, before you actually committed it and made it part of the
3242 bigger picture, you changed something else in that file and committed
3243 that *updated* thing--the old state that you added originally ends up
3244 not being pointed to by any commit or tree, so it's now a dangling blob
3245 object.
3247 Similarly, when the "recursive" merge strategy runs, and finds that
3248 there are criss-cross merges and thus more than one merge base (which is
3249 fairly unusual, but it does happen), it will generate one temporary
3250 midway tree (or possibly even more, if you had lots of criss-crossing
3251 merges and more than two merge bases) as a temporary internal merge
3252 base, and again, those are real objects, but the end result will not end
3253 up pointing to them, so they end up "dangling" in your repository.
3255 Generally, dangling objects aren't anything to worry about. They can
3256 even be very useful: if you screw something up, the dangling objects can
3257 be how you recover your old tree (say, you did a rebase, and realized
3258 that you really didn't want to--you can look at what dangling objects
3259 you have, and decide to reset your head to some old dangling state).
3261 For commits, you can just use:
3263 ------------------------------------------------
3264 $ gitk <dangling-commit-sha-goes-here> --not --all
3265 ------------------------------------------------
3267 This asks for all the history reachable from the given commit but not
3268 from any branch, tag, or other reference.  If you decide it's something
3269 you want, you can always create a new reference to it, e.g.,
3271 ------------------------------------------------
3272 $ git branch recovered-branch <dangling-commit-sha-goes-here>
3273 ------------------------------------------------
3275 For blobs and trees, you can't do the same, but you can still examine
3276 them.  You can just do
3278 ------------------------------------------------
3279 $ git show <dangling-blob/tree-sha-goes-here>
3280 ------------------------------------------------
3282 to show what the contents of the blob were (or, for a tree, basically
3283 what the `ls` for that directory was), and that may give you some idea
3284 of what the operation was that left that dangling object.
3286 Usually, dangling blobs and trees aren't very interesting. They're
3287 almost always the result of either being a half-way mergebase (the blob
3288 will often even have the conflict markers from a merge in it, if you
3289 have had conflicting merges that you fixed up by hand), or simply
3290 because you interrupted a `git fetch` with ^C or something like that,
3291 leaving _some_ of the new objects in the object database, but just
3292 dangling and useless.
3294 Anyway, once you are sure that you're not interested in any dangling
3295 state, you can just prune all unreachable objects:
3297 ------------------------------------------------
3298 $ git prune
3299 ------------------------------------------------
3301 and they'll be gone. (You should only run `git prune` on a quiescent
3302 repository--it's kind of like doing a filesystem fsck recovery: you
3303 don't want to do that while the filesystem is mounted.
3304 `git prune` is designed not to cause any harm in such cases of concurrent
3305 accesses to a repository but you might receive confusing or scary messages.)
3307 [[recovering-from-repository-corruption]]
3308 Recovering from repository corruption
3309 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3311 By design, Git treats data trusted to it with caution.  However, even in
3312 the absence of bugs in Git itself, it is still possible that hardware or
3313 operating system errors could corrupt data.
3315 The first defense against such problems is backups.  You can back up a
3316 Git directory using clone, or just using cp, tar, or any other backup
3317 mechanism.
3319 As a last resort, you can search for the corrupted objects and attempt
3320 to replace them by hand.  Back up your repository before attempting this
3321 in case you corrupt things even more in the process.
3323 We'll assume that the problem is a single missing or corrupted blob,
3324 which is sometimes a solvable problem.  (Recovering missing trees and
3325 especially commits is *much* harder).
3327 Before starting, verify that there is corruption, and figure out where
3328 it is with linkgit:git-fsck[1]; this may be time-consuming.
3330 Assume the output looks like this:
3332 ------------------------------------------------
3333 $ git fsck --full --no-dangling
3334 broken link from    tree 2d9263c6d23595e7cb2a21e5ebbb53655278dff8
3335               to    blob 4b9458b3786228369c63936db65827de3cc06200
3336 missing blob 4b9458b3786228369c63936db65827de3cc06200
3337 ------------------------------------------------
3339 Now you know that blob 4b9458b3 is missing, and that the tree 2d9263c6
3340 points to it.  If you could find just one copy of that missing blob
3341 object, possibly in some other repository, you could move it into
3342 `.git/objects/4b/9458b3...` and be done.  Suppose you can't.  You can
3343 still examine the tree that pointed to it with linkgit:git-ls-tree[1],
3344 which might output something like:
3346 ------------------------------------------------
3347 $ git ls-tree 2d9263c6d23595e7cb2a21e5ebbb53655278dff8
3348 100644 blob 8d14531846b95bfa3564b58ccfb7913a034323b8    .gitignore
3349 100644 blob ebf9bf84da0aab5ed944264a5db2a65fe3a3e883    .mailmap
3350 100644 blob ca442d313d86dc67e0a2e5d584b465bd382cbf5c    COPYING
3352 100644 blob 4b9458b3786228369c63936db65827de3cc06200    myfile
3354 ------------------------------------------------
3356 So now you know that the missing blob was the data for a file named
3357 `myfile`.  And chances are you can also identify the directory--let's
3358 say it's in `somedirectory`.  If you're lucky the missing copy might be
3359 the same as the copy you have checked out in your working tree at
3360 `somedirectory/myfile`; you can test whether that's right with
3361 linkgit:git-hash-object[1]:
3363 ------------------------------------------------
3364 $ git hash-object -w somedirectory/myfile
3365 ------------------------------------------------
3367 which will create and store a blob object with the contents of
3368 somedirectory/myfile, and output the SHA-1 of that object.  if you're
3369 extremely lucky it might be 4b9458b3786228369c63936db65827de3cc06200, in
3370 which case you've guessed right, and the corruption is fixed!
3372 Otherwise, you need more information.  How do you tell which version of
3373 the file has been lost?
3375 The easiest way to do this is with:
3377 ------------------------------------------------
3378 $ git log --raw --all --full-history -- somedirectory/myfile
3379 ------------------------------------------------
3381 Because you're asking for raw output, you'll now get something like
3383 ------------------------------------------------
3384 commit abc
3385 Author:
3386 Date:
3388 :100644 100644 4b9458b... newsha... M somedirectory/myfile
3391 commit xyz
3392 Author:
3393 Date:
3396 :100644 100644 oldsha... 4b9458b... M somedirectory/myfile
3397 ------------------------------------------------
3399 This tells you that the immediately following version of the file was
3400 "newsha", and that the immediately preceding version was "oldsha".
3401 You also know the commit messages that went with the change from oldsha
3402 to 4b9458b and with the change from 4b9458b to newsha.
3404 If you've been committing small enough changes, you may now have a good
3405 shot at reconstructing the contents of the in-between state 4b9458b.
3407 If you can do that, you can now recreate the missing object with
3409 ------------------------------------------------
3410 $ git hash-object -w <recreated-file>
3411 ------------------------------------------------
3413 and your repository is good again!
3415 (Btw, you could have ignored the `fsck`, and started with doing a
3417 ------------------------------------------------
3418 $ git log --raw --all
3419 ------------------------------------------------
3421 and just looked for the sha of the missing object (4b9458b..) in that
3422 whole thing. It's up to you--Git does *have* a lot of information, it is
3423 just missing one particular blob version.
3425 [[the-index]]
3426 The index
3427 -----------
3429 The index is a binary file (generally kept in `.git/index`) containing a
3430 sorted list of path names, each with permissions and the SHA-1 of a blob
3431 object; linkgit:git-ls-files[1] can show you the contents of the index:
3433 -------------------------------------------------
3434 $ git ls-files --stage
3435 100644 63c918c667fa005ff12ad89437f2fdc80926e21c 0       .gitignore
3436 100644 5529b198e8d14decbe4ad99db3f7fb632de0439d 0       .mailmap
3437 100644 6ff87c4664981e4397625791c8ea3bbb5f2279a3 0       COPYING
3438 100644 a37b2152bd26be2c2289e1f57a292534a51a93c7 0       Documentation/.gitignore
3439 100644 fbefe9a45b00a54b58d94d06eca48b03d40a50e0 0       Documentation/Makefile
3441 100644 2511aef8d89ab52be5ec6a5e46236b4b6bcd07ea 0       xdiff/xtypes.h
3442 100644 2ade97b2574a9f77e7ae4002a4e07a6a38e46d07 0       xdiff/xutils.c
3443 100644 d5de8292e05e7c36c4b68857c1cf9855e3d2f70a 0       xdiff/xutils.h
3444 -------------------------------------------------
3446 Note that in older documentation you may see the index called the
3447 "current directory cache" or just the "cache".  It has three important
3448 properties:
3450 1. The index contains all the information necessary to generate a single
3451 (uniquely determined) tree object.
3453 For example, running linkgit:git-commit[1] generates this tree object
3454 from the index, stores it in the object database, and uses it as the
3455 tree object associated with the new commit.
3457 2. The index enables fast comparisons between the tree object it defines
3458 and the working tree.
3460 It does this by storing some additional data for each entry (such as
3461 the last modified time).  This data is not displayed above, and is not
3462 stored in the created tree object, but it can be used to determine
3463 quickly which files in the working directory differ from what was
3464 stored in the index, and thus save Git from having to read all of the
3465 data from such files to look for changes.
3467 3. It can efficiently represent information about merge conflicts
3468 between different tree objects, allowing each pathname to be
3469 associated with sufficient information about the trees involved that
3470 you can create a three-way merge between them.
3472 We saw in <<conflict-resolution>> that during a merge the index can
3473 store multiple versions of a single file (called "stages").  The third
3474 column in the linkgit:git-ls-files[1] output above is the stage
3475 number, and will take on values other than 0 for files with merge
3476 conflicts.
3478 The index is thus a sort of temporary staging area, which is filled with
3479 a tree which you are in the process of working on.
3481 If you blow the index away entirely, you generally haven't lost any
3482 information as long as you have the name of the tree that it described.
3484 [[submodules]]
3485 Submodules
3486 ==========
3488 Large projects are often composed of smaller, self-contained modules.  For
3489 example, an embedded Linux distribution's source tree would include every
3490 piece of software in the distribution with some local modifications; a movie
3491 player might need to build against a specific, known-working version of a
3492 decompression library; several independent programs might all share the same
3493 build scripts.
3495 With centralized revision control systems this is often accomplished by
3496 including every module in one single repository.  Developers can check out
3497 all modules or only the modules they need to work with.  They can even modify
3498 files across several modules in a single commit while moving things around
3499 or updating APIs and translations.
3501 Git does not allow partial checkouts, so duplicating this approach in Git
3502 would force developers to keep a local copy of modules they are not
3503 interested in touching.  Commits in an enormous checkout would be slower
3504 than you'd expect as Git would have to scan every directory for changes.
3505 If modules have a lot of local history, clones would take forever.
3507 On the plus side, distributed revision control systems can much better
3508 integrate with external sources.  In a centralized model, a single arbitrary
3509 snapshot of the external project is exported from its own revision control
3510 and then imported into the local revision control on a vendor branch.  All
3511 the history is hidden.  With distributed revision control you can clone the
3512 entire external history and much more easily follow development and re-merge
3513 local changes.
3515 Git's submodule support allows a repository to contain, as a subdirectory, a
3516 checkout of an external project.  Submodules maintain their own identity;
3517 the submodule support just stores the submodule repository location and
3518 commit ID, so other developers who clone the containing project
3519 ("superproject") can easily clone all the submodules at the same revision.
3520 Partial checkouts of the superproject are possible: you can tell Git to
3521 clone none, some or all of the submodules.
3523 The linkgit:git-submodule[1] command is available since Git 1.5.3.  Users
3524 with Git 1.5.2 can look up the submodule commits in the repository and
3525 manually check them out; earlier versions won't recognize the submodules at
3526 all.
3528 To see how submodule support works, create four example
3529 repositories that can be used later as a submodule:
3531 -------------------------------------------------
3532 $ mkdir ~/git
3533 $ cd ~/git
3534 $ for i in a b c d
3536         mkdir $i
3537         cd $i
3538         git init
3539         echo "module $i" > $i.txt
3540         git add $i.txt
3541         git commit -m "Initial commit, submodule $i"
3542         cd ..
3543 done
3544 -------------------------------------------------
3546 Now create the superproject and add all the submodules:
3548 -------------------------------------------------
3549 $ mkdir super
3550 $ cd super
3551 $ git init
3552 $ for i in a b c d
3554         git submodule add ~/git/$i $i
3555 done
3556 -------------------------------------------------
3558 NOTE: Do not use local URLs here if you plan to publish your superproject!
3560 See what files `git submodule` created:
3562 -------------------------------------------------
3563 $ ls -a
3564 .  ..  .git  .gitmodules  a  b  c  d
3565 -------------------------------------------------
3567 The `git submodule add <repo> <path>` command does a couple of things:
3569 - It clones the submodule from `<repo>` to the given `<path>` under the
3570   current directory and by default checks out the master branch.
3571 - It adds the submodule's clone path to the linkgit:gitmodules[5] file and
3572   adds this file to the index, ready to be committed.
3573 - It adds the submodule's current commit ID to the index, ready to be
3574   committed.
3576 Commit the superproject:
3578 -------------------------------------------------
3579 $ git commit -m "Add submodules a, b, c and d."
3580 -------------------------------------------------
3582 Now clone the superproject:
3584 -------------------------------------------------
3585 $ cd ..
3586 $ git clone super cloned
3587 $ cd cloned
3588 -------------------------------------------------
3590 The submodule directories are there, but they're empty:
3592 -------------------------------------------------
3593 $ ls -a a
3594 .  ..
3595 $ git submodule status
3596 -d266b9873ad50488163457f025db7cdd9683d88b a
3597 -e81d457da15309b4fef4249aba9b50187999670d b
3598 -c1536a972b9affea0f16e0680ba87332dc059146 c
3599 -d96249ff5d57de5de093e6baff9e0aafa5276a74 d
3600 -------------------------------------------------
3602 NOTE: The commit object names shown above would be different for you, but they
3603 should match the HEAD commit object names of your repositories.  You can check
3604 it by running `git ls-remote ../a`.
3606 Pulling down the submodules is a two-step process. First run `git submodule
3607 init` to add the submodule repository URLs to `.git/config`:
3609 -------------------------------------------------
3610 $ git submodule init
3611 -------------------------------------------------
3613 Now use `git submodule update` to clone the repositories and check out the
3614 commits specified in the superproject:
3616 -------------------------------------------------
3617 $ git submodule update
3618 $ cd a
3619 $ ls -a
3620 .  ..  .git  a.txt
3621 -------------------------------------------------
3623 One major difference between `git submodule update` and `git submodule add` is
3624 that `git submodule update` checks out a specific commit, rather than the tip
3625 of a branch. It's like checking out a tag: the head is detached, so you're not
3626 working on a branch.
3628 -------------------------------------------------
3629 $ git branch
3630 * (detached from d266b98)
3631   master
3632 -------------------------------------------------
3634 If you want to make a change within a submodule and you have a detached head,
3635 then you should create or checkout a branch, make your changes, publish the
3636 change within the submodule, and then update the superproject to reference the
3637 new commit:
3639 -------------------------------------------------
3640 $ git checkout master
3641 -------------------------------------------------
3645 -------------------------------------------------
3646 $ git checkout -b fix-up
3647 -------------------------------------------------
3649 then
3651 -------------------------------------------------
3652 $ echo "adding a line again" >> a.txt
3653 $ git commit -a -m "Updated the submodule from within the superproject."
3654 $ git push
3655 $ cd ..
3656 $ git diff
3657 diff --git a/a b/a
3658 index d266b98..261dfac 160000
3659 --- a/a
3660 +++ b/a
3661 @@ -1 +1 @@
3662 -Subproject commit d266b9873ad50488163457f025db7cdd9683d88b
3663 +Subproject commit 261dfac35cb99d380eb966e102c1197139f7fa24
3664 $ git add a
3665 $ git commit -m "Updated submodule a."
3666 $ git push
3667 -------------------------------------------------
3669 You have to run `git submodule update` after `git pull` if you want to update
3670 submodules, too.
3672 Pitfalls with submodules
3673 ------------------------
3675 Always publish the submodule change before publishing the change to the
3676 superproject that references it. If you forget to publish the submodule change,
3677 others won't be able to clone the repository:
3679 -------------------------------------------------
3680 $ cd ~/git/super/a
3681 $ echo i added another line to this file >> a.txt
3682 $ git commit -a -m "doing it wrong this time"
3683 $ cd ..
3684 $ git add a
3685 $ git commit -m "Updated submodule a again."
3686 $ git push
3687 $ cd ~/git/cloned
3688 $ git pull
3689 $ git submodule update
3690 error: pathspec '261dfac35cb99d380eb966e102c1197139f7fa24' did not match any file(s) known to git.
3691 Did you forget to 'git add'?
3692 Unable to checkout '261dfac35cb99d380eb966e102c1197139f7fa24' in submodule path 'a'
3693 -------------------------------------------------
3695 In older Git versions it could be easily forgotten to commit new or modified
3696 files in a submodule, which silently leads to similar problems as not pushing
3697 the submodule changes. Starting with Git 1.7.0 both `git status` and `git diff`
3698 in the superproject show submodules as modified when they contain new or
3699 modified files to protect against accidentally committing such a state. `git
3700 diff` will also add a `-dirty` to the work tree side when generating patch
3701 output or used with the `--submodule` option:
3703 -------------------------------------------------
3704 $ git diff
3705 diff --git a/sub b/sub
3706 --- a/sub
3707 +++ b/sub
3708 @@ -1 +1 @@
3709 -Subproject commit 3f356705649b5d566d97ff843cf193359229a453
3710 +Subproject commit 3f356705649b5d566d97ff843cf193359229a453-dirty
3711 $ git diff --submodule
3712 Submodule sub 3f35670..3f35670-dirty:
3713 -------------------------------------------------
3715 You also should not rewind branches in a submodule beyond commits that were
3716 ever recorded in any superproject.
3718 It's not safe to run `git submodule update` if you've made and committed
3719 changes within a submodule without checking out a branch first. They will be
3720 silently overwritten:
3722 -------------------------------------------------
3723 $ cat a.txt
3724 module a
3725 $ echo line added from private2 >> a.txt
3726 $ git commit -a -m "line added inside private2"
3727 $ cd ..
3728 $ git submodule update
3729 Submodule path 'a': checked out 'd266b9873ad50488163457f025db7cdd9683d88b'
3730 $ cd a
3731 $ cat a.txt
3732 module a
3733 -------------------------------------------------
3735 NOTE: The changes are still visible in the submodule's reflog.
3737 If you have uncommitted changes in your submodule working tree, `git
3738 submodule update` will not overwrite them.  Instead, you get the usual
3739 warning about not being able switch from a dirty branch.
3741 [[low-level-operations]]
3742 Low-level Git operations
3743 ========================
3745 Many of the higher-level commands were originally implemented as shell
3746 scripts using a smaller core of low-level Git commands.  These can still
3747 be useful when doing unusual things with Git, or just as a way to
3748 understand its inner workings.
3750 [[object-manipulation]]
3751 Object access and manipulation
3752 ------------------------------
3754 The linkgit:git-cat-file[1] command can show the contents of any object,
3755 though the higher-level linkgit:git-show[1] is usually more useful.
3757 The linkgit:git-commit-tree[1] command allows constructing commits with
3758 arbitrary parents and trees.
3760 A tree can be created with linkgit:git-write-tree[1] and its data can be
3761 accessed by linkgit:git-ls-tree[1].  Two trees can be compared with
3762 linkgit:git-diff-tree[1].
3764 A tag is created with linkgit:git-mktag[1], and the signature can be
3765 verified by linkgit:git-verify-tag[1], though it is normally simpler to
3766 use linkgit:git-tag[1] for both.
3768 [[the-workflow]]
3769 The Workflow
3770 ------------
3772 High-level operations such as linkgit:git-commit[1],
3773 linkgit:git-checkout[1] and linkgit:git-reset[1] work by moving data
3774 between the working tree, the index, and the object database.  Git
3775 provides low-level operations which perform each of these steps
3776 individually.
3778 Generally, all Git operations work on the index file. Some operations
3779 work *purely* on the index file (showing the current state of the
3780 index), but most operations move data between the index file and either
3781 the database or the working directory. Thus there are four main
3782 combinations:
3784 [[working-directory-to-index]]
3785 working directory -> index
3786 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3788 The linkgit:git-update-index[1] command updates the index with
3789 information from the working directory.  You generally update the
3790 index information by just specifying the filename you want to update,
3791 like so:
3793 -------------------------------------------------
3794 $ git update-index filename
3795 -------------------------------------------------
3797 but to avoid common mistakes with filename globbing etc., the command
3798 will not normally add totally new entries or remove old entries,
3799 i.e. it will normally just update existing cache entries.
3801 To tell Git that yes, you really do realize that certain files no
3802 longer exist, or that new files should be added, you
3803 should use the `--remove` and `--add` flags respectively.
3805 NOTE! A `--remove` flag does 'not' mean that subsequent filenames will
3806 necessarily be removed: if the files still exist in your directory
3807 structure, the index will be updated with their new status, not
3808 removed. The only thing `--remove` means is that update-index will be
3809 considering a removed file to be a valid thing, and if the file really
3810 does not exist any more, it will update the index accordingly.
3812 As a special case, you can also do `git update-index --refresh`, which
3813 will refresh the "stat" information of each index to match the current
3814 stat information. It will 'not' update the object status itself, and
3815 it will only update the fields that are used to quickly test whether
3816 an object still matches its old backing store object.
3818 The previously introduced linkgit:git-add[1] is just a wrapper for
3819 linkgit:git-update-index[1].
3821 [[index-to-object-database]]
3822 index -> object database
3823 ~~~~~~~~~~~~~~~~~~~~~~~~
3825 You write your current index file to a "tree" object with the program
3827 -------------------------------------------------
3828 $ git write-tree
3829 -------------------------------------------------
3831 that doesn't come with any options--it will just write out the
3832 current index into the set of tree objects that describe that state,
3833 and it will return the name of the resulting top-level tree. You can
3834 use that tree to re-generate the index at any time by going in the
3835 other direction:
3837 [[object-database-to-index]]
3838 object database -> index
3839 ~~~~~~~~~~~~~~~~~~~~~~~~
3841 You read a "tree" file from the object database, and use that to
3842 populate (and overwrite--don't do this if your index contains any
3843 unsaved state that you might want to restore later!) your current
3844 index.  Normal operation is just
3846 -------------------------------------------------
3847 $ git read-tree <SHA-1 of tree>
3848 -------------------------------------------------
3850 and your index file will now be equivalent to the tree that you saved
3851 earlier. However, that is only your 'index' file: your working
3852 directory contents have not been modified.
3854 [[index-to-working-directory]]
3855 index -> working directory
3856 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3858 You update your working directory from the index by "checking out"
3859 files. This is not a very common operation, since normally you'd just
3860 keep your files updated, and rather than write to your working
3861 directory, you'd tell the index files about the changes in your
3862 working directory (i.e. `git update-index`).
3864 However, if you decide to jump to a new version, or check out somebody
3865 else's version, or just restore a previous tree, you'd populate your
3866 index file with read-tree, and then you need to check out the result
3867 with
3869 -------------------------------------------------
3870 $ git checkout-index filename
3871 -------------------------------------------------
3873 or, if you want to check out all of the index, use `-a`.
3875 NOTE! `git checkout-index` normally refuses to overwrite old files, so
3876 if you have an old version of the tree already checked out, you will
3877 need to use the `-f` flag ('before' the `-a` flag or the filename) to
3878 'force' the checkout.
3881 Finally, there are a few odds and ends which are not purely moving
3882 from one representation to the other:
3884 [[tying-it-all-together]]
3885 Tying it all together
3886 ~~~~~~~~~~~~~~~~~~~~~
3888 To commit a tree you have instantiated with `git write-tree`, you'd
3889 create a "commit" object that refers to that tree and the history
3890 behind it--most notably the "parent" commits that preceded it in
3891 history.
3893 Normally a "commit" has one parent: the previous state of the tree
3894 before a certain change was made. However, sometimes it can have two
3895 or more parent commits, in which case we call it a "merge", due to the
3896 fact that such a commit brings together ("merges") two or more
3897 previous states represented by other commits.
3899 In other words, while a "tree" represents a particular directory state
3900 of a working directory, a "commit" represents that state in time,
3901 and explains how we got there.
3903 You create a commit object by giving it the tree that describes the
3904 state at the time of the commit, and a list of parents:
3906 -------------------------------------------------
3907 $ git commit-tree <tree> -p <parent> [(-p <parent2>)...]
3908 -------------------------------------------------
3910 and then giving the reason for the commit on stdin (either through
3911 redirection from a pipe or file, or by just typing it at the tty).
3913 `git commit-tree` will return the name of the object that represents
3914 that commit, and you should save it away for later use. Normally,
3915 you'd commit a new `HEAD` state, and while Git doesn't care where you
3916 save the note about that state, in practice we tend to just write the
3917 result to the file pointed at by `.git/HEAD`, so that we can always see
3918 what the last committed state was.
3920 Here is a picture that illustrates how various pieces fit together:
3922 ------------
3924                      commit-tree
3925                       commit obj
3926                        +----+
3927                        |    |
3928                        |    |
3929                        V    V
3930                     +-----------+
3931                     | Object DB |
3932                     |  Backing  |
3933                     |   Store   |
3934                     +-----------+
3935                        ^
3936            write-tree  |     |
3937              tree obj  |     |
3938                        |     |  read-tree
3939                        |     |  tree obj
3940                              V
3941                     +-----------+
3942                     |   Index   |
3943                     |  "cache"  |
3944                     +-----------+
3945          update-index  ^
3946              blob obj  |     |
3947                        |     |
3948     checkout-index -u  |     |  checkout-index
3949              stat      |     |  blob obj
3950                              V
3951                     +-----------+
3952                     |  Working  |
3953                     | Directory |
3954                     +-----------+
3956 ------------
3959 [[examining-the-data]]
3960 Examining the data
3961 ------------------
3963 You can examine the data represented in the object database and the
3964 index with various helper tools. For every object, you can use
3965 linkgit:git-cat-file[1] to examine details about the
3966 object:
3968 -------------------------------------------------
3969 $ git cat-file -t <objectname>
3970 -------------------------------------------------
3972 shows the type of the object, and once you have the type (which is
3973 usually implicit in where you find the object), you can use
3975 -------------------------------------------------
3976 $ git cat-file blob|tree|commit|tag <objectname>
3977 -------------------------------------------------
3979 to show its contents. NOTE! Trees have binary content, and as a result
3980 there is a special helper for showing that content, called
3981 `git ls-tree`, which turns the binary content into a more easily
3982 readable form.
3984 It's especially instructive to look at "commit" objects, since those
3985 tend to be small and fairly self-explanatory. In particular, if you
3986 follow the convention of having the top commit name in `.git/HEAD`,
3987 you can do
3989 -------------------------------------------------
3990 $ git cat-file commit HEAD
3991 -------------------------------------------------
3993 to see what the top commit was.
3995 [[merging-multiple-trees]]
3996 Merging multiple trees
3997 ----------------------
3999 Git can help you perform a three-way merge, which can in turn be
4000 used for a many-way merge by repeating the merge procedure several
4001 times.  The usual situation is that you only do one three-way merge
4002 (reconciling two lines of history) and commit the result, but if
4003 you like to, you can merge several branches in one go.
4005 To perform a three-way merge, you start with the two commits you
4006 want to merge, find their closest common parent (a third commit),
4007 and compare the trees corresponding to these three commits.
4009 To get the "base" for the merge, look up the common parent of two
4010 commits:
4012 -------------------------------------------------
4013 $ git merge-base <commit1> <commit2>
4014 -------------------------------------------------
4016 This prints the name of a commit they are both based on. You should
4017 now look up the tree objects of those commits, which you can easily
4018 do with
4020 -------------------------------------------------
4021 $ git cat-file commit <commitname> | head -1
4022 -------------------------------------------------
4024 since the tree object information is always the first line in a commit
4025 object.
4027 Once you know the three trees you are going to merge (the one "original"
4028 tree, aka the common tree, and the two "result" trees, aka the branches
4029 you want to merge), you do a "merge" read into the index. This will
4030 complain if it has to throw away your old index contents, so you should
4031 make sure that you've committed those--in fact you would normally
4032 always do a merge against your last commit (which should thus match what
4033 you have in your current index anyway).
4035 To do the merge, do
4037 -------------------------------------------------
4038 $ git read-tree -m -u <origtree> <yourtree> <targettree>
4039 -------------------------------------------------
4041 which will do all trivial merge operations for you directly in the
4042 index file, and you can just write the result out with
4043 `git write-tree`.
4046 [[merging-multiple-trees-2]]
4047 Merging multiple trees, continued
4048 ---------------------------------
4050 Sadly, many merges aren't trivial. If there are files that have
4051 been added, moved or removed, or if both branches have modified the
4052 same file, you will be left with an index tree that contains "merge
4053 entries" in it. Such an index tree can 'NOT' be written out to a tree
4054 object, and you will have to resolve any such merge clashes using
4055 other tools before you can write out the result.
4057 You can examine such index state with `git ls-files --unmerged`
4058 command.  An example:
4060 ------------------------------------------------
4061 $ git read-tree -m $orig HEAD $target
4062 $ git ls-files --unmerged
4063 100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1       hello.c
4064 100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2       hello.c
4065 100644 cc44c73eb783565da5831b4d820c962954019b69 3       hello.c
4066 ------------------------------------------------
4068 Each line of the `git ls-files --unmerged` output begins with
4069 the blob mode bits, blob SHA-1, 'stage number', and the
4070 filename.  The 'stage number' is Git's way to say which tree it
4071 came from: stage 1 corresponds to the `$orig` tree, stage 2 to
4072 the `HEAD` tree, and stage 3 to the `$target` tree.
4074 Earlier we said that trivial merges are done inside
4075 `git read-tree -m`.  For example, if the file did not change
4076 from `$orig` to `HEAD` or `$target`, or if the file changed
4077 from `$orig` to `HEAD` and `$orig` to `$target` the same way,
4078 obviously the final outcome is what is in `HEAD`.  What the
4079 above example shows is that file `hello.c` was changed from
4080 `$orig` to `HEAD` and `$orig` to `$target` in a different way.
4081 You could resolve this by running your favorite 3-way merge
4082 program, e.g.  `diff3`, `merge`, or Git's own merge-file, on
4083 the blob objects from these three stages yourself, like this:
4085 ------------------------------------------------
4086 $ git cat-file blob 263414f... >hello.c~1
4087 $ git cat-file blob 06fa6a2... >hello.c~2
4088 $ git cat-file blob cc44c73... >hello.c~3
4089 $ git merge-file hello.c~2 hello.c~1 hello.c~3
4090 ------------------------------------------------
4092 This would leave the merge result in `hello.c~2` file, along
4093 with conflict markers if there are conflicts.  After verifying
4094 the merge result makes sense, you can tell Git what the final
4095 merge result for this file is by:
4097 -------------------------------------------------
4098 $ mv -f hello.c~2 hello.c
4099 $ git update-index hello.c
4100 -------------------------------------------------
4102 When a path is in the "unmerged" state, running `git update-index` for
4103 that path tells Git to mark the path resolved.
4105 The above is the description of a Git merge at the lowest level,
4106 to help you understand what conceptually happens under the hood.
4107 In practice, nobody, not even Git itself, runs `git cat-file` three times
4108 for this.  There is a `git merge-index` program that extracts the
4109 stages to temporary files and calls a "merge" script on it:
4111 -------------------------------------------------
4112 $ git merge-index git-merge-one-file hello.c
4113 -------------------------------------------------
4115 and that is what higher level `git merge -s resolve` is implemented with.
4117 [[hacking-git]]
4118 Hacking Git
4119 ===========
4121 This chapter covers internal details of the Git implementation which
4122 probably only Git developers need to understand.
4124 [[object-details]]
4125 Object storage format
4126 ---------------------
4128 All objects have a statically determined "type" which identifies the
4129 format of the object (i.e. how it is used, and how it can refer to other
4130 objects).  There are currently four different object types: "blob",
4131 "tree", "commit", and "tag".
4133 Regardless of object type, all objects share the following
4134 characteristics: they are all deflated with zlib, and have a header
4135 that not only specifies their type, but also provides size information
4136 about the data in the object.  It's worth noting that the SHA-1 hash
4137 that is used to name the object is the hash of the original data
4138 plus this header, so `sha1sum` 'file' does not match the object name
4139 for 'file'.
4141 As a result, the general consistency of an object can always be tested
4142 independently of the contents or the type of the object: all objects can
4143 be validated by verifying that (a) their hashes match the content of the
4144 file and (b) the object successfully inflates to a stream of bytes that
4145 forms a sequence of
4146 `<ascii type without space> + <space> + <ascii decimal size> +
4147 <byte\0> + <binary object data>`.
4149 The structured objects can further have their structure and
4150 connectivity to other objects verified. This is generally done with
4151 the `git fsck` program, which generates a full dependency graph
4152 of all objects, and verifies their internal consistency (in addition
4153 to just verifying their superficial consistency through the hash).
4155 [[birdview-on-the-source-code]]
4156 A birds-eye view of Git's source code
4157 -------------------------------------
4159 It is not always easy for new developers to find their way through Git's
4160 source code.  This section gives you a little guidance to show where to
4161 start.
4163 A good place to start is with the contents of the initial commit, with:
4165 ----------------------------------------------------
4166 $ git checkout e83c5163
4167 ----------------------------------------------------
4169 The initial revision lays the foundation for almost everything Git has
4170 today, but is small enough to read in one sitting.
4172 Note that terminology has changed since that revision.  For example, the
4173 README in that revision uses the word "changeset" to describe what we
4174 now call a <<def_commit_object,commit>>.
4176 Also, we do not call it "cache" any more, but rather "index"; however, the
4177 file is still called `cache.h`.  Remark: Not much reason to change it now,
4178 especially since there is no good single name for it anyway, because it is
4179 basically _the_ header file which is included by _all_ of Git's C sources.
4181 If you grasp the ideas in that initial commit, you should check out a
4182 more recent version and skim `cache.h`, `object.h` and `commit.h`.
4184 In the early days, Git (in the tradition of UNIX) was a bunch of programs
4185 which were extremely simple, and which you used in scripts, piping the
4186 output of one into another. This turned out to be good for initial
4187 development, since it was easier to test new things.  However, recently
4188 many of these parts have become builtins, and some of the core has been
4189 "libified", i.e. put into libgit.a for performance, portability reasons,
4190 and to avoid code duplication.
4192 By now, you know what the index is (and find the corresponding data
4193 structures in `cache.h`), and that there are just a couple of object types
4194 (blobs, trees, commits and tags) which inherit their common structure from
4195 `struct object`, which is their first member (and thus, you can cast e.g.
4196 `(struct object *)commit` to achieve the _same_ as `&commit->object`, i.e.
4197 get at the object name and flags).
4199 Now is a good point to take a break to let this information sink in.
4201 Next step: get familiar with the object naming.  Read <<naming-commits>>.
4202 There are quite a few ways to name an object (and not only revisions!).
4203 All of these are handled in `sha1_name.c`. Just have a quick look at
4204 the function `get_sha1()`. A lot of the special handling is done by
4205 functions like `get_sha1_basic()` or the likes.
4207 This is just to get you into the groove for the most libified part of Git:
4208 the revision walker.
4210 Basically, the initial version of `git log` was a shell script:
4212 ----------------------------------------------------------------
4213 $ git-rev-list --pretty $(git-rev-parse --default HEAD "$@") | \
4214         LESS=-S ${PAGER:-less}
4215 ----------------------------------------------------------------
4217 What does this mean?
4219 `git rev-list` is the original version of the revision walker, which
4220 _always_ printed a list of revisions to stdout.  It is still functional,
4221 and needs to, since most new Git commands start out as scripts using
4222 `git rev-list`.
4224 `git rev-parse` is not as important any more; it was only used to filter out
4225 options that were relevant for the different plumbing commands that were
4226 called by the script.
4228 Most of what `git rev-list` did is contained in `revision.c` and
4229 `revision.h`.  It wraps the options in a struct named `rev_info`, which
4230 controls how and what revisions are walked, and more.
4232 The original job of `git rev-parse` is now taken by the function
4233 `setup_revisions()`, which parses the revisions and the common command-line
4234 options for the revision walker. This information is stored in the struct
4235 `rev_info` for later consumption. You can do your own command-line option
4236 parsing after calling `setup_revisions()`. After that, you have to call
4237 `prepare_revision_walk()` for initialization, and then you can get the
4238 commits one by one with the function `get_revision()`.
4240 If you are interested in more details of the revision walking process,
4241 just have a look at the first implementation of `cmd_log()`; call
4242 `git show v1.3.0~155^2~4` and scroll down to that function (note that you
4243 no longer need to call `setup_pager()` directly).
4245 Nowadays, `git log` is a builtin, which means that it is _contained_ in the
4246 command `git`.  The source side of a builtin is
4248 - a function called `cmd_<bla>`, typically defined in `builtin/<bla.c>`
4249   (note that older versions of Git used to have it in `builtin-<bla>.c`
4250   instead), and declared in `builtin.h`.
4252 - an entry in the `commands[]` array in `git.c`, and
4254 - an entry in `BUILTIN_OBJECTS` in the `Makefile`.
4256 Sometimes, more than one builtin is contained in one source file.  For
4257 example, `cmd_whatchanged()` and `cmd_log()` both reside in `builtin/log.c`,
4258 since they share quite a bit of code.  In that case, the commands which are
4259 _not_ named like the `.c` file in which they live have to be listed in
4260 `BUILT_INS` in the `Makefile`.
4262 `git log` looks more complicated in C than it does in the original script,
4263 but that allows for a much greater flexibility and performance.
4265 Here again it is a good point to take a pause.
4267 Lesson three is: study the code.  Really, it is the best way to learn about
4268 the organization of Git (after you know the basic concepts).
4270 So, think about something which you are interested in, say, "how can I
4271 access a blob just knowing the object name of it?".  The first step is to
4272 find a Git command with which you can do it.  In this example, it is either
4273 `git show` or `git cat-file`.
4275 For the sake of clarity, let's stay with `git cat-file`, because it
4277 - is plumbing, and
4279 - was around even in the initial commit (it literally went only through
4280   some 20 revisions as `cat-file.c`, was renamed to `builtin/cat-file.c`
4281   when made a builtin, and then saw less than 10 versions).
4283 So, look into `builtin/cat-file.c`, search for `cmd_cat_file()` and look what
4284 it does.
4286 ------------------------------------------------------------------
4287         git_config(git_default_config);
4288         if (argc != 3)
4289                 usage("git cat-file [-t|-s|-e|-p|<type>] <sha1>");
4290         if (get_sha1(argv[2], sha1))
4291                 die("Not a valid object name %s", argv[2]);
4292 ------------------------------------------------------------------
4294 Let's skip over the obvious details; the only really interesting part
4295 here is the call to `get_sha1()`.  It tries to interpret `argv[2]` as an
4296 object name, and if it refers to an object which is present in the current
4297 repository, it writes the resulting SHA-1 into the variable `sha1`.
4299 Two things are interesting here:
4301 - `get_sha1()` returns 0 on _success_.  This might surprise some new
4302   Git hackers, but there is a long tradition in UNIX to return different
4303   negative numbers in case of different errors--and 0 on success.
4305 - the variable `sha1` in the function signature of `get_sha1()` is `unsigned
4306   char *`, but is actually expected to be a pointer to `unsigned
4307   char[20]`.  This variable will contain the 160-bit SHA-1 of the given
4308   commit.  Note that whenever a SHA-1 is passed as `unsigned char *`, it
4309   is the binary representation, as opposed to the ASCII representation in
4310   hex characters, which is passed as `char *`.
4312 You will see both of these things throughout the code.
4314 Now, for the meat:
4316 -----------------------------------------------------------------------------
4317         case 0:
4318                 buf = read_object_with_reference(sha1, argv[1], &size, NULL);
4319 -----------------------------------------------------------------------------
4321 This is how you read a blob (actually, not only a blob, but any type of
4322 object).  To know how the function `read_object_with_reference()` actually
4323 works, find the source code for it (something like `git grep
4324 read_object_with | grep ":[a-z]"` in the Git repository), and read
4325 the source.
4327 To find out how the result can be used, just read on in `cmd_cat_file()`:
4329 -----------------------------------
4330         write_or_die(1, buf, size);
4331 -----------------------------------
4333 Sometimes, you do not know where to look for a feature.  In many such cases,
4334 it helps to search through the output of `git log`, and then `git show` the
4335 corresponding commit.
4337 Example: If you know that there was some test case for `git bundle`, but
4338 do not remember where it was (yes, you _could_ `git grep bundle t/`, but that
4339 does not illustrate the point!):
4341 ------------------------
4342 $ git log --no-merges t/
4343 ------------------------
4345 In the pager (`less`), just search for "bundle", go a few lines back,
4346 and see that it is in commit 18449ab0...  Now just copy this object name,
4347 and paste it into the command line
4349 -------------------
4350 $ git show 18449ab0
4351 -------------------
4353 Voila.
4355 Another example: Find out what to do in order to make some script a
4356 builtin:
4358 -------------------------------------------------
4359 $ git log --no-merges --diff-filter=A builtin/*.c
4360 -------------------------------------------------
4362 You see, Git is actually the best tool to find out about the source of Git
4363 itself!
4365 [[glossary]]
4366 Git Glossary
4367 ============
4369 include::glossary-content.txt[]
4371 [[git-quick-start]]
4372 Appendix A: Git Quick Reference
4373 ===============================
4375 This is a quick summary of the major commands; the previous chapters
4376 explain how these work in more detail.
4378 [[quick-creating-a-new-repository]]
4379 Creating a new repository
4380 -------------------------
4382 From a tarball:
4384 -----------------------------------------------
4385 $ tar xzf project.tar.gz
4386 $ cd project
4387 $ git init
4388 Initialized empty Git repository in .git/
4389 $ git add .
4390 $ git commit
4391 -----------------------------------------------
4393 From a remote repository:
4395 -----------------------------------------------
4396 $ git clone git://example.com/pub/project.git
4397 $ cd project
4398 -----------------------------------------------
4400 [[managing-branches]]
4401 Managing branches
4402 -----------------
4404 -----------------------------------------------
4405 $ git branch         # list all local branches in this repo
4406 $ git checkout test  # switch working directory to branch "test"
4407 $ git branch new     # create branch "new" starting at current HEAD
4408 $ git branch -d new  # delete branch "new"
4409 -----------------------------------------------
4411 Instead of basing a new branch on current HEAD (the default), use:
4413 -----------------------------------------------
4414 $ git branch new test    # branch named "test"
4415 $ git branch new v2.6.15 # tag named v2.6.15
4416 $ git branch new HEAD^   # commit before the most recent
4417 $ git branch new HEAD^^  # commit before that
4418 $ git branch new test~10 # ten commits before tip of branch "test"
4419 -----------------------------------------------
4421 Create and switch to a new branch at the same time:
4423 -----------------------------------------------
4424 $ git checkout -b new v2.6.15
4425 -----------------------------------------------
4427 Update and examine branches from the repository you cloned from:
4429 -----------------------------------------------
4430 $ git fetch             # update
4431 $ git branch -r         # list
4432   origin/master
4433   origin/next
4434   ...
4435 $ git checkout -b masterwork origin/master
4436 -----------------------------------------------
4438 Fetch a branch from a different repository, and give it a new
4439 name in your repository:
4441 -----------------------------------------------
4442 $ git fetch git://example.com/project.git theirbranch:mybranch
4443 $ git fetch git://example.com/project.git v2.6.15:mybranch
4444 -----------------------------------------------
4446 Keep a list of repositories you work with regularly:
4448 -----------------------------------------------
4449 $ git remote add example git://example.com/project.git
4450 $ git remote                    # list remote repositories
4451 example
4452 origin
4453 $ git remote show example       # get details
4454 * remote example
4455   URL: git://example.com/project.git
4456   Tracked remote branches
4457     master
4458     next
4459     ...
4460 $ git fetch example             # update branches from example
4461 $ git branch -r                 # list all remote branches
4462 -----------------------------------------------
4465 [[exploring-history]]
4466 Exploring history
4467 -----------------
4469 -----------------------------------------------
4470 $ gitk                      # visualize and browse history
4471 $ git log                   # list all commits
4472 $ git log src/              # ...modifying src/
4473 $ git log v2.6.15..v2.6.16  # ...in v2.6.16, not in v2.6.15
4474 $ git log master..test      # ...in branch test, not in branch master
4475 $ git log test..master      # ...in branch master, but not in test
4476 $ git log test...master     # ...in one branch, not in both
4477 $ git log -S'foo()'         # ...where difference contain "foo()"
4478 $ git log --since="2 weeks ago"
4479 $ git log -p                # show patches as well
4480 $ git show                  # most recent commit
4481 $ git diff v2.6.15..v2.6.16 # diff between two tagged versions
4482 $ git diff v2.6.15..HEAD    # diff with current head
4483 $ git grep "foo()"          # search working directory for "foo()"
4484 $ git grep v2.6.15 "foo()"  # search old tree for "foo()"
4485 $ git show v2.6.15:a.txt    # look at old version of a.txt
4486 -----------------------------------------------
4488 Search for regressions:
4490 -----------------------------------------------
4491 $ git bisect start
4492 $ git bisect bad                # current version is bad
4493 $ git bisect good v2.6.13-rc2   # last known good revision
4494 Bisecting: 675 revisions left to test after this
4495                                 # test here, then:
4496 $ git bisect good               # if this revision is good, or
4497 $ git bisect bad                # if this revision is bad.
4498                                 # repeat until done.
4499 -----------------------------------------------
4501 [[making-changes]]
4502 Making changes
4503 --------------
4505 Make sure Git knows who to blame:
4507 ------------------------------------------------
4508 $ cat >>~/.gitconfig <<\EOF
4509 [user]
4510         name = Your Name Comes Here
4511         email = you@yourdomain.example.com
4513 ------------------------------------------------
4515 Select file contents to include in the next commit, then make the
4516 commit:
4518 -----------------------------------------------
4519 $ git add a.txt    # updated file
4520 $ git add b.txt    # new file
4521 $ git rm c.txt     # old file
4522 $ git commit
4523 -----------------------------------------------
4525 Or, prepare and create the commit in one step:
4527 -----------------------------------------------
4528 $ git commit d.txt # use latest content only of d.txt
4529 $ git commit -a    # use latest content of all tracked files
4530 -----------------------------------------------
4532 [[merging]]
4533 Merging
4534 -------
4536 -----------------------------------------------
4537 $ git merge test   # merge branch "test" into the current branch
4538 $ git pull git://example.com/project.git master
4539                    # fetch and merge in remote branch
4540 $ git pull . test  # equivalent to git merge test
4541 -----------------------------------------------
4543 [[sharing-your-changes]]
4544 Sharing your changes
4545 --------------------
4547 Importing or exporting patches:
4549 -----------------------------------------------
4550 $ git format-patch origin..HEAD # format a patch for each commit
4551                                 # in HEAD but not in origin
4552 $ git am mbox # import patches from the mailbox "mbox"
4553 -----------------------------------------------
4555 Fetch a branch in a different Git repository, then merge into the
4556 current branch:
4558 -----------------------------------------------
4559 $ git pull git://example.com/project.git theirbranch
4560 -----------------------------------------------
4562 Store the fetched branch into a local branch before merging into the
4563 current branch:
4565 -----------------------------------------------
4566 $ git pull git://example.com/project.git theirbranch:mybranch
4567 -----------------------------------------------
4569 After creating commits on a local branch, update the remote
4570 branch with your commits:
4572 -----------------------------------------------
4573 $ git push ssh://example.com/project.git mybranch:theirbranch
4574 -----------------------------------------------
4576 When remote and local branch are both named "test":
4578 -----------------------------------------------
4579 $ git push ssh://example.com/project.git test
4580 -----------------------------------------------
4582 Shortcut version for a frequently used remote repository:
4584 -----------------------------------------------
4585 $ git remote add example ssh://example.com/project.git
4586 $ git push example test
4587 -----------------------------------------------
4589 [[repository-maintenance]]
4590 Repository maintenance
4591 ----------------------
4593 Check for corruption:
4595 -----------------------------------------------
4596 $ git fsck
4597 -----------------------------------------------
4599 Recompress, remove unused cruft:
4601 -----------------------------------------------
4602 $ git gc
4603 -----------------------------------------------
4606 [[todo]]
4607 Appendix B: Notes and todo list for this manual
4608 ===============================================
4610 This is a work in progress.
4612 The basic requirements:
4614 - It must be readable in order, from beginning to end, by someone
4615   intelligent with a basic grasp of the UNIX command line, but without
4616   any special knowledge of Git.  If necessary, any other prerequisites
4617   should be specifically mentioned as they arise.
4618 - Whenever possible, section headings should clearly describe the task
4619   they explain how to do, in language that requires no more knowledge
4620   than necessary: for example, "importing patches into a project" rather
4621   than "the `git am` command"
4623 Think about how to create a clear chapter dependency graph that will
4624 allow people to get to important topics without necessarily reading
4625 everything in between.
4627 Scan `Documentation/` for other stuff left out; in particular:
4629 - howto's
4630 - some of `technical/`?
4631 - hooks
4632 - list of commands in linkgit:git[1]
4634 Scan email archives for other stuff left out
4636 Scan man pages to see if any assume more background than this manual
4637 provides.
4639 Simplify beginning by suggesting disconnected head instead of
4640 temporary branch creation?
4642 Add more good examples.  Entire sections of just cookbook examples
4643 might be a good idea; maybe make an "advanced examples" section a
4644 standard end-of-chapter section?
4646 Include cross-references to the glossary, where appropriate.
4648 Document shallow clones?  See draft 1.5.0 release notes for some
4649 documentation.
4651 Add a section on working with other version control systems, including
4652 CVS, Subversion, and just imports of series of release tarballs.
4654 More details on gitweb?