Merge branch 'maint'

[git.git] / Documentation / git-name-rev.txt

diff --git a/Documentation/git-name-rev.txt b/Documentation/git-name-rev.txt
index e37b0b8f97966732f309ce6605938f3e61d9c4d3..306e1a4956eb72892729a3283c29ee6355da2c22 100644 (file)
--- a/Documentation/git-name-rev.txt
+++ b/Documentation/git-name-rev.txt
@@ -3,12 +3,14 @@ git-name-rev(1)
 
 NAME
 ----
 
 NAME
 ----

-git-name-rev - Find symbolic names for given revs.
+git-name-rev - Find symbolic names for given revs

 
 
 SYNOPSIS
 --------
 
 
 SYNOPSIS
 --------

-'git-name-rev' [--tags] ( --all | --stdin | <commitish>... )
+[verse]
+'git-name-rev' [--tags] [--refs=<pattern>]
+              ( --all | --stdin | <committish>... )

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -22,18 +24,28 @@ OPTIONS
 --tags::
        Do not use branch names, but only tags to name the commits
 
 --tags::
        Do not use branch names, but only tags to name the commits
 

+--refs=<pattern>::
+       Only use refs whose names match a given shell pattern.
+

 --all::
        List all commits reachable from all refs
 
 --stdin::
 --all::
        List all commits reachable from all refs
 
 --stdin::

-       Read from stdin, append "(<rev_name>)" to all sha1's of name'able
+       Read from stdin, append "(<rev_name>)" to all sha1's of nameable

        commits, and pass to stdout
 
        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 omitted from the name, matching the output
+       of gitlink::git-describe[1] more closely.  This option
+       cannot be combined with --stdin.
+

 EXAMPLE
 -------
 
 Given a commit, find out where it is relative to the local refs. Say somebody
 EXAMPLE
 -------
 
 Given a commit, find out where it is relative to the local refs. Say somebody

-wrote you about that phantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a.
+wrote you about that fantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a.

 Of course, you look into the commit, but that only tells you what happened, but
 not the context.
 
 Of course, you look into the commit, but that only tells you what happened, but
 not the context.
 


@@ -41,6 +53,7 @@ Enter git-name-rev:
 
 ------------
 % git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
 
 ------------
 % git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a

+33db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99^0~940

 ------------
 
 Now you are wiser, because you know that it happened 940 revisions before v0.99.
 ------------
 
 Now you are wiser, because you know that it happened 940 revisions before v0.99.


@@ -63,4 +76,3 @@ Documentation by Johannes Schindelin.
 GIT
 ---
 Part of the gitlink:git[7] suite
 GIT
 ---
 Part of the gitlink:git[7] suite

-