[PATCH] Build commands through object files
[git.git] / Documentation / tutorial.txt
index 925ef2c..0f0af19 100644 (file)
@@ -104,8 +104,8 @@ Start off with just creating any random files that you want to maintain
 in your git archive. We'll start off with a few bad examples, just to
 get a feel for how this works:
 
-       echo "Hello World" > a
-       echo "Silly example" > b
+       echo "Hello World" >hello
+       echo "Silly example" >example
 
 you have now created two files in your working directory, but to
 actually check in your hard work, you will have to go through two steps:
@@ -125,7 +125,7 @@ adding a new entry with the "--add" flag (or removing an entry with the
 
 So to populate the index with the two files you just created, you can do
 
-       git-update-cache --add a b
+       git-update-cache --add hello example
 
 and you have now told git to track those two files.
 
@@ -155,11 +155,11 @@ regular file), and you can see the contents with
        git-cat-file "blob" 557db03de997c86a4a028e1ebd3a1ceb225be238
 
 which will print out "Hello World".  The object 557db...  is nothing
-more than the contents of your file "a". 
+more than the contents of your file "hello". 
 
-[ Digression: don't confuse that object with the file "a" itself.  The
+[ Digression: don't confuse that object with the file "hello" itself.  The
   object is literally just those specific _contents_ of the file, and
-  however much you later change the contents in file "a", the object we
+  however much you later change the contents in file "hello", the object we
   just looked at will never change.  Objects are immutable.  ]
 
 Anyway, as we mentioned previously, you normally never actually take a
@@ -180,11 +180,11 @@ However, since git knows about them, you can now start using some of the
 most basic git commands to manipulate the files or look at their status. 
 
 In particular, let's not even check in the two files into git yet, we'll
-start off by adding another line to "a" first:
+start off by adding another line to "hello" first:
 
-       echo "It's a new day for git" >> a
+       echo "It's a new day for git" >>hello
 
-and you can now, since you told git about the previous state of "a", ask
+and you can now, since you told git about the previous state of "hello", ask
 git what has changed in the tree compared to your old index, using the
 "git-diff-files" command:
 
@@ -192,7 +192,7 @@ git what has changed in the tree compared to your old index, using the
 
 oops.  That wasn't very readable.  It just spit out its own internal
 version of a "diff", but that internal version really just tells you
-that it has noticed that "a" has been modified, and that the old object
+that it has noticed that "hello" has been modified, and that the old object
 contents it had have been replaced with something else.
 
 To make it readable, we can tell git-diff-files to output the
@@ -202,14 +202,14 @@ differences as a patch, using the "-p" flag:
 
 which will spit out
 
-       diff --git a/a b/a
-       --- a/a
-       +++ b/a
+       diff --git a/hello b/hello
+       --- a/hello
+       +++ b/hello
        @@ -1 +1,2 @@
         Hello World
        +It's a new day for git
 
-ie the diff of the change we caused by adding another line to "a".
+ie the diff of the change we caused by adding another line to "hello".
 
 In other words, git-diff-files always shows us the difference between
 what is recorded in the index, and what is currently in the working
@@ -243,10 +243,10 @@ creating the equivalent of a git "directory" object:
 and this will just output the name of the resulting tree, in this case
 (if you have does exactly as I've described) it should be
 
-       3ede4ed7e895432c0a247f09d71a76db53bd0fa4
+       8988da15d077d4829fc51d8544c097def6644dbb
 
 which is another incomprehensible object name. Again, if you want to,
-you can use "git-cat-file -t 3ede4.." to see that this time the object
+you can use "git-cat-file -t 8988d.." to see that this time the object
 is not a "blob" object, but a "tree" object (you can also use
 git-cat-file to actually output the raw object contents, but you'll see
 mainly a binary mess, so that's less interesting).
@@ -273,7 +273,7 @@ shell pipeline:
 
 which will say:
 
-       Committing initial tree 3ede4ed7e895432c0a247f09d71a76db53bd0fa4
+       Committing initial tree 8988da15d077d4829fc51d8544c097def6644dbb
 
 just to warn you about the fact that it created a totally new commit
 that is not related to anything else. Normally you do this only _once_
@@ -293,13 +293,13 @@ instead, and it would have done the above magic scripting for you.
        Making a change
        ---------------
 
-Remember how we did the "git-update-cache" on file "a" and then we
-changed "a" afterward, and could compare the new state of "a" with the
+Remember how we did the "git-update-cache" on file "hello" and then we
+changed "hello" afterward, and could compare the new state of "hello" with the
 state we saved in the index file? 
 
 Further, remember how I said that "git-write-tree" writes the contents
 of the _index_ file to the tree, and thus what we just committed was in
-fact the _original_ contents of the file "a", not the new ones. We did
+fact the _original_ contents of the file "hello", not the new ones. We did
 that on purpose, to show the difference between the index state, and the
 state in the working directory, and how they don't have to match, even
 when we commit things.
@@ -362,19 +362,19 @@ in the working directory that we want to commit, and we always have to
 work through the index file, so the first thing we need to do is to
 update the index cache:
 
-       git-update-cache a
+       git-update-cache hello
 
 (note how we didn't need the "--add" flag this time, since git knew
 about the file already).
 
 Note what happens to the different git-diff-xxx versions here.  After
-we've updated "a" in the index, "git-diff-files -p" now shows no
+we've updated "hello" in the index, "git-diff-files -p" now shows no
 differences, but "git-diff-cache -p HEAD" still _does_ show that the
 current state is different from the state we committed.  In fact, now
 "git-diff-cache" shows the same difference whether we use the "--cached"
 flag or not, since now the index is coherent with the working directory. 
 
-Now, since we've updated "a" in the index, we can commit the new
+Now, since we've updated "hello" in the index, we can commit the new
 version.  We could do it by writing the tree by hand again, and
 committing the tree (this time we'd have to use the "-p HEAD" flag to
 tell commit that the HEAD was the _parent_ of the new commit, and that
@@ -472,10 +472,11 @@ A "light" tag is technically nothing more than a branch, except we put
 it in the ".git/refs/tags/" subdirectory instead of calling it a "head".
 So the simplest form of tag involves nothing more than
 
-       cat .git/HEAD > .git/refs/tags/my-first-tag
+       git tag my-first-tag
 
-after which point you can use this symbolic name for that particular
-state. You can, for example, do
+which just writes the current HEAD into the .git/refs/tags/my-first-tag
+file, after which point you can then use this symbolic name for that
+particular state.  You can, for example, do
 
        git diff my-first-tag
 
@@ -487,9 +488,9 @@ since you tagged it.
 A "signed tag" is actually a real git object, and contains not only a
 pointer to the state you want to tag, but also a small tag name and
 message, along with a PGP signature that says that yes, you really did
-that tag. You create these signed tags with
+that tag. You create these signed tags with the "-s" flag to "git tag":
 
-       git tag <tagname>
+       git tag -s <tagname>
 
 which will sign the current HEAD (but you can also give it another
 argument that specifies the thing to tag, ie you could have tagged the
@@ -584,7 +585,7 @@ create your own copy of the git repository, you'd do the following
 
        mkdir my-git
        cd my-git
-       rsync -rL rsync://rsync.kernel.org/pub/scm/git/git.git/ my-git .git
+       rsync -rL rsync://rsync.kernel.org/pub/scm/git/git.git/ .git
 
 followed by 
 
@@ -620,7 +621,7 @@ repository, and checked it out.
        ---------------------
 
 Branches in git are really nothing more than pointers into the git
-object space from within the ",git/refs/" subdirectory, and as we
+object space from within the ".git/refs/" subdirectory, and as we
 already discussed, the HEAD branch is nothing but a symlink to one of
 these object pointers. 
 
@@ -632,36 +633,45 @@ want (and indeed, subdirectories), but the convention is that the
 and nothing enforces it. 
 
 To show that as an example, let's go back to the git-tutorial archive we
-used earlier, and create a branch in it.  You literally do that by just
-creating a new SHA1 reference file, and switch to it by just making the
-HEAD pointer point to it:
+used earlier, and create a branch in it. You do that by simply just
+saying that you want to check out a new branch:
 
-       cat .git/HEAD > .git/refs/heads/mybranch
-       ln -sf refs/heads/mybranch .git/HEAD
+       git checkout -b mybranch
 
-and you're done.
+will create a new branch based at the current HEAD position, and switch
+to it. 
 
-Now, if you make the decision to start your new branch at some other
-point in the history than the current HEAD, you usually also want to
-actually switch the contents of your working directory to that point
-when you switch the head, and "git checkout" will do that for you:
-instead of switching the branch by hand with "ln -sf", you can just do
+[ Side note: if you make the decision to start your new branch at some
+  other point in the history than the current HEAD, you can do so by
+  just telling "git checkout" what the base of the checkout would be. 
+  In other words, if you have an earlier tag or branch, you'd just do
 
-       git checkout mybranch
+       git checkout -b mybranch earlier-branch
 
-which will basically "jump" to the branch specified, update your working
-directory to that state, and also make it become the new default HEAD. 
+  and it would create the new branch "mybranch" at the earlier point,
+  and check out the state at that time. ]
 
 You can always just jump back to your original "master" branch by doing
 
        git checkout master
 
-and if you forget which branch you happen to be on, a simple
+(or any other branch-name, for that matter) and if you forget which
+branch you happen to be on, a simple
 
        ls -l .git/HEAD
 
 will tell you where it's pointing.
 
+NOTE! Sometimes you may wish to create a new branch _without_ actually
+checking it out and switching to it. If so, just use the command
+
+       git branch <branchname> [startingpoint]
+
+which will simply _create_ the branch, but will not do anything further. 
+You can then later - once you decide that you want to actually develop
+on that branch - switch to that branch with a regular "git checkout"
+with the branchname as the argument.
+
 
        Merging two branches
        --------------------
@@ -673,12 +683,12 @@ being the same as the original "master" branch, let's make sure we're in
 that branch, and do some work there.
 
        git checkout mybranch
-       echo "Work, work, work" >> a
-       git commit a
+       echo "Work, work, work" >>hello
+       git commit hello
 
-Here, we just added another line to "a", and we used a shorthand for
-both going a "git-update-cache a" and "git commit" by just giving the
-filename directly to "git commit". 
+Here, we just added another line to "hello", and we used a shorthand for
+both going a "git-update-cache hello" and "git commit" by just giving the
+filename directly to "git commit".
 
 Now, to make it a bit more interesting, let's assume that somebody else
 does some work in the original branch, and simulate that by going back
@@ -686,13 +696,13 @@ to the master branch, and editing the same file differently there:
 
        git checkout master
 
-Here, take a moment to look at the contents of "a", and notice how they
+Here, take a moment to look at the contents of "hello", and notice how they
 don't contain the work we just did in "mybranch" - because that work
 hasn't happened in the "master" branch at all. Then do
 
-       echo "Play, play, play" >> a
-       echo "Lots of fun" >> b
-       git commit a b
+       echo "Play, play, play" >>hello
+       echo "Lots of fun" >>example
+       git commit hello example
 
 since the master branch is obviously in a much better mood.
 
@@ -724,20 +734,20 @@ of it as it can automatically (which in this case is just merge the "b"
 file, which had no differences in the "mybranch" branch), and say:
 
        Simple merge failed, trying Automatic merge
-       Auto-merging a.
+       Auto-merging hello.
        merge: warning: conflicts during merge
-       ERROR: Merge conflict in a.
+       ERROR: Merge conflict in hello.
        fatal: merge program failed
        Automatic merge failed, fix up by hand
 
 which is way too verbose, but it basically tells you that it failed the
 really trivial merge ("Simple merge") and did an "Automatic merge"
-instead, but that too failed due to conflicts in "a".
+instead, but that too failed due to conflicts in "hello".
 
-Not to worry. It left the (trivial) conflict in "a" in the same form you
+Not to worry. It left the (trivial) conflict in "hello" in the same form you
 should already be well used to if you've ever used CVS, so let's just
-open "a" in our editor (whatever that may be), and fix it up somehow.
-I'd suggest just making it so that "a" contains all four lines:
+open "hello" in our editor (whatever that may be), and fix it up somehow.
+I'd suggest just making it so that "hello" contains all four lines:
 
        Hello World
        It's a new day for git
@@ -746,14 +756,14 @@ I'd suggest just making it so that "a" contains all four lines:
 
 and once you're happy with your manual merge, just do a
 
-       git commit a
+       git commit hello
 
 which will very loudly warn you that you're now committing a merge
 (which is correct, so never mind), and you can write a small merge
 message about your adventures in git-merge-land. 
 
 After you're done, start up "gitk --all" to see graphically what the
-history looks like.  Notive that "mybranch" still exists, and you can
+history looks like.  Notice that "mybranch" still exists, and you can
 switch to it, and continue to work with it if you want to.  The
 "mybranch" branch will not contain the merge, but next time you merge it
 from the "master" branch, git will know how you merged it, so you'll not
@@ -1042,7 +1052,8 @@ A recommended work cycle for a "subsystem maintainer" that works
 on that project and has own "public repository" goes like this:
 
  (1) Prepare your work repository, by "git clone" the public
-     repository of the "project lead".
+     repository of the "project lead".  The URL used for the
+     initial cloning is stored in .git/branches/origin.
 
  (2) Prepare a public repository accessible to others.
 
@@ -1051,7 +1062,7 @@ on that project and has own "public repository" goes like this:
      currently not automated.
 
  (4) Push into the public repository from your primary
-     repository.  Run "git repack" (and possibly "git
+     repository.  Run "git repack"and possibly "git
      prune-packed" if the transport used for pulling from your
      repository supports packed repositories.
 
@@ -1076,30 +1087,25 @@ A recommended work cycle for an "individual developer" who does
 not have a "public" repository is somewhat different.  It goes
 like this:
 
- (1) Prepare your work repositories, by "git clone" the public
-     repository of the "project lead" (or "subsystem
-     maintainer", if you work on a subsystem).
-
- (2) Copy .git/refs/master to .git/refs/upstream.
-
- (3) Do your work there.  Make commits.
+ (1) Prepare your work repository, by "git clone" the public
+     repository of the "project lead" (or a "subsystem
+     maintainer", if you work on a subsystem).  The URL used for
+     the initial cloning is stored in .git/branches/origin.
 
- (4) Run "git fetch" from the public repository of your upstream
-     every once in a while.  This does only the first half of
-     "git pull" but does not merge.  The head of the public
-     repository is stored in .git/FETCH_HEAD.  Copy it in
-     .git/refs/heads/upstream.
+ (2) Do your work there.  Make commits.
 
- (5) Use "git cherry" to see which ones of your patches were
-     accepted, and/or use "git rebase" to port your unmerged
-     changes forward to the updated upstream.
+ (3) Run "git fetch origin" from the public repository of your
+     upstream every once in a while.  This does only the first
+     half of "git pull" but does not merge.  The head of the
+     public repository is stored in .git/refs/heads/origin.
 
- (6) Use "git format-patch upstream" to prepare patches for
-     e-mail submission to your upstream and send it out.
-     Go back to step (3) and continue. 
+ (4) Use "git cherry origin" to see which ones of your patches
+     were accepted, and/or use "git rebase origin" to port your
+     unmerged changes forward to the updated upstream.
 
-[Side Note: I think Cogito calls this upstream "origin".
- Somebody care to confirm or deny?  ]
+ (5) Use "git format-patch origin" to prepare patches for e-mail
+     submission to your upstream and send it out.  Go back to
+     step (2) and continue.
 
 
 [ to be continued.. cvsimports ]