diff options
| author | Shawn O. Pearce <spearce@spearce.org> | 2007-05-21 03:20:25 -0400 |
|---|---|---|
| committer | Junio C Hamano <junkio@cox.net> | 2007-05-21 23:56:28 -0700 |
| commit | 23615708e2abef5c293ddee9335950161a038133 (patch) | |
| tree | ae1e929a1ebc5342b977ad6a8dedf82376eebecb /Documentation | |
| parent | 302b9282c9ddfcc704ca759bdc98c1d5f75eba2f (diff) | |
| download | git-23615708e2abef5c293ddee9335950161a038133.tar.gz git-23615708e2abef5c293ddee9335950161a038133.tar.xz | |
Teach git-describe how to run name-rev
Often users want to know not which tagged version a commit came
after, but which tagged version a commit is contained within.
This latter task is the job of git-name-rev, but most users are
looking to git-describe to do the job.
Junio suggested we make `git describe --contains` run the correct
tool, `git name-rev`, and that's exactly what we do here. The output
of name-rev was adjusted slightly through the new --name-only option,
allowing describe to execv into name-rev and maintain its current
output format.
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-describe.txt | 7 | ||||
| -rw-r--r-- | Documentation/git-name-rev.txt | 7 |
2 files changed, 13 insertions, 1 deletions
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index 47a583d3a..dc47b65ce 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] [--abbrev=<n>] <committish>... +'git-describe' [--all] [--tags] [--contains] [--abbrev=<n>] <committish>... DESCRIPTION ----------- @@ -31,6 +31,11 @@ OPTIONS Instead of using only the annotated tags, use any tag found in `.git/refs/tags`. +--contains:: + Instead of finding the tag that predates the commit, find + the tag that comes after the commit, and thus contains it. + Automatically implies --tags. + --abbrev=<n>:: Instead of using the default 8 hexadecimal digits as the abbreviated object name, use <n> digits. diff --git a/Documentation/git-name-rev.txt b/Documentation/git-name-rev.txt index d6c8bf800..9a1645d29 100644 --- a/Documentation/git-name-rev.txt +++ b/Documentation/git-name-rev.txt @@ -34,6 +34,13 @@ OPTIONS Read from stdin, append "(<rev_name>)" to all sha1's of nameable commits, and pass to stdout +--name-only:: + Instead of printing both the SHA-1 and the name, print only + the name. If given with --tags the usual tag prefix of + "tags/" is also ommitted from the name, matching the output + of gitlink::git-describe[1] more closely. This option + cannot be combined with --stdin. + EXAMPLE ------- |