undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation: tutorial editing

Browse Source 
Edit for conciseness.

Add a "Making changes" section header.

When possible, make sure that stuff in text boxes could be entered literally.
(Don't use "..." unless we want a user to type that.)

Move 'commit -a' example into a literal code section, clarify that it finds
modified files automatically.

Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
J. Bruce Fields 2007-01-06 22:38:38 -05:00 committed by Junio C Hamano
parent 2eff14259e
commit 84dee6bbc9
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/tutorial.txt
View File

@ -43,8 +43,7 @@ Initialized empty Git repository in .git/
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 (notice the dot '.'
that means the current directory):
every file under the current directory (note the '.') with:
------------------------------------------------
$ git add .
@ -59,6 +58,9 @@ $ git commit
will prompt you for a commit message, then record the current state
of all the files to the repository.
Making changes
--------------
Try modifying some files, then run
------------------------------------------------
@ -70,19 +72,21 @@ want the updated contents of these files in the commit and then
make a commit, like this:
------------------------------------------------
$ git add file1 file...
$ git add file1 file2 file3
$ git commit
------------------------------------------------
This will again prompt your for a message describing the change, and then
record the new versions of the files you listed. It is cumbersome
to list all files and you can say `git commit -a` (which stands for 'all')
instead of running `git add` beforehand.
record the new versions of the files you listed.
Alternatively, instead of running `git add` beforehand, you can use
------------------------------------------------
$ git commit -a
------------------------------------------------
which will automatically notice modified (but not new) files.
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)
line summarizing the change, followed by a blank line and then a more