path: root/Documentation/tutorial.txt
diff options
authorJunio C Hamano <>2006-11-29 08:17:01 (GMT)
committerJunio C Hamano <>2006-11-29 18:34:18 (GMT)
commit665892307013bccacb35dd619ae6951c7b209379 (patch)
tree47ba51cde1ee91845001234c30566720ae0ed8f5 /Documentation/tutorial.txt
parent6bee4e408c097a4f0c4a091f13dacabe7c766025 (diff)
tutorial: talk about early and don't start with commit -a
Introducing yourself to git early would be a good idea; otherwise the user may not find the mistake until much later when "git log" is learned. Teaching "commit -a" without saying that it is a shortcut for listing the paths to commit leaves the user puzzled. Teach the form with explicit paths first. Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/tutorial.txt')
1 files changed, 24 insertions, 5 deletions
diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt
index 1e4ddfb..6555e58 100644
--- a/Documentation/tutorial.txt
+++ b/Documentation/tutorial.txt
@@ -11,6 +11,18 @@ diff" with:
$ man git-diff
+It is a good idea to introduce yourself to git before doing any
+operation. The easiest way to do so is:
+$ cat >~/.gitconfig <<\EOF
+ name = Your Name Comes Here
+ email =
Importing a new project
@@ -31,7 +43,8 @@ defaulting to local storage area
You've now initialized the working directory--you may notice a new
directory created, named ".git". Tell git that you want it to track
-every file under the current directory with
+every file under the current directory with (notice the dot '.'
+that means the current directory):
$ git add .
@@ -40,7 +53,7 @@ $ git add .
-$ git commit -a
+$ git commit
will prompt you for a commit message, then record the current state
@@ -55,11 +68,17 @@ $ git diff
to review your changes. When you're done,
-$ git commit -a
+$ git commit file1 file2...
will again prompt your for a message describing the change, and then
-record the new versions of the modified files.
+record the new versions of the files you listed. It is cumbersome
+to list all files and you can say `-a` (which stands for 'all')
+$ git commit -a
A note on commit messages: Though not required, it's a good idea to
begin the commit message with a single short (less than 50 character)
@@ -75,7 +94,7 @@ $ git add path/to/new/file
then commit as usual. No special command is required when removing a
-file; just remove it, then commit.
+file; just remove it, then tell `commit` about the file as usual.
At any point you can view the history of your changes using