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.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.txt')
-rw-r--r-- | Documentation/gittutorial.txt | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt index 144bacd3d..87e60379e 100644 --- a/Documentation/gittutorial.txt +++ b/Documentation/gittutorial.txt @@ -117,7 +117,7 @@ $ git commit This will again prompt you for a message describing the change, and then record a new version of the project. -Alternatively, instead of running `git add` beforehand, you can use +Alternatively, instead of running `git-add` beforehand, you can use ------------------------------------------------ $ git commit -a @@ -138,7 +138,7 @@ Git tracks content not files Many revision control systems provide an "add" command that tells the system to start tracking changes to a new file. Git's "add" command -does something simpler and more powerful: `git add` is used both for new +does something simpler and more powerful: `git-add` is used both for new and newly modified files, and in both cases it takes a snapshot of the given files and stages that content in the index, ready for inclusion in the next commit. @@ -316,7 +316,7 @@ $ git remote add bob /home/bob/myrepo ------------------------------------------------ With this, Alice can perform the first operation alone using the -"git fetch" command without merging them with her own branch, +"git-fetch" command without merging them with her own branch, using: ------------------------------------- @@ -324,7 +324,7 @@ $ git fetch bob ------------------------------------- Unlike the longhand form, when Alice fetches from Bob using a -remote repository shorthand set up with `git remote`, what was +remote repository shorthand set up with `git-remote`, what was fetched is stored in a remote tracking branch, in this case `bob/master`. So after this: @@ -398,7 +398,7 @@ Exploring history ----------------- Git history is represented as a series of interrelated commits. We -have already seen that the git log command can list those commits. +have already seen that the git-log command can list those commits. Note that first line of each git log entry also gives a name for the commit: @@ -411,7 +411,7 @@ Date: Tue May 16 17:18:22 2006 -0700 merge-base: Clarify the comments on post processing. ------------------------------------- -We can give this name to git show to see the details about this +We can give this name to git-show to see the details about this commit. ------------------------------------- @@ -447,7 +447,7 @@ $ git show HEAD^2 # show the second parent of HEAD You can also give commits names of your own; after running ------------------------------------- -$ git-tag v2.5 1b2e1d63ff +$ git tag v2.5 1b2e1d63ff ------------------------------------- you can refer to 1b2e1d63ff by the name "v2.5". If you intend to @@ -469,13 +469,13 @@ $ git reset --hard HEAD^ # reset your current branch and working Be careful with that last command: in addition to losing any changes in the working directory, it will also remove all later commits from this branch. If this branch is the only branch containing those -commits, they will be lost. Also, don't use "git reset" on a +commits, they will be lost. Also, don't use "git-reset" on a publicly-visible branch that other developers pull from, as it will force needless merges on other developers to clean up the history. If you need to undo changes that you have pushed, use linkgit:git-revert[1] instead. -The git grep command can search for strings in any version of your +The git-grep command can search for strings in any version of your project, so ------------------------------------- @@ -484,7 +484,7 @@ $ git grep "hello" v2.5 searches for all occurrences of "hello" in v2.5. -If you leave out the commit name, git grep will search any of the +If you leave out the commit name, git-grep will search any of the files it manages in your current directory. So ------------------------------------- @@ -494,7 +494,7 @@ $ git grep "hello" is a quick way to search just the files that are tracked by git. Many git commands also take sets of commits, which can be specified -in a number of ways. Here are some examples with git log: +in a number of ways. Here are some examples with git-log: ------------------------------------- $ git log v2.5..v2.6 # commits between v2.5 and v2.6 @@ -504,7 +504,7 @@ $ git log v2.5.. Makefile # commits since v2.5 which modify # Makefile ------------------------------------- -You can also give git log a "range" of commits where the first is not +You can also give git-log a "range" of commits where the first is not necessarily an ancestor of the second; for example, if the tips of the branches "stable-release" and "master" diverged from a common commit some time ago, then @@ -523,9 +523,9 @@ $ git log experimental..stable will show the list of commits made on the stable branch but not the experimental branch. -The "git log" command has a weakness: it must present commits in a +The "git-log" command has a weakness: it must present commits in a list. When the history has lines of development that diverged and -then merged back together, the order in which "git log" presents +then merged back together, the order in which "git-log" presents those commits is meaningless. Most projects with multiple contributors (such as the linux kernel, @@ -549,7 +549,7 @@ of the file: $ git diff v2.5:Makefile HEAD:Makefile.in ------------------------------------- -You can also use "git show" to see any such file: +You can also use "git-show" to see any such file: ------------------------------------- $ git show v2.5:Makefile |