OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-name-rev.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-name-rev(1)">\r
5 <articleinfo>\r
6     <title>git-name-rev(1)</title>\r
7         <indexterm>\r
8                 <primary>git-name-rev(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-name-rev - Find symbolic names for given revs</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>git name-rev</emphasis> [--tags] [--refs=&lt;pattern&gt;]\r
19                ( --all | --stdin | &lt;committish&gt;&#8230; )</literallayout>\r
20 </blockquote>\r
21 </simplesect>\r
22 <simplesect id="_description">\r
23 <title>DESCRIPTION</title>\r
24 <simpara>Finds symbolic names suitable for human digestion for revisions given in any\r
25 format parsable by <emphasis>git-rev-parse</emphasis>.</simpara>\r
26 </simplesect>\r
27 <simplesect id="_options">\r
28 <title>OPTIONS</title>\r
29 <variablelist>\r
30 <varlistentry>\r
31 <term>\r
32 --tags\r
33 </term>\r
34 <listitem>\r
35 <simpara>\r
36         Do not use branch names, but only tags to name the commits\r
37 </simpara>\r
38 </listitem>\r
39 </varlistentry>\r
40 <varlistentry>\r
41 <term>\r
42 --refs=&lt;pattern&gt;\r
43 </term>\r
44 <listitem>\r
45 <simpara>\r
46         Only use refs whose names match a given shell pattern.\r
47 </simpara>\r
48 </listitem>\r
49 </varlistentry>\r
50 <varlistentry>\r
51 <term>\r
52 --all\r
53 </term>\r
54 <listitem>\r
55 <simpara>\r
56         List all commits reachable from all refs\r
57 </simpara>\r
58 </listitem>\r
59 </varlistentry>\r
60 <varlistentry>\r
61 <term>\r
62 --stdin\r
63 </term>\r
64 <listitem>\r
65 <simpara>\r
66         Read from stdin, append "(&lt;rev_name&gt;)" to all sha1&#8217;s of nameable\r
67         commits, and pass to stdout\r
68 </simpara>\r
69 </listitem>\r
70 </varlistentry>\r
71 <varlistentry>\r
72 <term>\r
73 --name-only\r
74 </term>\r
75 <listitem>\r
76 <simpara>\r
77         Instead of printing both the SHA-1 and the name, print only\r
78         the name.  If given with --tags the usual tag prefix of\r
79         "tags/" is also omitted from the name, matching the output\r
80         of <literal>git-describe</literal> more closely.\r
81 </simpara>\r
82 </listitem>\r
83 </varlistentry>\r
84 <varlistentry>\r
85 <term>\r
86 --no-undefined\r
87 </term>\r
88 <listitem>\r
89 <simpara>\r
90         Die with error code != 0 when a reference is undefined,\r
91         instead of printing <literal>undefined</literal>.\r
92 </simpara>\r
93 </listitem>\r
94 </varlistentry>\r
95 <varlistentry>\r
96 <term>\r
97 --always\r
98 </term>\r
99 <listitem>\r
100 <simpara>\r
101         Show uniquely abbreviated commit object as fallback.\r
102 </simpara>\r
103 </listitem>\r
104 </varlistentry>\r
105 </variablelist>\r
106 </simplesect>\r
107 <simplesect id="_example">\r
108 <title>EXAMPLE</title>\r
109 <simpara>Given a commit, find out where it is relative to the local refs. Say somebody\r
110 wrote you about that fantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a.\r
111 Of course, you look into the commit, but that only tells you what happened, but\r
112 not the context.</simpara>\r
113 <simpara>Enter <emphasis>git-name-rev</emphasis>:</simpara>\r
114 <literallayout>% git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a\r
115 33db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99~940</literallayout>\r
116 <simpara>Now you are wiser, because you know that it happened 940 revisions before v0.99.</simpara>\r
117 <simpara>Another nice thing you can do is:</simpara>\r
118 <literallayout>% git log | git name-rev --stdin</literallayout>\r
119 </simplesect>\r
120 <simplesect id="_author">\r
121 <title>Author</title>\r
122 <simpara>Written by Johannes Schindelin &lt;<ulink url="mailto:Johannes.Schindelin@gmx.de">Johannes.Schindelin@gmx.de</ulink>&gt;</simpara>\r
123 </simplesect>\r
124 <simplesect id="_documentation">\r
125 <title>Documentation</title>\r
126 <simpara>Documentation by Johannes Schindelin.</simpara>\r
127 </simplesect>\r
128 <simplesect id="_git">\r
129 <title>GIT</title>\r
130 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
131 </simplesect>\r
132 </article>\r