Autogenerated man pages for v1.3.0-rc2-g454a
[git.git] / man1 / git-name-rev.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-NAME-REV" 1 "" "" ""
21 .SH NAME
22 git-name-rev \- Find symbolic names for given revs
23 .SH "SYNOPSIS"
24
25
26 \fIgit\-name\-rev\fR [\-\-tags] ( \-\-all | \-\-stdin | <commitish>... )
27
28 .SH "DESCRIPTION"
29
30
31 Finds symbolic names suitable for human digestion for revisions given in any format parsable by git\-rev\-parse\&.
32
33 .SH "OPTIONS"
34
35 .TP
36 \-\-tags
37 Do not use branch names, but only tags to name the commits
38
39 .TP
40 \-\-all
41 List all commits reachable from all refs
42
43 .TP
44 \-\-stdin
45 Read from stdin, append "(<rev_name>)" to all sha1's of name'able commits, and pass to stdout
46
47 .SH "EXAMPLE"
48
49
50 Given a commit, find out where it is relative to the local refs\&. Say somebody wrote you about that phantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a\&. Of course, you look into the commit, but that only tells you what happened, but not the context\&.
51
52
53 Enter git\-name\-rev:
54
55 .nf
56 % git name\-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
57 .fi
58
59
60 Now you are wiser, because you know that it happened 940 revisions before v0\&.99\&.
61
62
63 Another nice thing you can do is:
64
65 .nf
66 % git log | git name\-rev \-\-stdin
67 .fi
68
69 .SH "AUTHOR"
70
71
72 Written by Johannes Schindelin <Johannes\&.Schindelin@gmx\&.de>
73
74 .SH "DOCUMENTATION"
75
76
77 Documentation by Johannes Schindelin\&.
78
79 .SH "GIT"
80
81
82 Part of the \fBgit\fR(7) suite
83