summaryrefslogtreecommitdiff
path: root/Documentation/git-name-rev.txt
blob: fa2c5fdd4bd61856ec5fb7ae0414b6dad26f79d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
git-name-rev(1)
===============
 
NAME
----
git-name-rev - Find symbolic names for given revs
 
 
SYNOPSIS
--------
[verse]
'git-name-rev' [--tags] [--refs=<pattern>]
	       ( --all | --stdin | <committish>... )
 
DESCRIPTION
-----------
Finds symbolic names suitable for human digestion for revisions given in any
format parsable by git-rev-parse.
 
 
OPTIONS
-------
 
--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::
	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 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
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.
 
Enter git-name-rev:
 
------------
% 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.
 
Another nice thing you can do is:
 
------------
% git log | git name-rev --stdin
------------
 
 
Author
------
Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
 
Documentation
--------------
Documentation by Johannes Schindelin.
 
GIT
---
Part of the gitlink:git[7] suite