Move setup_diff_pager to libgit.a
[git/jnareb-git.git] / Documentation / gittutorial.txt
blobf1cb6f3be67fbb03583a35601791f0db839fbe1b
1 gittutorial(7)
2 ==============
4 NAME
5 ----
6 gittutorial - A tutorial introduction to git (for version 1.5.1 or newer)
8 SYNOPSIS
9 --------
10 [verse]
11 git *
13 DESCRIPTION
14 -----------
16 This tutorial explains how to import a new project into git, make
17 changes to it, and share changes with other developers.
19 If you are instead primarily interested in using git to fetch a project,
20 for example, to test the latest version, you may prefer to start with
21 the first two chapters of link:user-manual.html[The Git User's Manual].
23 First, note that you can get documentation for a command such as
24 `git log --graph` with:
26 ------------------------------------------------
27 $ man git-log
28 ------------------------------------------------
30 or:
32 ------------------------------------------------
33 $ git help log
34 ------------------------------------------------
36 With the latter, you can use the manual viewer of your choice; see
37 linkgit:git-help[1] for more information.
39 It is a good idea to introduce yourself to git with your name and
40 public email address before doing any operation.  The easiest
41 way to do so is:
43 ------------------------------------------------
44 $ git config --global user.name "Your Name Comes Here"
45 $ git config --global user.email you@yourdomain.example.com
46 ------------------------------------------------
49 Importing a new project
50 -----------------------
52 Assume you have a tarball project.tar.gz with your initial work.  You
53 can place it under git revision control as follows.
55 ------------------------------------------------
56 $ tar xzf project.tar.gz
57 $ cd project
58 $ git init
59 ------------------------------------------------
61 Git will reply
63 ------------------------------------------------
64 Initialized empty Git repository in .git/
65 ------------------------------------------------
67 You've now initialized the working directory--you may notice a new
68 directory created, named ".git".
70 Next, tell git to take a snapshot of the contents of all files under the
71 current directory (note the '.'), with 'git add':
73 ------------------------------------------------
74 $ git add .
75 ------------------------------------------------
77 This snapshot is now stored in a temporary staging area which git calls
78 the "index".  You can permanently store the contents of the index in the
79 repository with 'git commit':
81 ------------------------------------------------
82 $ git commit
83 ------------------------------------------------
85 This will prompt you for a commit message.  You've now stored the first
86 version of your project in git.
88 Making changes
89 --------------
91 Modify some files, then add their updated contents to the index:
93 ------------------------------------------------
94 $ git add file1 file2 file3
95 ------------------------------------------------
97 You are now ready to commit.  You can see what is about to be committed
98 using 'git diff' with the --cached option:
100 ------------------------------------------------
101 $ git diff --cached
102 ------------------------------------------------
104 (Without --cached, 'git diff' will show you any changes that
105 you've made but not yet added to the index.)  You can also get a brief
106 summary of the situation with 'git status':
108 ------------------------------------------------
109 $ git status
110 # On branch master
111 # Changes to be committed:
112 #   (use "git reset HEAD <file>..." to unstage)
114 #       modified:   file1
115 #       modified:   file2
116 #       modified:   file3
118 ------------------------------------------------
120 If you need to make any further adjustments, do so now, and then add any
121 newly modified content to the index.  Finally, commit your changes with:
123 ------------------------------------------------
124 $ git commit
125 ------------------------------------------------
127 This will again prompt you for a message describing the change, and then
128 record a new version of the project.
130 Alternatively, instead of running 'git add' beforehand, you can use
132 ------------------------------------------------
133 $ git commit -a
134 ------------------------------------------------
136 which will automatically notice any modified (but not new) files, add
137 them to the index, and commit, all in one step.
139 A note on commit messages: Though not required, it's a good idea to
140 begin the commit message with a single short (less than 50 character)
141 line summarizing the change, followed by a blank line and then a more
142 thorough description. The text up to the first blank line in a commit
143 message is treated as the commit title, and that title is used
144 throughout git.  For example, linkgit:git-format-patch[1] turns a
145 commit into email, and it uses the title on the Subject line and the
146 rest of the commit in the body.
148 Git tracks content not files
149 ----------------------------
151 Many revision control systems provide an `add` command that tells the
152 system to start tracking changes to a new file.  Git's `add` command
153 does something simpler and more powerful: 'git add' is used both for new
154 and newly modified files, and in both cases it takes a snapshot of the
155 given files and stages that content in the index, ready for inclusion in
156 the next commit.
158 Viewing project history
159 -----------------------
161 At any point you can view the history of your changes using
163 ------------------------------------------------
164 $ git log
165 ------------------------------------------------
167 If you also want to see complete diffs at each step, use
169 ------------------------------------------------
170 $ git log -p
171 ------------------------------------------------
173 Often the overview of the change is useful to get a feel of
174 each step
176 ------------------------------------------------
177 $ git log --stat --summary
178 ------------------------------------------------
180 Managing branches
181 -----------------
183 A single git repository can maintain multiple branches of
184 development.  To create a new branch named "experimental", use
186 ------------------------------------------------
187 $ git branch experimental
188 ------------------------------------------------
190 If you now run
192 ------------------------------------------------
193 $ git branch
194 ------------------------------------------------
196 you'll get a list of all existing branches:
198 ------------------------------------------------
199   experimental
200 * master
201 ------------------------------------------------
203 The "experimental" branch is the one you just created, and the
204 "master" branch is a default branch that was created for you
205 automatically.  The asterisk marks the branch you are currently on;
206 type
208 ------------------------------------------------
209 $ git checkout experimental
210 ------------------------------------------------
212 to switch to the experimental branch.  Now edit a file, commit the
213 change, and switch back to the master branch:
215 ------------------------------------------------
216 (edit file)
217 $ git commit -a
218 $ git checkout master
219 ------------------------------------------------
221 Check that the change you made is no longer visible, since it was
222 made on the experimental branch and you're back on the master branch.
224 You can make a different change on the master branch:
226 ------------------------------------------------
227 (edit file)
228 $ git commit -a
229 ------------------------------------------------
231 at this point the two branches have diverged, with different changes
232 made in each.  To merge the changes made in experimental into master, run
234 ------------------------------------------------
235 $ git merge experimental
236 ------------------------------------------------
238 If the changes don't conflict, you're done.  If there are conflicts,
239 markers will be left in the problematic files showing the conflict;
241 ------------------------------------------------
242 $ git diff
243 ------------------------------------------------
245 will show this.  Once you've edited the files to resolve the
246 conflicts,
248 ------------------------------------------------
249 $ git commit -a
250 ------------------------------------------------
252 will commit the result of the merge. Finally,
254 ------------------------------------------------
255 $ gitk
256 ------------------------------------------------
258 will show a nice graphical representation of the resulting history.
260 At this point you could delete the experimental branch with
262 ------------------------------------------------
263 $ git branch -d experimental
264 ------------------------------------------------
266 This command ensures that the changes in the experimental branch are
267 already in the current branch.
269 If you develop on a branch crazy-idea, then regret it, you can always
270 delete the branch with
272 -------------------------------------
273 $ git branch -D crazy-idea
274 -------------------------------------
276 Branches are cheap and easy, so this is a good way to try something
277 out.
279 Using git for collaboration
280 ---------------------------
282 Suppose that Alice has started a new project with a git repository in
283 /home/alice/project, and that Bob, who has a home directory on the
284 same machine, wants to contribute.
286 Bob begins with:
288 ------------------------------------------------
289 bob$ git clone /home/alice/project myrepo
290 ------------------------------------------------
292 This creates a new directory "myrepo" containing a clone of Alice's
293 repository.  The clone is on an equal footing with the original
294 project, possessing its own copy of the original project's history.
296 Bob then makes some changes and commits them:
298 ------------------------------------------------
299 (edit files)
300 bob$ git commit -a
301 (repeat as necessary)
302 ------------------------------------------------
304 When he's ready, he tells Alice to pull changes from the repository
305 at /home/bob/myrepo.  She does this with:
307 ------------------------------------------------
308 alice$ cd /home/alice/project
309 alice$ git pull /home/bob/myrepo master
310 ------------------------------------------------
312 This merges the changes from Bob's "master" branch into Alice's
313 current branch.  If Alice has made her own changes in the meantime,
314 then she may need to manually fix any conflicts.
316 The "pull" command thus performs two operations: it fetches changes
317 from a remote branch, then merges them into the current branch.
319 Note that in general, Alice would want her local changes committed before
320 initiating this "pull".  If Bob's work conflicts with what Alice did since
321 their histories forked, Alice will use her working tree and the index to
322 resolve conflicts, and existing local changes will interfere with the
323 conflict resolution process (git will still perform the fetch but will
324 refuse to merge --- Alice will have to get rid of her local changes in
325 some way and pull again when this happens).
327 Alice can peek at what Bob did without merging first, using the "fetch"
328 command; this allows Alice to inspect what Bob did, using a special
329 symbol "FETCH_HEAD", in order to determine if he has anything worth
330 pulling, like this:
332 ------------------------------------------------
333 alice$ git fetch /home/bob/myrepo master
334 alice$ git log -p HEAD..FETCH_HEAD
335 ------------------------------------------------
337 This operation is safe even if Alice has uncommitted local changes.
338 The range notation "HEAD..FETCH_HEAD" means "show everything that is reachable
339 from the FETCH_HEAD but exclude anything that is reachable from HEAD".
340 Alice already knows everything that leads to her current state (HEAD),
341 and reviews what Bob has in his state (FETCH_HEAD) that she has not
342 seen with this command.
344 If Alice wants to visualize what Bob did since their histories forked
345 she can issue the following command:
347 ------------------------------------------------
348 $ gitk HEAD..FETCH_HEAD
349 ------------------------------------------------
351 This uses the same two-dot range notation we saw earlier with 'git log'.
353 Alice may want to view what both of them did since they forked.
354 She can use three-dot form instead of the two-dot form:
356 ------------------------------------------------
357 $ gitk HEAD...FETCH_HEAD
358 ------------------------------------------------
360 This means "show everything that is reachable from either one, but
361 exclude anything that is reachable from both of them".
363 Please note that these range notation can be used with both gitk
364 and "git log".
366 After inspecting what Bob did, if there is nothing urgent, Alice may
367 decide to continue working without pulling from Bob.  If Bob's history
368 does have something Alice would immediately need, Alice may choose to
369 stash her work-in-progress first, do a "pull", and then finally unstash
370 her work-in-progress on top of the resulting history.
372 When you are working in a small closely knit group, it is not
373 unusual to interact with the same repository over and over
374 again.  By defining 'remote' repository shorthand, you can make
375 it easier:
377 ------------------------------------------------
378 alice$ git remote add bob /home/bob/myrepo
379 ------------------------------------------------
381 With this, Alice can perform the first part of the "pull" operation
382 alone using the 'git fetch' command without merging them with her own
383 branch, using:
385 -------------------------------------
386 alice$ git fetch bob
387 -------------------------------------
389 Unlike the longhand form, when Alice fetches from Bob using a
390 remote repository shorthand set up with 'git remote', what was
391 fetched is stored in a remote-tracking branch, in this case
392 `bob/master`.  So after this:
394 -------------------------------------
395 alice$ git log -p master..bob/master
396 -------------------------------------
398 shows a list of all the changes that Bob made since he branched from
399 Alice's master branch.
401 After examining those changes, Alice
402 could merge the changes into her master branch:
404 -------------------------------------
405 alice$ git merge bob/master
406 -------------------------------------
408 This `merge` can also be done by 'pulling from her own remote-tracking
409 branch', like this:
411 -------------------------------------
412 alice$ git pull . remotes/bob/master
413 -------------------------------------
415 Note that git pull always merges into the current branch,
416 regardless of what else is given on the command line.
418 Later, Bob can update his repo with Alice's latest changes using
420 -------------------------------------
421 bob$ git pull
422 -------------------------------------
424 Note that he doesn't need to give the path to Alice's repository;
425 when Bob cloned Alice's repository, git stored the location of her
426 repository in the repository configuration, and that location is
427 used for pulls:
429 -------------------------------------
430 bob$ git config --get remote.origin.url
431 /home/alice/project
432 -------------------------------------
434 (The complete configuration created by 'git clone' is visible using
435 `git config -l`, and the linkgit:git-config[1] man page
436 explains the meaning of each option.)
438 Git also keeps a pristine copy of Alice's master branch under the
439 name "origin/master":
441 -------------------------------------
442 bob$ git branch -r
443   origin/master
444 -------------------------------------
446 If Bob later decides to work from a different host, he can still
447 perform clones and pulls using the ssh protocol:
449 -------------------------------------
450 bob$ git clone alice.org:/home/alice/project myrepo
451 -------------------------------------
453 Alternatively, git has a native protocol, or can use rsync or http;
454 see linkgit:git-pull[1] for details.
456 Git can also be used in a CVS-like mode, with a central repository
457 that various users push changes to; see linkgit:git-push[1] and
458 linkgit:gitcvs-migration[7].
460 Exploring history
461 -----------------
463 Git history is represented as a series of interrelated commits.  We
464 have already seen that the 'git log' command can list those commits.
465 Note that first line of each git log entry also gives a name for the
466 commit:
468 -------------------------------------
469 $ git log
470 commit c82a22c39cbc32576f64f5c6b3f24b99ea8149c7
471 Author: Junio C Hamano <junkio@cox.net>
472 Date:   Tue May 16 17:18:22 2006 -0700
474     merge-base: Clarify the comments on post processing.
475 -------------------------------------
477 We can give this name to 'git show' to see the details about this
478 commit.
480 -------------------------------------
481 $ git show c82a22c39cbc32576f64f5c6b3f24b99ea8149c7
482 -------------------------------------
484 But there are other ways to refer to commits.  You can use any initial
485 part of the name that is long enough to uniquely identify the commit:
487 -------------------------------------
488 $ git show c82a22c39c   # the first few characters of the name are
489                         # usually enough
490 $ git show HEAD         # the tip of the current branch
491 $ git show experimental # the tip of the "experimental" branch
492 -------------------------------------
494 Every commit usually has one "parent" commit
495 which points to the previous state of the project:
497 -------------------------------------
498 $ git show HEAD^  # to see the parent of HEAD
499 $ git show HEAD^^ # to see the grandparent of HEAD
500 $ git show HEAD~4 # to see the great-great grandparent of HEAD
501 -------------------------------------
503 Note that merge commits may have more than one parent:
505 -------------------------------------
506 $ git show HEAD^1 # show the first parent of HEAD (same as HEAD^)
507 $ git show HEAD^2 # show the second parent of HEAD
508 -------------------------------------
510 You can also give commits names of your own; after running
512 -------------------------------------
513 $ git tag v2.5 1b2e1d63ff
514 -------------------------------------
516 you can refer to 1b2e1d63ff by the name "v2.5".  If you intend to
517 share this name with other people (for example, to identify a release
518 version), you should create a "tag" object, and perhaps sign it; see
519 linkgit:git-tag[1] for details.
521 Any git command that needs to know a commit can take any of these
522 names.  For example:
524 -------------------------------------
525 $ git diff v2.5 HEAD     # compare the current HEAD to v2.5
526 $ git branch stable v2.5 # start a new branch named "stable" based
527                          # at v2.5
528 $ git reset --hard HEAD^ # reset your current branch and working
529                          # directory to its state at HEAD^
530 -------------------------------------
532 Be careful with that last command: in addition to losing any changes
533 in the working directory, it will also remove all later commits from
534 this branch.  If this branch is the only branch containing those
535 commits, they will be lost.  Also, don't use 'git reset' on a
536 publicly-visible branch that other developers pull from, as it will
537 force needless merges on other developers to clean up the history.
538 If you need to undo changes that you have pushed, use 'git revert'
539 instead.
541 The 'git grep' command can search for strings in any version of your
542 project, so
544 -------------------------------------
545 $ git grep "hello" v2.5
546 -------------------------------------
548 searches for all occurrences of "hello" in v2.5.
550 If you leave out the commit name, 'git grep' will search any of the
551 files it manages in your current directory.  So
553 -------------------------------------
554 $ git grep "hello"
555 -------------------------------------
557 is a quick way to search just the files that are tracked by git.
559 Many git commands also take sets of commits, which can be specified
560 in a number of ways.  Here are some examples with 'git log':
562 -------------------------------------
563 $ git log v2.5..v2.6            # commits between v2.5 and v2.6
564 $ git log v2.5..                # commits since v2.5
565 $ git log --since="2 weeks ago" # commits from the last 2 weeks
566 $ git log v2.5.. Makefile       # commits since v2.5 which modify
567                                 # Makefile
568 -------------------------------------
570 You can also give 'git log' a "range" of commits where the first is not
571 necessarily an ancestor of the second; for example, if the tips of
572 the branches "stable" and "master" diverged from a common
573 commit some time ago, then
575 -------------------------------------
576 $ git log stable..master
577 -------------------------------------
579 will list commits made in the master branch but not in the
580 stable branch, while
582 -------------------------------------
583 $ git log master..stable
584 -------------------------------------
586 will show the list of commits made on the stable branch but not
587 the master branch.
589 The 'git log' command has a weakness: it must present commits in a
590 list.  When the history has lines of development that diverged and
591 then merged back together, the order in which 'git log' presents
592 those commits is meaningless.
594 Most projects with multiple contributors (such as the Linux kernel,
595 or git itself) have frequent merges, and 'gitk' does a better job of
596 visualizing their history.  For example,
598 -------------------------------------
599 $ gitk --since="2 weeks ago" drivers/
600 -------------------------------------
602 allows you to browse any commits from the last 2 weeks of commits
603 that modified files under the "drivers" directory.  (Note: you can
604 adjust gitk's fonts by holding down the control key while pressing
605 "-" or "+".)
607 Finally, most commands that take filenames will optionally allow you
608 to precede any filename by a commit, to specify a particular version
609 of the file:
611 -------------------------------------
612 $ git diff v2.5:Makefile HEAD:Makefile.in
613 -------------------------------------
615 You can also use 'git show' to see any such file:
617 -------------------------------------
618 $ git show v2.5:Makefile
619 -------------------------------------
621 Next Steps
622 ----------
624 This tutorial should be enough to perform basic distributed revision
625 control for your projects.  However, to fully understand the depth
626 and power of git you need to understand two simple ideas on which it
627 is based:
629   * The object database is the rather elegant system used to
630     store the history of your project--files, directories, and
631     commits.
633   * The index file is a cache of the state of a directory tree,
634     used to create commits, check out working directories, and
635     hold the various trees involved in a merge.
637 Part two of this tutorial explains the object
638 database, the index file, and a few other odds and ends that you'll
639 need to make the most of git. You can find it at linkgit:gittutorial-2[7].
641 If you don't want to continue with that right away, a few other
642 digressions that may be interesting at this point are:
644   * linkgit:git-format-patch[1], linkgit:git-am[1]: These convert
645     series of git commits into emailed patches, and vice versa,
646     useful for projects such as the Linux kernel which rely heavily
647     on emailed patches.
649   * linkgit:git-bisect[1]: When there is a regression in your
650     project, one way to track down the bug is by searching through
651     the history to find the exact commit that's to blame.  Git bisect
652     can help you perform a binary search for that commit.  It is
653     smart enough to perform a close-to-optimal search even in the
654     case of complex non-linear history with lots of merged branches.
656   * linkgit:gitworkflows[7]: Gives an overview of recommended
657     workflows.
659   * link:everyday.html[Everyday GIT with 20 Commands Or So]
661   * linkgit:gitcvs-migration[7]: Git for CVS users.
663 SEE ALSO
664 --------
665 linkgit:gittutorial-2[7],
666 linkgit:gitcvs-migration[7],
667 linkgit:gitcore-tutorial[7],
668 linkgit:gitglossary[7],
669 linkgit:git-help[1],
670 linkgit:gitworkflows[7],
671 link:everyday.html[Everyday git],
672 link:user-manual.html[The Git User's Manual]
676 Part of the linkgit:git[1] suite.