diff options
| author | Jonathan Nieder <jrnieder@uchicago.edu> | 2008-06-30 06:09:04 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2008-07-02 00:20:15 (GMT) |
| commit | b1889c36d85514e5e70462294c561a02c2edfe2b (patch) | |
| tree | 9a171d7e3fb8063c239a2c9c4dcec744a202de07 /Documentation/git-describe.txt | |
| parent | 46e56e81b3bc91af7071809fbda8dcdec22c4cb1 (diff) | |
| download | git-b1889c36d85514e5e70462294c561a02c2edfe2b.zip git-b1889c36d85514e5e70462294c561a02c2edfe2b.tar.gz git-b1889c36d85514e5e70462294c561a02c2edfe2b.tar.bz2 | |
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/git-describe.txt')
| -rw-r--r-- | Documentation/git-describe.txt | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index 9f6f483..b6c86c2 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@ -8,7 +8,7 @@ git-describe - Show the most recent tag that is reachable from a commit SYNOPSIS -------- -'git-describe' [--all] [--tags] [--contains] [--abbrev=<n>] <committish>... +'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] <committish>... DESCRIPTION ----------- @@ -78,7 +78,7 @@ EXAMPLES With something like git.git current tree, I get: - [torvalds@g5 git]$ git-describe parent + [torvalds@g5 git]$ git describe parent v1.0.4-14-g2414721 i.e. the current head of my "parent" branch is based on v1.0.4, @@ -94,7 +94,7 @@ of parent (which was `2414721b194453f058079d897d13c4e377f92dc6`). Doing a "git-describe" on a tag-name will just show the tag name: - [torvalds@g5 git]$ git-describe v1.0.4 + [torvalds@g5 git]$ git describe v1.0.4 v1.0.4 With --all, the command can use branch heads as references, so @@ -115,13 +115,13 @@ closest tagname without any suffix: SEARCH STRATEGY --------------- -For each committish supplied "git describe" will first look for +For each committish supplied "git-describe" will first look for a tag which tags exactly that commit. Annotated tags will always be preferred over lightweight tags, and tags with newer dates will always be preferred over tags with older dates. If an exact match is found, its name will be output and searching will stop. -If an exact match was not found "git describe" will walk back +If an exact match was not found "git-describe" will walk back through the commit history to locate an ancestor commit which has been tagged. The ancestor's tag will be output along with an abbreviation of the input committish's SHA1. |