summaryrefslogtreecommitdiff
path: root/Documentation/git-describe.txt
diff options
context:
space:
mode:
authorJonathan Nieder <jrnieder@uchicago.edu>2008-06-30 13:56:34 -0500
committerJunio C Hamano <gitster@pobox.com>2008-07-01 17:20:16 -0700
commit483bc4f045881b998512ae814d6cf44d0c0cb493 (patch)
tree1812b25a8f08841bd4cfb6566636ce6fb5b8eac3 /Documentation/git-describe.txt
parentb1889c36d85514e5e70462294c561a02c2edfe2b (diff)
downloadgit-483bc4f045881b998512ae814d6cf44d0c0cb493.tar.gz
Documentation formatting and cleanup
Following what appears to be the predominant style, format names of commands and commandlines both as `teletype text`. While we're at it, add articles ("a" and "the") in some places, italicize the name of the command in the manual page synopsis line, and add a comma or two where it seems appropriate. 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.txt8
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index b6c86c2aea..51a0cc044f 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -92,7 +92,7 @@ of commits which would be displayed by "git log v1.0.4..parent".
The hash suffix is "-g" + 7-char abbreviation for the tip commit
of parent (which was `2414721b194453f058079d897d13c4e377f92dc6`).
-Doing a "git-describe" on a tag-name will just show the tag name:
+Doing a `git-describe` on a tag-name will just show the tag name:
[torvalds@g5 git]$ git describe v1.0.4
v1.0.4
@@ -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.
@@ -129,7 +129,7 @@ abbreviation of the input committish's SHA1.
If multiple tags were found during the walk then the tag which
has the fewest commits different from the input committish will be
selected and output. Here fewest commits different is defined as
-the number of commits which would be shown by "git log tag..input"
+the number of commits which would be shown by `git log tag..input`
will be the smallest number of commits possible.