summaryrefslogtreecommitdiff
path: root/Documentation/tutorial.txt
diff options
context:
space:
mode:
authorJunio C Hamano <junkio@cox.net>2005-12-13 10:38:24 (GMT)
committerJunio C Hamano <junkio@cox.net>2005-12-13 10:38:24 (GMT)
commit9755afbd9467759bb77a6e5a535791243c5b907d (patch)
treea0d957e0aa54ea6e279cda602ef4e0902db33f6b /Documentation/tutorial.txt
parent803f498c03b47b1da88cf8f14ba2c374f0fc16d3 (diff)
downloadgit-9755afbd9467759bb77a6e5a535791243c5b907d.zip
git-9755afbd9467759bb77a6e5a535791243c5b907d.tar.gz
git-9755afbd9467759bb77a6e5a535791243c5b907d.tar.bz2
Documentation: not learning core git commands.
The initial section of tutorial was too heavy on internal workings for the first-time readers, so rewrite the introductory section of git(7) to start with "not learning core git commands" section and refer them to README to grasp the basic concepts, then Everyday to give overview with task/role oriented examples for minimum set of commands, and finally the tutorial. Also add to existing note in the tutorial that many too technical descriptions can be skipped by a casual reader. I initially started to review the tutorial, with the objective of ripping out the detailed technical information altogether, but I found that the level of details in the initial couple of sections that talk about refs and the object database in a hands-on fashion was about rigth, and left all of them there. I feel that reading about fsck-index and repack is too abstract without being aware of these directories and files. Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/tutorial.txt')
-rw-r--r--Documentation/tutorial.txt20
1 files changed, 19 insertions, 1 deletions
diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt
index 0827056..a61b824 100644
--- a/Documentation/tutorial.txt
+++ b/Documentation/tutorial.txt
@@ -18,7 +18,14 @@ doing.
The core git is often called "plumbing", with the prettier user
interfaces on top of it called "porcelain". You may not want to use the
plumbing directly very often, but it can be good to know what the
-plumbing does for when the porcelain isn't flushing...
+plumbing does for when the porcelain isn't flushing.
+
+The material presented here often goes deep describing how things
+work internally. If you are mostly interested in using git as a
+SCM, you can skip them during your first pass.
+
+[NOTE]
+And those "too deep" descriptions are often marked as Note.
Creating a git repository
@@ -252,6 +259,17 @@ tree. That's very useful.
A common shorthand for `git-diff-files -p` is to just write `git
diff`, which will do the same thing.
+------------
+$ git diff
+diff --git a/hello b/hello
+index 557db03..263414f 100644
+--- a/hello
++++ b/hello
+@@ -1 +1,2 @@
+ Hello World
++It's a new day for git
+------------
+
Committing git state
--------------------