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