Merge branch 'master' of git://git.kernel.org/pub/scm/git/git
[git/jnareb-git.git] / Documentation / git-name-rev.txt
blobad1d1468c9936d206701d379003177e7457c884e
1 git-name-rev(1)
2 ===============
4 NAME
5 ----
6 git-name-rev - Find symbolic names for given revs
9 SYNOPSIS
10 --------
11 [verse]
12 'git name-rev' [--tags] [--refs=<pattern>]
13                ( --all | --stdin | <committish>... )
15 DESCRIPTION
16 -----------
17 Finds symbolic names suitable for human digestion for revisions given in any
18 format parsable by 'git rev-parse'.
21 OPTIONS
22 -------
24 --tags::
25         Do not use branch names, but only tags to name the commits
27 --refs=<pattern>::
28         Only use refs whose names match a given shell pattern.
30 --all::
31         List all commits reachable from all refs
33 --stdin::
34         Read from stdin, append "(<rev_name>)" to all sha1's of nameable
35         commits, and pass to stdout
37 --name-only::
38         Instead of printing both the SHA-1 and the name, print only
39         the name.  If given with --tags the usual tag prefix of
40         "tags/" is also omitted from the name, matching the output
41         of `git-describe` more closely.
43 --no-undefined::
44         Die with error code != 0 when a reference is undefined,
45         instead of printing `undefined`.
47 --always::
48         Show uniquely abbreviated commit object as fallback.
50 EXAMPLE
51 -------
53 Given a commit, find out where it is relative to the local refs. Say somebody
54 wrote you about that fantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a.
55 Of course, you look into the commit, but that only tells you what happened, but
56 not the context.
58 Enter 'git name-rev':
60 ------------
61 % git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
62 33db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99~940
63 ------------
65 Now you are wiser, because you know that it happened 940 revisions before v0.99.
67 Another nice thing you can do is:
69 ------------
70 % git log | git name-rev --stdin
71 ------------
73 GIT
74 ---
75 Part of the linkgit:git[1] suite