diff options
| author |  J. Bruce Fields <bfields@fieldses.org> | 2007-01-06 22:38:38 -0500 |
|---|---|---|
| committer |  Junio C Hamano <junkio@cox.net> | 2007-01-06 22:48:41 -0800 |
| commit | 84dee6bbc9eb6dd8e613414ed0271d8290549e89 (patch) | |
| tree | 9b8b9274a2619d314c081210e57f6b6cf056ec6d /Documentation | |
| parent | Documentation/git-svn: clarify dcommit, rebase vs pull/merge (diff) | |
| download | tgif-84dee6bbc9eb6dd8e613414ed0271d8290549e89.tar.xz | |
Documentation: tutorial editing
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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/tutorial.txt | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt index 79884d9c74..01d4a47a97 100644 --- a/Documentation/tutorial.txt +++ b/Documentation/tutorial.txt @@ -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 |