| blob | 89236c38c0551890382e94bf38582ecb1c2b9edc |
4 <head>
9 /* Debug borders */
11 /*
12 border: 1px solid red;
13 */
14 }
16 body {
18 }
20 a {
23 }
26 }
28 em {
31 }
33 strong {
36 }
38 tt {
40 }
48 }
52 }
53 h2 {
55 }
56 h3 {
58 }
59 h3 + * {
61 }
66 }
68 hr {
70 }
72 p {
75 }
79 }
81 pre {
84 }
86 span#author {
91 }
92 span#email {
93 }
96 }
98 div#footer {
104 }
105 div#footer-text {
108 }
109 div#footer-badges {
112 }
114 div#preamble {
117 }
123 }
129 }
133 }
135 /* Block element titles. */
143 }
146 }
150 }
153 }
156 }
162 }
168 }
176 }
181 }
185 }
189 }
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
193 }
202 }
206 }
211 }
217 dl {
220 }
221 dt {
226 }
229 }
233 }
236 }
239 }
242 }
245 }
248 }
255 }
259 }
263 }
264 tfoot {
266 }
269 }
272 }
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
276 }
280 }
284 }
290 }
293 }
296 }
302 }
305 }
309 }
313 }
317 }
321 }
326 }
330 }
340 }
345 }
347 div#toc {
349 }
351 div#toctitle {
358 }
363 }
367 }
371 }
375 }
376 /* Overrides for manpage documents */
377 h1 {
382 }
383 h2 {
385 }
388 }
392 }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
400 }
407 }
413 }
418 }
422 }
426 }
431 }
433 /* IE6 sets dynamically generated links as visited. */
435 </style>
437 /*<![CDATA[*/
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
468 }
470 }
476 }
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
490 }
492 }
493 }
494 }
497 }
512 }
515 },
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
547 }
548 }
552 // Process footnoterefs.
561 }
562 }
563 }
564 }
566 }
567 /*]]>*/
568 </script>
569 </head>
570 <body>
572 <h1>
573 gittutorial(7) Manual Page
574 </h1>
577 <p>gittutorial -
578 A tutorial introduction to git (for version 1.5.1 or newer)
579 </p>
580 </div>
581 </div>
588 </div></div>
589 </div>
593 changes to it, and share changes with other developers.</p></div>
594 <div class="paragraph"><p>If you are instead primarily interested in using git to fetch a project,
595 for example, to test the latest version, you may prefer to start with
602 </div></div>
607 </div></div>
611 public email address before doing any operation. The easiest
612 way to do so is:</p></div>
616 $ git config --global user.email you@yourdomain.example.com</tt></pre>
617 </div></div>
618 </div>
622 can place it under git revision control as follows.</p></div>
625 <pre><tt>$ tar xzf project.tar.gz
626 $ cd project
627 $ git init</tt></pre>
628 </div></div>
633 </div></div>
634 <div class="paragraph"><p>You’ve now initialized the working directory—you may notice a new
636 <div class="paragraph"><p>Next, tell git to take a snapshot of the contents of all files under the
641 </div></div>
642 <div class="paragraph"><p>This snapshot is now stored in a temporary staging area which git calls
643 the "index". You can permanently store the contents of the index in the
648 </div></div>
649 <div class="paragraph"><p>This will prompt you for a commit message. You’ve now stored the first
650 version of your project in git.</p></div>
651 </div>
654 <div class="paragraph"><p>Modify some files, then add their updated contents to the index:</p></div>
658 </div></div>
659 <div class="paragraph"><p>You are now ready to commit. You can see what is about to be committed
664 </div></div>
666 you’ve made but not yet added to the index.) You can also get a brief
670 <pre><tt>$ git status
671 # On branch master
672 # Changes to be committed:
673 # (use "git reset HEAD <file>..." to unstage)
674 #
675 # modified: file1
676 # modified: file2
677 # modified: file3
678 #</tt></pre>
679 </div></div>
680 <div class="paragraph"><p>If you need to make any further adjustments, do so now, and then add any
681 newly modified content to the index. Finally, commit your changes with:</p></div>
685 </div></div>
686 <div class="paragraph"><p>This will again prompt you for a message describing the change, and then
687 record a new version of the project.</p></div>
688 <div class="paragraph"><p>Alternatively, instead of running <em>git add</em> beforehand, you can use</p></div>
692 </div></div>
694 them to the index, and commit, all in one step.</p></div>
695 <div class="paragraph"><p>A note on commit messages: Though not required, it’s a good idea to
696 begin the commit message with a single short (less than 50 character)
697 line summarizing the change, followed by a blank line and then a more
698 thorough description. Tools that turn commits into email, for
699 example, use the first line on the Subject: line and the rest of the
700 commit in the body.</p></div>
701 </div>
704 <div class="paragraph"><p>Many revision control systems provide an <tt>add</tt> command that tells the
707 and newly modified files, and in both cases it takes a snapshot of the
708 given files and stages that content in the index, ready for inclusion in
709 the next commit.</p></div>
710 </div>
717 </div></div>
722 </div></div>
724 each step</p></div>
728 </div></div>
729 </div>
737 </div></div>
742 </div></div>
746 <pre><tt> experimental
747 * master</tt></pre>
748 </div></div>
750 "master" branch is a default branch that was created for you
751 automatically. The asterisk marks the branch you are currently on;
752 type</p></div>
756 </div></div>
758 change, and switch back to the master branch:</p></div>
761 <pre><tt>(edit file)
762 $ git commit -a
763 $ git checkout master</tt></pre>
764 </div></div>
770 <pre><tt>(edit file)
771 $ git commit -a</tt></pre>
772 </div></div>
774 made in each. To merge the changes made in experimental into master, run</p></div>
778 </div></div>
779 <div class="paragraph"><p>If the changes don’t conflict, you’re done. If there are conflicts,
780 markers will be left in the problematic files showing the conflict;</p></div>
784 </div></div>
786 conflicts,</p></div>
790 </div></div>
795 </div></div>
796 <div class="paragraph"><p>will show a nice graphical representation of the resulting history.</p></div>
801 </div></div>
803 already in the current branch.</p></div>
805 delete the branch with</p></div>
809 </div></div>
811 out.</p></div>
812 </div>
816 /home/alice/project, and that Bob, who has a home directory on the
817 same machine, wants to contribute.</p></div>
822 </div></div>
823 <div class="paragraph"><p>This creates a new directory "myrepo" containing a clone of Alice’s
824 repository. The clone is on an equal footing with the original
829 <pre><tt>(edit files)
830 bob$ git commit -a
831 (repeat as necessary)</tt></pre>
832 </div></div>
833 <div class="paragraph"><p>When he’s ready, he tells Alice to pull changes from the repository
834 at /home/bob/myrepo. She does this with:</p></div>
837 <pre><tt>alice$ cd /home/alice/project
838 alice$ git pull /home/bob/myrepo master</tt></pre>
839 </div></div>
840 <div class="paragraph"><p>This merges the changes from Bob’s "master" branch into Alice’s
841 current branch. If Alice has made her own changes in the meantime,
842 then she may need to manually fix any conflicts.</p></div>
844 from a remote branch, then merges them into the current branch.</p></div>
845 <div class="paragraph"><p>Note that in general, Alice would want her local changes committed before
847 their histories forked, Alice will use her working tree and the index to
848 resolve conflicts, and existing local changes will interfere with the
849 conflict resolution process (git will still perform the fetch but will
850 refuse to merge --- Alice will have to get rid of her local changes in
851 some way and pull again when this happens).</p></div>
852 <div class="paragraph"><p>Alice can peek at what Bob did without merging first, using the "fetch"
853 command; this allows Alice to inspect what Bob did, using a special
854 symbol "FETCH_HEAD", in order to determine if he has anything worth
855 pulling, like this:</p></div>
858 <pre><tt>alice$ git fetch /home/bob/myrepo master
859 alice$ git log -p HEAD..FETCH_HEAD</tt></pre>
860 </div></div>
863 from the FETCH_HEAD but exclude anything that is reachable from HEAD".
864 Alice already knows everything that leads to her current state (HEAD),
865 and reviews what Bob has in his state (FETCH_HEAD) that she has not
866 seen with this command.</p></div>
868 she can issue the following command:</p></div>
872 </div></div>
873 <div class="paragraph"><p>This uses the same two-dot range notation we saw earlier with <em>git log</em>.</p></div>
875 She can use three-dot form instead of the two-dot form:</p></div>
879 </div></div>
885 decide to continue working without pulling from Bob. If Bob’s history
886 does have something Alice would immediately need, Alice may choose to
887 stash her work-in-progress first, do a "pull", and then finally unstash
888 her work-in-progress on top of the resulting history.</p></div>
890 unusual to interact with the same repository over and over
892 it easier:</p></div>
896 </div></div>
899 branch, using:</p></div>
903 </div></div>
906 fetched is stored in a remote-tracking branch, in this case
911 </div></div>
915 could merge the changes into her master branch:</p></div>
919 </div></div>
920 <div class="paragraph"><p>This <tt>merge</tt> can also be done by <em>pulling from her own remote-tracking
925 </div></div>
927 regardless of what else is given on the command line.</p></div>
928 <div class="paragraph"><p>Later, Bob can update his repo with Alice’s latest changes using</p></div>
932 </div></div>
933 <div class="paragraph"><p>Note that he doesn’t need to give the path to Alice’s repository;
934 when Bob cloned Alice’s repository, git stored the location of her
935 repository in the repository configuration, and that location is
936 used for pulls:</p></div>
939 <pre><tt>bob$ git config --get remote.origin.url
940 /home/alice/project</tt></pre>
941 </div></div>
942 <div class="paragraph"><p>(The complete configuration created by <em>git clone</em> is visible using
944 explains the meaning of each option.)</p></div>
945 <div class="paragraph"><p>Git also keeps a pristine copy of Alice’s master branch under the
949 <pre><tt>bob$ git branch -r
950 origin/master</tt></pre>
951 </div></div>
953 perform clones and pulls using the ssh protocol:</p></div>
957 </div></div>
963 </div>
968 Note that first line of each git log entry also gives a name for the
969 commit:</p></div>
972 <pre><tt>$ git log
973 commit c82a22c39cbc32576f64f5c6b3f24b99ea8149c7
977 merge-base: Clarify the comments on post processing.</tt></pre>
978 </div></div>
979 <div class="paragraph"><p>We can give this name to <em>git show</em> to see the details about this
980 commit.</p></div>
984 </div></div>
986 part of the name that is long enough to uniquely identify the commit:</p></div>
989 <pre><tt>$ git show c82a22c39c # the first few characters of the name are
990 # usually enough
991 $ git show HEAD # the tip of the current branch
993 </div></div>
995 which points to the previous state of the project:</p></div>
998 <pre><tt>$ git show HEAD^ # to see the parent of HEAD
999 $ git show HEAD^^ # to see the grandparent of HEAD
1001 </div></div>
1007 </div></div>
1012 </div></div>
1014 share this name with other people (for example, to identify a release
1015 version), you should create a "tag" object, and perhaps sign it; see
1018 names. For example:</p></div>
1021 <pre><tt>$ git diff v2.5 HEAD # compare the current HEAD to v2.5
1022 $ git branch stable v2.5 # start a new branch named "stable" based
1023 # at v2.5
1024 $ git reset --hard HEAD^ # reset your current branch and working
1025 # directory to its state at HEAD^</tt></pre>
1026 </div></div>
1028 in the working directory, it will also remove all later commits from
1029 this branch. If this branch is the only branch containing those
1031 publicly-visible branch that other developers pull from, as it will
1032 force needless merges on other developers to clean up the history.
1034 instead.</p></div>
1035 <div class="paragraph"><p>The <em>git grep</em> command can search for strings in any version of your
1036 project, so</p></div>
1040 </div></div>
1042 <div class="paragraph"><p>If you leave out the commit name, <em>git grep</em> will search any of the
1043 files it manages in your current directory. So</p></div>
1047 </div></div>
1048 <div class="paragraph"><p>is a quick way to search just the files that are tracked by git.</p></div>
1053 <pre><tt>$ git log v2.5..v2.6 # commits between v2.5 and v2.6
1054 $ git log v2.5.. # commits since v2.5
1056 $ git log v2.5.. Makefile # commits since v2.5 which modify
1057 # Makefile</tt></pre>
1058 </div></div>
1059 <div class="paragraph"><p>You can also give <em>git log</em> a "range" of commits where the first is not
1060 necessarily an ancestor of the second; for example, if the tips of
1062 commit some time ago, then</p></div>
1066 </div></div>
1068 stable branch, while</p></div>
1072 </div></div>
1074 the master branch.</p></div>
1075 <div class="paragraph"><p>The <em>git log</em> command has a weakness: it must present commits in a
1076 list. When the history has lines of development that diverged and
1078 those commits is meaningless.</p></div>
1081 visualizing their history. For example,</p></div>
1085 </div></div>
1087 that modified files under the "drivers" directory. (Note: you can
1088 adjust gitk’s fonts by holding down the control key while pressing
1091 to precede any filename by a commit, to specify a particular version
1092 of the file:</p></div>
1096 </div></div>
1101 </div></div>
1102 </div>
1106 control for your projects. However, to fully understand the depth
1107 and power of git you need to understand two simple ideas on which it
1108 is based:</p></div>
1110 <li>
1111 <p>
1112 The object database is the rather elegant system used to
1113 store the history of your project—files, directories, and
1114 commits.
1115 </p>
1116 </li>
1117 <li>
1118 <p>
1119 The index file is a cache of the state of a directory tree,
1120 used to create commits, check out working directories, and
1121 hold the various trees involved in a merge.
1122 </p>
1123 </li>
1124 </ul></div>
1126 database, the index file, and a few other odds and ends that you’ll
1127 need to make the most of git. You can find it at <a href="gittutorial-2.html">gittutorial-2(7)</a>.</p></div>
1128 <div class="paragraph"><p>If you don’t want to continue with that right away, a few other
1129 digressions that may be interesting at this point are:</p></div>
1131 <li>
1132 <p>
1133 <a href="git-format-patch.html">git-format-patch(1)</a>, <a href="git-am.html">git-am(1)</a>: These convert
1134 series of git commits into emailed patches, and vice versa,
1135 useful for projects such as the Linux kernel which rely heavily
1136 on emailed patches.
1137 </p>
1138 </li>
1139 <li>
1140 <p>
1142 project, one way to track down the bug is by searching through
1143 the history to find the exact commit that’s to blame. Git bisect
1144 can help you perform a binary search for that commit. It is
1145 smart enough to perform a close-to-optimal search even in the
1146 case of complex non-linear history with lots of merged branches.
1147 </p>
1148 </li>
1149 <li>
1150 <p>
1152 workflows.
1153 </p>
1154 </li>
1155 <li>
1156 <p>
1158 </p>
1159 </li>
1160 <li>
1161 <p>
1163 </p>
1164 </li>
1165 </ul></div>
1166 </div>
1177 </div>
1181 </div>
1182 </div>
1187 </div>
1188 </div>
1189 </body>
1190 </html>