diff options
| author | Jonathan Nieder <jrnieder@uchicago.edu> | 2008-06-30 01:09:04 -0500 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2008-07-01 17:20:15 -0700 |
| commit | b1889c36d85514e5e70462294c561a02c2edfe2b (patch) | |
| tree | 9a171d7e3fb8063c239a2c9c4dcec744a202de07 /Documentation/gittutorial-2.txt | |
| parent | 46e56e81b3bc91af7071809fbda8dcdec22c4cb1 (diff) | |
| download | git-b1889c36d85514e5e70462294c561a02c2edfe2b.tar.gz git-b1889c36d85514e5e70462294c561a02c2edfe2b.tar.xz | |
Documentation: be consistent about "git-" versus "git "
Since the git-* commands are not installed in $(bindir), using
"git-command <parameters>" in examples in the documentation is
not a good idea. On the other hand, it is nice to be able to
refer to each command using one hyphenated word. (There is no
escaping it, anyway: man page names cannot have spaces in them.)
This patch retains the dash in naming an operation, command,
program, process, or action. Complete command lines that can
be entered at a shell (i.e., without options omitted) are
made to use the dashless form.
The changes consist only of replacing some spaces with hyphens
and vice versa. After a "s/ /-/g", the unpatched and patched
versions are identical.
Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/gittutorial-2.txt')
| -rw-r--r-- | Documentation/gittutorial-2.txt | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/Documentation/gittutorial-2.txt b/Documentation/gittutorial-2.txt index 2c5467057..f2624aa22 100644 --- a/Documentation/gittutorial-2.txt +++ b/Documentation/gittutorial-2.txt @@ -212,7 +212,7 @@ designate such an argument. The index file -------------- -The primary tool we've been using to create commits is "git commit +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? @@ -255,7 +255,7 @@ index a042389..513feba 100644 +hello world, again ------------------------------------------------ -So "git diff" is comparing against something other than the head. +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: @@ -270,9 +270,9 @@ hello world! hello world, again ------------------------------------------------ -So what our "git add" did was store a new blob and then put +So what our "git-add" 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" +we'll see that the new modifications are reflected in the "git-diff" output: ------------------------------------------------ @@ -287,7 +287,7 @@ index 513feba..ba3da7b 100644 +again? ------------------------------------------------ -With the right arguments, git diff can also show us the difference +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: @@ -311,7 +311,7 @@ index a042389..513feba 100644 +hello world, again ------------------------------------------------ -At any time, we can create a new commit using "git commit" (without +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: @@ -329,11 +329,11 @@ index 513feba..ba3da7b 100644 +again? ------------------------------------------------ -So by default "git commit" uses the index to create the commit, not +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 +Finally, it's worth looking at the effect of "git-add" on the index file: ------------------------------------------------ @@ -341,7 +341,7 @@ $ echo "goodbye, world" >closing.txt $ git add closing.txt ------------------------------------------------ -The effect of the "git add" was to add one entry to the index file: +The effect of the "git-add" was to add one entry to the index file: ------------------------------------------------ $ git ls-files --stage |