Merge branch 'maint' of git://repo.or.cz/git-gui into maint
[git] / Documentation / git-name-rev.txt
1 git-name-rev(1)
2 ===============
3
4 NAME
5 ----
6 git-name-rev - Find symbolic names for given revs
7
8
9 SYNOPSIS
10 --------
11 'git-name-rev' [--tags] [--refs=<pattern>]
12                ( --all | --stdin | <committish>... )
13
14 DESCRIPTION
15 -----------
16 Finds symbolic names suitable for human digestion for revisions given in any
17 format parsable by git-rev-parse.
18
19
20 OPTIONS
21 -------
22
23 --tags::
24         Do not use branch names, but only tags to name the commits
25
26 --refs=<pattern>::
27         Only use refs whose names match a given shell pattern.
28
29 --all::
30         List all commits reachable from all refs
31
32 --stdin::
33         Read from stdin, append "(<rev_name>)" to all sha1's of nameable
34         commits, and pass to stdout
35
36 EXAMPLE
37 -------
38
39 Given a commit, find out where it is relative to the local refs. Say somebody
40 wrote you about that fantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a.
41 Of course, you look into the commit, but that only tells you what happened, but
42 not the context.
43
44 Enter git-name-rev:
45
46 ------------
47 % git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
48 33db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99^0~940
49 ------------
50
51 Now you are wiser, because you know that it happened 940 revisions before v0.99.
52
53 Another nice thing you can do is:
54
55 ------------
56 % git log | git name-rev --stdin
57 ------------
58
59
60 Author
61 ------
62 Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
63
64 Documentation
65 --------------
66 Documentation by Johannes Schindelin.
67
68 GIT
69 ---
70 Part of the gitlink:git[7] suite
71