* (unknown)
@ 2006-05-21 23:53 J. Bruce Fields
2006-05-21 23:53 ` (unknown) J. Bruce Fields
` (2 more replies)
0 siblings, 3 replies; 14+ messages in thread
From: J. Bruce Fields @ 2006-05-21 23:53 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git
>From nobody Mon Sep 17 00:00:00 2001
From: J. Bruce Fields <bfields@citi.umich.edu>
Date: Sun, 21 May 2006 16:52:34 -0400
Subject: [PATCH 1/3] tutorial: replace "whatchanged" by "log"
Junio suggested changing references to git-whatchanged to git-log.
Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
---
d1177b299b449e9eb63d963ee118a5e0283aa611
Documentation/tutorial.txt | 12 ++++++------
1 files changed, 6 insertions(+), 6 deletions(-)
d1177b299b449e9eb63d963ee118a5e0283aa611
diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt
index fa79b01..cd0f0df 100644
--- a/Documentation/tutorial.txt
+++ b/Documentation/tutorial.txt
@@ -80,13 +80,13 @@ file; just remove it, then commit.
At any point you can view the history of your changes using
------------------------------------------------
-$ git whatchanged
+$ git log
------------------------------------------------
If you also want to see complete diffs at each step, use
------------------------------------------------
-$ git whatchanged -p
+$ git log -p
------------------------------------------------
Managing branches
@@ -216,7 +216,7 @@ This actually pulls changes from the bra
"master". Alice could request a different branch by adding the name
of the branch to the end of the git pull command line.
-This merges Bob's changes into her repository; "git whatchanged" will
+This merges Bob's changes into her repository; "git log" will
now show the new commits. If Alice has made her own changes in the
meantime, then Bob's changes will be merged in, and she will need to
manually fix any conflicts.
@@ -234,7 +234,7 @@ named bob-incoming. (Unlike git pull, g
of Bob's line of development without doing any merging). Then
-------------------------------------
-$ git whatchanged -p master..bob-incoming
+$ git log -p master..bob-incoming
-------------------------------------
shows a list of all the changes that Bob made since he branched from
@@ -330,13 +330,13 @@ But you may find it more useful to see t
the experimental branch but not in the current branch, and
-------------------------------------
-git whatchanged HEAD..experimental
+git log HEAD..experimental
-------------------------------------
will do that, just as
-------------------------------------
-git whatchanged experimental..HEAD
+git log experimental..HEAD
-------------------------------------
will show the list of commits made on the HEAD but not included in
--
1.3.3.gff62
^ permalink raw reply related [flat|nested] 14+ messages in thread* (unknown) 2006-05-21 23:53 (unknown) J. Bruce Fields @ 2006-05-21 23:53 ` J. Bruce Fields 2006-05-21 23:53 ` (unknown) J. Bruce Fields 2006-05-22 8:23 ` [PATCH 2/3] tutorial: expanded discussion of commit history Jakub Narebski 2006-05-21 23:55 ` your mail J. Bruce Fields 2006-05-22 10:09 ` [PATCH] git help: remove whatchanged from list of common commands Martin Waitz 2 siblings, 2 replies; 14+ messages in thread From: J. Bruce Fields @ 2006-05-21 23:53 UTC (permalink / raw) To: Junio C Hamano; +Cc: git >From nobody Mon Sep 17 00:00:00 2001 From: J. Bruce Fields <bfields@citi.umich.edu> Date: Sun, 21 May 2006 16:54:05 -0400 Subject: [PATCH 2/3] tutorial: expanded discussion of commit history Expand the history-browsing section of the tutorial a bit, in part to address Junio's suggestion that we mention "git grep" and Linus's complaint that people are missing the flexibility of the commandline interfaces for selecting commits. This reads a little more like a collection of examples than a "tutorial", but maybe that's what people need at this point. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> --- bb2450ce2145bfdc5b3b7c967a5ed3571437f5d4 Documentation/tutorial.txt | 165 ++++++++++++++++++++++++++++++-------------- 1 files changed, 112 insertions(+), 53 deletions(-) bb2450ce2145bfdc5b3b7c967a5ed3571437f5d4 diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt index cd0f0df..4c298c6 100644 --- a/Documentation/tutorial.txt +++ b/Documentation/tutorial.txt @@ -288,103 +288,162 @@ Git can also be used in a CVS-like mode, that various users push changes to; see gitlink:git-push[1] and link:cvs-migration.html[git for CVS users]. -Keeping track of history ------------------------- +Exploring history +----------------- -Git history is represented as a series of interrelated commits. The -most recent commit in the currently checked-out branch can always be -referred to as HEAD, and the "parent" of any commit can always be -referred to by appending a caret, "^", to the end of the name of the -commit. So, for example, +Git history is represented as a series of interrelated commits. We +have already seen that the git log command can list those commits. +Note that first line of each git log entry also gives a name for the +commit: ------------------------------------- -git diff HEAD^ HEAD +$ git log +commit c82a22c39cbc32576f64f5c6b3f24b99ea8149c7 +Author: Junio C Hamano <junkio@cox.net> +Date: Tue May 16 17:18:22 2006 -0700 + + merge-base: Clarify the comments on post processing. ------------------------------------- -shows the difference between the most-recently checked-in state of -the tree and the previous state, and +We can give this name to git show to see the details about this +commit. ------------------------------------- -git diff HEAD^^ HEAD^ +$ git show c82a22c39cbc32576f64f5c6b3f24b99ea8149c7 ------------------------------------- -shows the difference between that previous state and the state two -commits ago. Also, HEAD~5 can be used as a shorthand for HEAD{caret}{caret}{caret}{caret}{caret}, -and more generally HEAD~n can refer to the nth previous commit. -Commits representing merges have more than one parent, and you can -specify which parent to follow in that case; see -gitlink:git-rev-parse[1]. +But there other ways to refer to commits. You can use any initial +part of the name that is long enough to uniquely identify the commit: -The name of a branch can also be used to refer to the most recent -commit on that branch; so you can also say things like +------------------------------------- +$ git show c82a22c39c # the first few characters of the name are + # usually enough +$ git show HEAD # the tip of the current branch +$ git show experimental # the tip of the "experimental" branch +------------------------------------- + +Every commit has at least one "parent" commit, which points to the +previous state of the project: ------------------------------------- -git diff HEAD experimental +$ git show HEAD^ # to see the parent of HEAD +$ git show HEAD^^ # to see the grandparent of HEAD +$ git show HEAD~4 # to see the great-great grandparent of HEAD ------------------------------------- -to see the difference between the most-recently committed tree in -the current branch and the most-recently committed tree in the -experimental branch. +Note that merge commits may have more than one parent: + +------------------------------------- +$ git show HEAD^1 # show the first parent of HEAD (same as HEAD^) +$ git show HEAD^2 # show the second parent of HEAD +------------------------------------- -But you may find it more useful to see the list of commits made in -the experimental branch but not in the current branch, and +You can also give commits names of your own; after running ------------------------------------- -git log HEAD..experimental +$ git-tag v2.5 1b2e1d63ff ------------------------------------- -will do that, just as +you can refer to 1b2e1d63ff by the name "v2.5". If you intend to +share this name with other people (for example, to identify a release +version), you should create a "tag" object, and perhaps sign it; see +gitlink:git-tag[1] for details. + +Any git command that needs to know a commit can take any of these +names. For example: ------------------------------------- -git log experimental..HEAD +$ git diff v2.5 HEAD # compare the current HEAD to v2.5 +$ git branch stable v2.5 # start a new branch named "stable" based + # at v2.5 +$ git reset --hard HEAD^ # reset your current branch and working + # directory its state at HEAD^ ------------------------------------- -will show the list of commits made on the HEAD but not included in -experimental. +Be careful with that last command: in addition to losing any changes +in the working directory, it will also remove all later commits from +this branch. If this branch is the only branch containing those +commits, they will be lost. (Also, don't use "git reset" on a +publicly-visible branch that other developers pull from, as git will +be confused by history that disappears in this way.) -You can also give commits convenient names of your own: after running +The git grep command can search for strings in any version of your +project, so ------------------------------------- -$ git-tag v2.5 HEAD^^ +$ git grep "hello" v2.5 ------------------------------------- -you can refer to HEAD^^ by the name "v2.5". If you intend to share -this name with other people (for example, to identify a release -version), you should create a "tag" object, and perhaps sign it; see -gitlink:git-tag[1] for details. +searches for all occurences of "hello" in v2.5. -You can revisit the old state of a tree, and make further -modifications if you wish, using git branch: the command +If you leave out the commit name, git grep will search any of the +files it manages in your current directory. So ------------------------------------- -$ git branch stable-release v2.5 +$ git grep "hello" ------------------------------------- -will create a new branch named "stable-release" starting from the -commit which you tagged with the name v2.5. +is a quick way to search just the files that are tracked by git. -You can reset the state of any branch to an earlier commit at any -time with +Many git commands also take sets of commits, which can be specified +in a number of ways. Here are some examples with git log: ------------------------------------- -$ git reset --hard v2.5 +$ git log v2.5..v2.6 # commits between v2.5 and v2.6 +$ git log v2.5.. # commits since v2.5 +$ git log --since="2 weeks ago" # commits from the last 2 weeks +$ git log v2.5.. Makefile # commits since v2.5 which modify + # Makefile ------------------------------------- -This will remove all later commits from this branch and reset the -working tree to the state it had when the given commit was made. If -this branch is the only branch containing the later commits, those -later changes will be lost. Don't use "git reset" on a -publicly-visible branch that other developers pull from, as git will -be confused by history that disappears in this way. +You can also give git log a "range" of commits where the first is not +necessarily an ancestor of the second; for example, if the tips of +the branches "stable-release" and "master" diverged from a common +commit some time ago, then + +------------------------------------- +$ git log stable..experimental +------------------------------------- + +will list commits made in the experimental branch but not in the +stable branch, while + +------------------------------------- +$ git log experimental..stable +------------------------------------- + +will show the list of commits made on the stable branch but not +the experimental branch. + +The "git log" command has a weakness: it must present commits in a +list. When the history has lines of development that diverged and +then merged back together, the order in which "git log" presents +those commits is meaningless. + +Most projects with multiple contributors (such as the linux kernel, +or git itself) have frequent merges, and gitk does a better job of +visualizing their history. For example, + +------------------------------------- +$ gitk --since="2 weeks ago" drivers/ +------------------------------------- + +allows you to browse any commits from the last 2 weeks of commits +that modified files under the "drivers" directory. + +Finally, most commands that take filenames will optionally allow you +to precede any filename by a commit, to specify a particular version +fo the file: + +------------------------------------- +$ git diff v2.5:Makefile HEAD:Makefile.in +------------------------------------- Next Steps ---------- Some good commands to explore next: - * gitlink:git-diff[1]: This flexible command does much more than - we've seen in the few examples above. - * gitlink:git-format-patch[1], gitlink:git-am[1]: These convert series of git commits into emailed patches, and vice versa, useful for projects such as the linux kernel which rely heavily -- 1.3.3.gff62 ^ permalink raw reply related [flat|nested] 14+ messages in thread
* (unknown) 2006-05-21 23:53 ` (unknown) J. Bruce Fields @ 2006-05-21 23:53 ` J. Bruce Fields 2006-05-22 0:35 ` totorial-2 (unknown) Junio C Hamano 2006-05-22 15:27 ` [PATCH 3/3] tutorial: add discussion of index file, object database Jakub Narebski 2006-05-22 8:23 ` [PATCH 2/3] tutorial: expanded discussion of commit history Jakub Narebski 1 sibling, 2 replies; 14+ messages in thread From: J. Bruce Fields @ 2006-05-21 23:53 UTC (permalink / raw) To: Junio C Hamano; +Cc: git >From nobody Mon Sep 17 00:00:00 2001 From: J. Bruce Fields <bfields@citi.umich.edu> Date: Sun, 21 May 2006 19:49:34 -0400 Subject: [PATCH 3/3] tutorial: add discussion of index file, object database Add a sequel to tutorial.txt which discusses the index file and the object database. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> --- e84a9b9a34794c5b9dd36f6ccc11e60daecd3003 Documentation/Makefile | 1 Documentation/tutorial-2.txt | 391 ++++++++++++++++++++++++++++++++++++++++++ Documentation/tutorial.txt | 28 ++- 3 files changed, 414 insertions(+), 6 deletions(-) create mode 100644 Documentation/tutorial-2.txt e84a9b9a34794c5b9dd36f6ccc11e60daecd3003 diff --git a/Documentation/Makefile b/Documentation/Makefile index c1af22c..2a08f59 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -7,6 +7,7 @@ MAN7_TXT=git.txt DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT) $(MAN7_TXT)) ARTICLES = tutorial +ARTICLES += tutorial-2 ARTICLES += core-tutorial ARTICLES += cvs-migration ARTICLES += diffcore diff --git a/Documentation/tutorial-2.txt b/Documentation/tutorial-2.txt new file mode 100644 index 0000000..a3d45ee --- /dev/null +++ b/Documentation/tutorial-2.txt @@ -0,0 +1,391 @@ +A tutorial introduction to git: part two +======================================== + +You should work through link:tutorial.html[A tutorial introduction to +git] before reading this tutorial. + +The goal of this tutorial is to introduce two fundamental pieces of +git's architecture--the object database and the index file--and to +provide the reader with everything necessary to understand the rest +of the git documentation. + +The git object database +----------------------- + +Let's start a new project and create a small amount of history: + +------------------------------------------------ +$ mkdir test-project +$ cd test-project +$ git init-db +defaulting to local storage area +$ echo 'hello world' > file.txt +$ git add . +$ git commit -a -m "initial commit" +Committing initial tree 92b8b694ffb1675e5975148e1121810081dbdffe +$ echo 'hello world!' >file.txt +$ git commit -a -m "add emphasis" +------------------------------------------------ + +What are the 40 digits of hex that git responded to the first commit +with? + +We saw in part one of the tutorial that commits have names like this. +It turns out that every object in the git history is stored under +such a 40-digit hex name. That name is the SHA1 hash of the object's +contents; among other things, this ensures that git will never store +the same data twice (since identical data is given an identical SHA1 +name), and that the contents of a git object will never change (since +that would change the object's name as well). + +We can ask git about this particular object with the cat-file +command--just cut-and-paste from the reply to the initial commit, to +save yourself typing all 40 hex digits: + +------------------------------------------------ +$ git cat-file -t 92b8b694ffb1675e5975148e1121810081dbdffe +tree +------------------------------------------------ + +A tree can refer to one or more "blob" objects, each corresponding to +a file. In addition, a tree can also refer to other tree objects, +thus creating a directory heirarchy. You can examine the contents of +any tree using ls-tree (remember that a long enough initial portion +of the SHA1 will also work): + +------------------------------------------------ +$ git ls-tree 92b8b694 +100644 blob 3b18e512dba79e4c8300dd08aeb37f8e728b8dad file.txt +------------------------------------------------ + +Thus we see that this tree has one file in it. The SHA1 hash is a +reference to that file's data: + +------------------------------------------------ +$ git cat-file -t 3b18e512 +blob +------------------------------------------------ + +A "blob" is just file data, which we can also examine with cat-file: + +------------------------------------------------ +$ git cat-file blob 3b18e512 +hello world +------------------------------------------------ + +Note that this is the old file data; so the object that git named in +its response to the initial tree was a tree with a snapshot of the +directory state that was recorded by the first commit. + +All of these objects are stored under their SHA1 names inside the git +directory: + +------------------------------------------------ +$ find .git/objects/ +.git/objects/ +.git/objects/pack +.git/objects/info +.git/objects/3b +.git/objects/3b/18e512dba79e4c8300dd08aeb37f8e728b8dad +.git/objects/92 +.git/objects/92/b8b694ffb1675e5975148e1121810081dbdffe +.git/objects/54 +.git/objects/54/196cc2703dc165cbd373a65a4dcf22d50ae7f7 +.git/objects/a0 +.git/objects/a0/423896973644771497bdc03eb99d5281615b51 +.git/objects/d0 +.git/objects/d0/492b368b66bdabf2ac1fd8c92b39d3db916e59 +.git/objects/c4 +.git/objects/c4/d59f390b9cfd4318117afde11d601c1085f241 +------------------------------------------------ + +and the contents of these files is just the compressed data plus a +header identifying their length and their type. The type is either a +blob, a tree, a commit, or a tag. We've seen a blob and a tree now, +so next we should look at a commit. + +The simplest commit to find is the HEAD commit, which we can find +from .git/HEAD: + +------------------------------------------------ +$ cat .git/HEAD +ref: refs/heads/master +------------------------------------------------ + +As you can see, this tells us which branch we're currently on, and it +tells us this by naming a file under the .git directory, which itself +contains a SHA1 name referring to a commit object, which we can +examine with cat-file: + +------------------------------------------------ +$ cat .git/refs/heads/master +c4d59f390b9cfd4318117afde11d601c1085f241 +$ git cat-file -t c4d59f39 +commit +$ git cat-file commit c4d59f39 +tree d0492b368b66bdabf2ac1fd8c92b39d3db916e59 +parent 54196cc2703dc165cbd373a65a4dcf22d50ae7f7 +author J. Bruce Fields <bfields@puzzle.fieldses.org> 1143418702 -0500 +committer J. Bruce Fields <bfields@puzzle.fieldses.org> 1143418702 -0500 + +add emphasis +------------------------------------------------ + +The "tree" object here refers to the new state of the tree: + +------------------------------------------------ +$ git ls-tree d0492b36 +100644 blob a0423896973644771497bdc03eb99d5281615b51 file.txt +$ git cat-file commit a0423896 +hello world! +------------------------------------------------ + +and the "parent" object refers to the previous commit: + +------------------------------------------------ +$ git-cat-file commit 54196cc2 +tree 92b8b694ffb1675e5975148e1121810081dbdffe +author J. Bruce Fields <bfields@puzzle.fieldses.org> 1143414668 -0500 +committer J. Bruce Fields <bfields@puzzle.fieldses.org> 1143414668 -0500 + +initial commit +------------------------------------------------ + +The tree object is the tree we examined first, and this commit is +unusual in that it lacks any parent. + +Most commits have only one parent, but it is also common for a commit +to have multiple parents. In that case the commit represents a +merge, with the parent references pointing to the heads of the merged +branches. + +Besides blobs, trees, and commits, the only remaining type of object +is a "tag", which we won't discuss here; refer to gitlink:git-tag[1] +for details. + +So now we know how git uses the object database to represent a +project's history: + + * "commit" objects refer to "tree" objects representing the + snapshot of a directory tree at a particular point in the + history, and refer to "parent" commits to show how they're + connected into the project history. + * "tree" objects represent the state of a single directory, + associating directory names to "blob" objects containing file + data and "tree" objects containing subdirectory information. + * "blob" objects contain file data without any other structure. + * References to commit objects at the head of each branch are + stored in files under .git/refs/heads/. + * The name of the current branch is stored in .git/HEAD. + +Note, by the way, that lots of commands take a tree as an argument. +But as we can see above, a tree can be referred to in many different +ways--by the SHA1 name for that tree, by the name of a commit that +refers to the tree, by the name of a branch whose head refers to that +tree, etc.--and most such commands can accept any of these names. + +In command synopses, the word "tree-ish" is sometimes used to +designate such an argument. + +The index file +-------------- + +The primary tool we've been using to create commits is "git commit +-a", which creates a commit including every change you've made to +your working tree. But what if you want to commit changes only to +certain files? Or only certain changes to certain files? + +If we look at the way commits are created under the cover, we'll see +that there are more flexible ways creating commits. + +Continuing with our test-project, let's modify file.txt again: + +------------------------------------------------ +$ echo "hello world, again" >>file.txt +------------------------------------------------ + +but this time instead of immediately making the commit, let's take an +intermediate step, and ask for diffs along the way to keep track of +what's happening: + +------------------------------------------------ +$ git diff +--- a/file.txt ++++ b/file.txt +@@ -1 +1,2 @@ + hello world! + +hello world, again +$ git update-index file.txt +$ git diff +------------------------------------------------ + +The last diff is empty, but no new commits have been made, and the +head still doesn't contain the new line: + +------------------------------------------------ +$ git-diff HEAD +diff --git a/file.txt b/file.txt +index a042389..513feba 100644 +--- a/file.txt ++++ b/file.txt +@@ -1 +1,2 @@ + hello world! + +hello world, again +------------------------------------------------ + +So "git diff" is comparing against something other than the head. +The thing that it's comparing against is actually the index file, +which is stored in .git/index in a binary format, but whose contents +we can examine with ls-files: + +------------------------------------------------ +$ git ls-files --stage +100644 513feba2e53ebbd2532419ded848ba19de88ba00 0 file.txt +$ git cat-file -t 513feba2 +blob +$ git cat-file blob 513feba2 +hello world, again +------------------------------------------------ + +So what our "git update-index" did was store a new blob and then put +a reference to it in the index file. If we modify the file again, +we'll see that the new modifications are reflected in the "git-diff" +output: + +------------------------------------------------ +$ echo 'again?' >>file.txt +$ git diff +index 513feba..ba3da7b 100644 +--- a/file.txt ++++ b/file.txt +@@ -1,2 +1,3 @@ + hello world! + hello world, again ++again? +------------------------------------------------ + +With the right arguments, git diff can also show us the difference +between the working directory and the last commit, or between the +index and the last commit: + +------------------------------------------------ +$ git diff HEAD +diff --git a/file.txt b/file.txt +index a042389..ba3da7b 100644 +--- a/file.txt ++++ b/file.txt +@@ -1 +1,3 @@ + hello world! ++hello world, again ++again? +$ git diff --cached +diff --git a/file.txt b/file.txt +index a042389..513feba 100644 +--- a/file.txt ++++ b/file.txt +@@ -1 +1,2 @@ + hello world! ++hello world, again +------------------------------------------------ + +At any time, we can create a new commit using "git commit" (without +the -a option), and verify that the state committed only includes the +changes stored in the index file, not the additional change that is +still only in our working tree: + +------------------------------------------------ +$ git commit -m "repeat" +$ git diff HEAD +diff --git a/file.txt b/file.txt +index 513feba..ba3da7b 100644 +--- a/file.txt ++++ b/file.txt +@@ -1,2 +1,3 @@ + hello world! + hello world, again ++again? +------------------------------------------------ + +So by default "git commit" uses the index to create the commit, not +the working tree; the -a option to commit tells it to first update +the index with all changes in the working tree. + +Finally, it's worth looking at the effect of "git add" on the index +file: + +------------------------------------------------ +$ echo "goodbye, world" >closing.txt +$ git add closing.txt +------------------------------------------------ + +The effect of the "git add" was to add one entry to the index file: + +------------------------------------------------ +$ git ls-files --stage +100644 8b9743b20d4b15be3955fc8d5cd2b09cd2336138 0 closing.txt +100644 513feba2e53ebbd2532419ded848ba19de88ba00 0 file.txt +------------------------------------------------ + +And, as you can see with cat-file, this new entry refers to the +current contents of the file: + +------------------------------------------------ +$ git cat-file blob a6b11f7a +goodbye, word +------------------------------------------------ + +The "status" command is a useful way to get a quick summary of the +situation: + +------------------------------------------------ +$ git status +# +# Updated but not checked in: +# (will commit) +# +# new file: closing.txt +# +# +# Changed but not updated: +# (use git-update-index to mark for commit) +# +# modified: file.txt +# +------------------------------------------------ + +Since the current state of closing.txt is cached in the index file, +it is listed as "updated but not checked in". Since file.txt has +changes in the working directory that aren't reflected in the index, +it is marked "changed but not updated". At this point, running "git +commit" would create a commit that added closing.txt (with its new +contents), but that didn't modify file.txt. + +Also, note that a bare "git diff" shows the changes to file.txt, but +not the addition of closing.txt, because the version of closing.txt +in the index file is identical to the one in the working directory. + +In addition to being the staging area for new commits, the index file +is also populated from the object database when checking out a +branch, and is used to hold the trees involved in a merge operation. +See the link:core-tutorial.txt[core tutorial] and the relevant man +pages for details. + +What next? +---------- + +At this point you should know everything necessary to read the man +pages for any of the git commands; one good place to start would be +with the commands mentioned in link:everday.html[Everyday git]. You +should be able to find any unknown jargon in the +link:glossary.html[Glosssay]. + +The link:cvs-migration.html[CVS migration] document explains how to +import a CVS repository into git, and shows how to use git in a +CVS-like way. + +For some interesting examples of git use, see the +link:howto-index.html[howtos]. + +For git developers, the link:core-tutorial.html[Core tutorial] goes +into detail on the lower-level git mechanisms involved in, for +example, creating a new commit. diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt index 4c298c6..79781ad 100644 --- a/Documentation/tutorial.txt +++ b/Documentation/tutorial.txt @@ -442,7 +442,25 @@ fo the file: Next Steps ---------- -Some good commands to explore next: +This tutorial should be enough to perform basic distributed revision +control for your projects. However, to fully understand the depth +and power of git you need to understand two simple ideas on which it +is based: + + * The object database is the rather elegant system used to + store the history of your project--files, directories, and + commits. + + * The index file is a cache of the state of a directory tree, + used to create commits, check out working directories, and + hold the various trees involved in a merge. + +link:tutorial-2.html[Part two of this tutorial] explains the object +database, the index file, and a few other odds and ends that you'll +need to make the most of git. + +If you don't want to consider with that right away, a few other +digressions that may be interesting at this point are: * gitlink:git-format-patch[1], gitlink:git-am[1]: These convert series of git commits into emailed patches, and vice versa, @@ -456,8 +474,6 @@ Some good commands to explore next: smart enough to perform a close-to-optimal search even in the case of complex non-linear history with lots of merged branches. -Other good starting points include link:everyday.html[Everday GIT -with 20 Commands Or So] and link:cvs-migration.html[git for CVS -users]. Also, link:core-tutorial.html[A short git tutorial] gives an -introduction to lower-level git commands for advanced users and -developers. + * link:everyday.html[Everday GIT with 20 Commands Or So] + + * link:cvs-migration.html[git for CVS users]. -- 1.3.3.gff62 ^ permalink raw reply related [flat|nested] 14+ messages in thread
* Re: totorial-2 Re: (unknown) 2006-05-21 23:53 ` (unknown) J. Bruce Fields @ 2006-05-22 0:35 ` Junio C Hamano 2006-05-22 1:25 ` J. Bruce Fields 2006-05-22 15:27 ` [PATCH 3/3] tutorial: add discussion of index file, object database Jakub Narebski 1 sibling, 1 reply; 14+ messages in thread From: Junio C Hamano @ 2006-05-22 0:35 UTC (permalink / raw) To: J. Bruce Fields; +Cc: git "J. Bruce Fields" <bfields@fieldses.org> writes: > From nobody Mon Sep 17 00:00:00 2001 > From: J. Bruce Fields <bfields@citi.umich.edu> > Date: Sun, 21 May 2006 19:49:34 -0400 > Subject: [PATCH 3/3] tutorial: add discussion of index file, object database Thanks. I like the changes to tutorial.txt too btw. > @@ -0,0 +1,391 @@ > +A tutorial introduction to git: part two >... > +and the contents of these files is just the compressed data plus a > +header identifying their length and their type. The type is either a > +blob, a tree, a commit, or a tag. We've seen a blob and a tree now, > +so next we should look at a commit. >... > +Besides blobs, trees, and commits, the only remaining type of object > +is a "tag", which we won't discuss here; refer to gitlink:git-tag[1] > +for details. We have created a tag in tutorial#1, so it _might_ make sense to just tell the user to cat-file it. > +------------------------------------------------ > +$ git diff > +--- a/file.txt > ++++ b/file.txt > +@@ -1 +1,2 @@ > + hello world! > + +hello world, again > +$ git update-index file.txt > +$ git diff > +------------------------------------------------ Is the second line of the diff " +" intentional? The same comment to the example that immediately follows this part. ^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: totorial-2 Re: (unknown) 2006-05-22 0:35 ` totorial-2 (unknown) Junio C Hamano @ 2006-05-22 1:25 ` J. Bruce Fields 0 siblings, 0 replies; 14+ messages in thread From: J. Bruce Fields @ 2006-05-22 1:25 UTC (permalink / raw) To: Junio C Hamano; +Cc: git On Sun, May 21, 2006 at 05:35:46PM -0700, Junio C Hamano wrote: > "J. Bruce Fields" <bfields@fieldses.org> writes: > > +Besides blobs, trees, and commits, the only remaining type of object > > +is a "tag", which we won't discuss here; refer to gitlink:git-tag[1] > > +for details. > > We have created a tag in tutorial#1, so it _might_ make sense to > just tell the user to cat-file it. The example in tutorial.txt is a "lightweight" tag. The original tutorial.txt (unlike this sequel) doesn't actually try to stick to a consistent example throughout, so it's awkward to refer back. Probably something to fix some day.... > > > +------------------------------------------------ > > +$ git diff > > +--- a/file.txt > > ++++ b/file.txt > > +@@ -1 +1,2 @@ > > + hello world! > > + +hello world, again > > +$ git update-index file.txt > > +$ git diff > > +------------------------------------------------ > > Is the second line of the diff " +" intentional? The same > comment to the example that immediately follows this part. Oops, no--those look like cut'n'paste errors. Would you like a revised patch?--b. ^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: [PATCH 3/3] tutorial: add discussion of index file, object database 2006-05-21 23:53 ` (unknown) J. Bruce Fields 2006-05-22 0:35 ` totorial-2 (unknown) Junio C Hamano @ 2006-05-22 15:27 ` Jakub Narebski 1 sibling, 0 replies; 14+ messages in thread From: Jakub Narebski @ 2006-05-22 15:27 UTC (permalink / raw) To: git J. Bruce Fields wrote: > +With the right arguments, git diff can also show us the difference > +between the working directory and the last commit, or between the > +index and the last commit: > + > +------------------------------------------------ > +$ git diff HEAD [...] > +$ git diff --cached Junio C Hamano wrote: > Also, ":<path>" to mean the > entry in the index is often equivalent to "git diff --cached". > > IOW, these are obscure special purpose notation, and I do not > think tutorial is a good place to cover them. Hmm, wouldn't it be nice to have here :<path> mentioned as alternative/extension to --cached, and <ref>:<path> including HEAD:<path> as an extension of HEAD, and <path> as an extension to not having arguments? By extension I mean adding path limiting and some more advanced selection of things to diff. -- Jakub Narebski Warsaw, Poland ^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: [PATCH 2/3] tutorial: expanded discussion of commit history 2006-05-21 23:53 ` (unknown) J. Bruce Fields 2006-05-21 23:53 ` (unknown) J. Bruce Fields @ 2006-05-22 8:23 ` Jakub Narebski 2006-05-22 8:45 ` Junio C Hamano 1 sibling, 1 reply; 14+ messages in thread From: Jakub Narebski @ 2006-05-22 8:23 UTC (permalink / raw) To: git J. Bruce Fields wrote: > +Finally, most commands that take filenames will optionally allow you > +to precede any filename by a commit, to specify a particular version > +fo the file: > + > +------------------------------------- > +$ git diff v2.5:Makefile HEAD:Makefile.in > +------------------------------------- Why not mention also :<stage>:<filename>, or would <stage> be not defined in this place of tutorial? -- Jakub Narebski Warsaw, Poland ^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: [PATCH 2/3] tutorial: expanded discussion of commit history 2006-05-22 8:23 ` [PATCH 2/3] tutorial: expanded discussion of commit history Jakub Narebski @ 2006-05-22 8:45 ` Junio C Hamano 2006-05-22 9:01 ` Jakub Narebski 0 siblings, 1 reply; 14+ messages in thread From: Junio C Hamano @ 2006-05-22 8:45 UTC (permalink / raw) To: Jakub Narebski; +Cc: git Jakub Narebski <jnareb@gmail.com> writes: > J. Bruce Fields wrote: > >> +Finally, most commands that take filenames will optionally allow you >> +to precede any filename by a commit, to specify a particular version >> +fo the file: >> + >> +------------------------------------- >> +$ git diff v2.5:Makefile HEAD:Makefile.in >> +------------------------------------- > > Why not mention also :<stage>:<filename>, or would <stage> be not defined in > this place of tutorial? I do not think being able to do diff with arbitrary stage is often used in practice. By definition, you would want to do diff with a stage during a conflicted merge, and most of the time the default combined diff without any colon form should give you the most useful results. Also, ":<path>" to mean the entry in the index is often equivalent to "git diff --cached". IOW, these are obscure special purpose notation, and I do not think tutorial is a good place to cover them. ^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: [PATCH 2/3] tutorial: expanded discussion of commit history 2006-05-22 8:45 ` Junio C Hamano @ 2006-05-22 9:01 ` Jakub Narebski 2006-05-22 14:18 ` J. Bruce Fields 0 siblings, 1 reply; 14+ messages in thread From: Jakub Narebski @ 2006-05-22 9:01 UTC (permalink / raw) To: git Junio C Hamano wrote: > Jakub Narebski <jnareb@gmail.com> writes: > >> J. Bruce Fields wrote: >> >>> +Finally, most commands that take filenames will optionally allow you >>> +to precede any filename by a commit, to specify a particular version >>> +fo the file: >>> + >>> +------------------------------------- >>> +$ git diff v2.5:Makefile HEAD:Makefile.in >>> +------------------------------------- >> >> Why not mention also :<stage>:<filename>, or would <stage> be not defined in >> this place of tutorial? > > I do not think being able to do diff with arbitrary stage is > often used in practice. By definition, you would want to do > diff with a stage during a conflicted merge, and most of the > time the default combined diff without any colon form should > give you the most useful results. Also, ":<path>" to mean the > entry in the index is often equivalent to "git diff --cached". > > IOW, these are obscure special purpose notation, and I do not > think tutorial is a good place to cover them. Hmmm... perhaps in tutorial-3.txt, covering merges and how to resolve conflicted merge, cherry picking, reverting and rebasing. And of course some git workflows covering usage of branches (including pull/push, fast-forward and "union" branches like 'pu' branch in git). Well, perhaps not tutorial, but Git Cookbook, or Git Receipies, or Git Usage Examples,... -- Jakub Narebski Warsaw, Poland ^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: [PATCH 2/3] tutorial: expanded discussion of commit history 2006-05-22 9:01 ` Jakub Narebski @ 2006-05-22 14:18 ` J. Bruce Fields 0 siblings, 0 replies; 14+ messages in thread From: J. Bruce Fields @ 2006-05-22 14:18 UTC (permalink / raw) To: Jakub Narebski; +Cc: git On Mon, May 22, 2006 at 11:01:20AM +0200, Jakub Narebski wrote: > Junio C Hamano wrote: > > I do not think being able to do diff with arbitrary stage is > > often used in practice. By definition, you would want to do > > diff with a stage during a conflicted merge, and most of the > > time the default combined diff without any colon form should > > give you the most useful results. Also, ":<path>" to mean the > > entry in the index is often equivalent to "git diff --cached". > > > > IOW, these are obscure special purpose notation, and I do not > > think tutorial is a good place to cover them. > > Hmmm... perhaps in tutorial-3.txt, covering merges and how to resolve > conflicted merge, cherry picking, reverting and rebasing. Even then I had the impression that stages were pretty much invisible to users. So that should stay in core-tutorial.txt. Which could use some revision (Junio had some ideas) but I'm personally more interested in end-user documentation than developer documentation for now. So I'd imagined future tutorial parts cannibalizing everyday.txt and the howto's. --b. ^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: your mail 2006-05-21 23:53 (unknown) J. Bruce Fields 2006-05-21 23:53 ` (unknown) J. Bruce Fields @ 2006-05-21 23:55 ` J. Bruce Fields 2006-05-22 0:16 ` Junio C Hamano 2006-05-22 10:09 ` [PATCH] git help: remove whatchanged from list of common commands Martin Waitz 2 siblings, 1 reply; 14+ messages in thread From: J. Bruce Fields @ 2006-05-21 23:55 UTC (permalink / raw) To: Junio C Hamano; +Cc: git On Sun, May 21, 2006 at 07:53:18PM -0400, J. Bruce Fields wrote: > >From nobody Mon Sep 17 00:00:00 2001 > From: J. Bruce Fields <bfields@citi.umich.edu> Oops, sorry, I screwed up sending those; let me know if you'd like them resent.... --b. ^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: your mail 2006-05-21 23:55 ` your mail J. Bruce Fields @ 2006-05-22 0:16 ` Junio C Hamano 2006-05-22 1:33 ` J. Bruce Fields 0 siblings, 1 reply; 14+ messages in thread From: Junio C Hamano @ 2006-05-22 0:16 UTC (permalink / raw) To: J. Bruce Fields; +Cc: git "J. Bruce Fields" <bfields@fieldses.org> writes: > On Sun, May 21, 2006 at 07:53:18PM -0400, J. Bruce Fields wrote: >> >From nobody Mon Sep 17 00:00:00 2001 >> From: J. Bruce Fields <bfields@citi.umich.edu> > > Oops, sorry, I screwed up sending those; let me know if you'd like them > resent.... That's OK. I just cooked up this one ;-). -- >8 -- From 03946787890c12fbb6ecfbe0382cbf02ac209801 Mon Sep 17 00:00:00 2001 From: Junio C Hamano <junkio@cox.net> Date: Sun, 21 May 2006 17:15:06 -0700 Subject: [PATCH] mailinfo: skip bogus UNIX From line inside body Sometimes people just include the whole format-patch output in the commit e-mail. Detect it and skip the bogus ">From " line. Signed-off-by: Junio C Hamano <junkio@cox.net> --- mailinfo.c | 7 +++++++ 1 files changed, 7 insertions(+), 0 deletions(-) diff --git a/mailinfo.c b/mailinfo.c index b276519..a133e6d 100644 --- a/mailinfo.c +++ b/mailinfo.c @@ -237,10 +237,17 @@ static int eatspace(char *line) #define SEEN_FROM 01 #define SEEN_DATE 02 #define SEEN_SUBJECT 04 +#define SEEN_BOGUS_UNIX_FROM 010 /* First lines of body can have From:, Date:, and Subject: */ static int handle_inbody_header(int *seen, char *line) { + if (!memcmp(">From", line, 5) && isspace(line[5])) { + if (!(*seen & SEEN_BOGUS_UNIX_FROM)) { + *seen |= SEEN_BOGUS_UNIX_FROM; + return 1; + } + } if (!memcmp("From:", line, 5) && isspace(line[5])) { if (!(*seen & SEEN_FROM) && handle_from(line+6)) { *seen |= SEEN_FROM; -- 1.3.3.g292f ^ permalink raw reply related [flat|nested] 14+ messages in thread
* Re: your mail 2006-05-22 0:16 ` Junio C Hamano @ 2006-05-22 1:33 ` J. Bruce Fields 0 siblings, 0 replies; 14+ messages in thread From: J. Bruce Fields @ 2006-05-22 1:33 UTC (permalink / raw) To: Junio C Hamano; +Cc: git On Sun, May 21, 2006 at 05:16:44PM -0700, Junio C Hamano wrote: > "J. Bruce Fields" <bfields@fieldses.org> writes: > > > On Sun, May 21, 2006 at 07:53:18PM -0400, J. Bruce Fields wrote: > >> >From nobody Mon Sep 17 00:00:00 2001 > >> From: J. Bruce Fields <bfields@citi.umich.edu> > > > > Oops, sorry, I screwed up sending those; let me know if you'd like them > > resent.... > > That's OK. I just cooked up this one ;-). Thanks!--b. ^ permalink raw reply [flat|nested] 14+ messages in thread
* [PATCH] git help: remove whatchanged from list of common commands 2006-05-21 23:53 (unknown) J. Bruce Fields 2006-05-21 23:53 ` (unknown) J. Bruce Fields 2006-05-21 23:55 ` your mail J. Bruce Fields @ 2006-05-22 10:09 ` Martin Waitz 2 siblings, 0 replies; 14+ messages in thread From: Martin Waitz @ 2006-05-22 10:09 UTC (permalink / raw) To: J. Bruce Fields; +Cc: Junio C Hamano, git whatchanged is replaced by git log now. Signed-off-by: Martin Waitz --- 7da71dafe75f2a682b07cd1140a29e6fd2705583 generate-cmdlist.sh | 1 - 1 files changed, 0 insertions(+), 1 deletions(-) 7da71dafe75f2a682b07cd1140a29e6fd2705583 diff --git a/generate-cmdlist.sh b/generate-cmdlist.sh index 6c59dbd..ec1eda2 100755 --- a/generate-cmdlist.sh +++ b/generate-cmdlist.sh @@ -37,7 +37,6 @@ show-branch status tag verify-tag -whatchanged EOF while read cmd do -- 1.3.3.g288c -- Martin Waitz ^ permalink raw reply related [flat|nested] 14+ messages in thread
end of thread, other threads:[~2006-05-22 15:28 UTC | newest] Thread overview: 14+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2006-05-21 23:53 (unknown) J. Bruce Fields 2006-05-21 23:53 ` (unknown) J. Bruce Fields 2006-05-21 23:53 ` (unknown) J. Bruce Fields 2006-05-22 0:35 ` totorial-2 (unknown) Junio C Hamano 2006-05-22 1:25 ` J. Bruce Fields 2006-05-22 15:27 ` [PATCH 3/3] tutorial: add discussion of index file, object database Jakub Narebski 2006-05-22 8:23 ` [PATCH 2/3] tutorial: expanded discussion of commit history Jakub Narebski 2006-05-22 8:45 ` Junio C Hamano 2006-05-22 9:01 ` Jakub Narebski 2006-05-22 14:18 ` J. Bruce Fields 2006-05-21 23:55 ` your mail J. Bruce Fields 2006-05-22 0:16 ` Junio C Hamano 2006-05-22 1:33 ` J. Bruce Fields 2006-05-22 10:09 ` [PATCH] git help: remove whatchanged from list of common commands Martin Waitz
Code repositories for project(s) associated with this public inbox https://80x24.org/mirrors/git.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).