OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-commit-tree.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-commit-tree(1)">\r
5 <articleinfo>\r
6     <title>git-commit-tree(1)</title>\r
7         <indexterm>\r
8                 <primary>git-commit-tree(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-commit-tree - Create a new commit object</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <simpara><emphasis>git commit-tree</emphasis> &lt;tree&gt; [-p &lt;parent commit&gt;]\* &lt; changelog</simpara>\r
18 </simplesect>\r
19 <simplesect id="_description">\r
20 <title>DESCRIPTION</title>\r
21 <simpara>This is usually not what an end user wants to run directly.  See\r
22 <xref linkend="git-commit(1)"/> instead.</simpara>\r
23 <simpara>Creates a new commit object based on the provided tree object and\r
24 emits the new commit object id on stdout.</simpara>\r
25 <simpara>A commit object may have any number of parents. With exactly one\r
26 parent, it is an ordinary commit. Having more than one parent makes\r
27 the commit a merge between several lines of history. Initial (root)\r
28 commits have no parents.</simpara>\r
29 <simpara>While a tree represents a particular directory state of a working\r
30 directory, a commit represents that state in "time", and explains how\r
31 to get there.</simpara>\r
32 <simpara>Normally a commit would identify a new "HEAD" state, and while git\r
33 doesn&#8217;t care where you save the note about that state, in practice we\r
34 tend to just write the result to the file that is pointed at by\r
35 <literal>.git/HEAD</literal>, so that we can always see what the last committed\r
36 state was.</simpara>\r
37 </simplesect>\r
38 <simplesect id="_options">\r
39 <title>OPTIONS</title>\r
40 <variablelist>\r
41 <varlistentry>\r
42 <term>\r
43 &lt;tree&gt;\r
44 </term>\r
45 <listitem>\r
46 <simpara>\r
47         An existing tree object\r
48 </simpara>\r
49 </listitem>\r
50 </varlistentry>\r
51 <varlistentry>\r
52 <term>\r
53 -p &lt;parent commit&gt;\r
54 </term>\r
55 <listitem>\r
56 <simpara>\r
57         Each <emphasis>-p</emphasis> indicates the id of a parent commit object.\r
58 </simpara>\r
59 </listitem>\r
60 </varlistentry>\r
61 </variablelist>\r
62 </simplesect>\r
63 <simplesect id="_commit_information">\r
64 <title>Commit Information</title>\r
65 <simpara>A commit encapsulates:</simpara>\r
66 <itemizedlist>\r
67 <listitem>\r
68 <simpara>\r
69 all parent object ids\r
70 </simpara>\r
71 </listitem>\r
72 <listitem>\r
73 <simpara>\r
74 author name, email and date\r
75 </simpara>\r
76 </listitem>\r
77 <listitem>\r
78 <simpara>\r
79 committer name and email and the commit time.\r
80 </simpara>\r
81 </listitem>\r
82 </itemizedlist>\r
83 <simpara>While parent object ids are provided on the command line, author and\r
84 committer information is taken from the following environment variables,\r
85 if set:</simpara>\r
86 <literallayout class="monospaced">GIT_AUTHOR_NAME\r
87 GIT_AUTHOR_EMAIL\r
88 GIT_AUTHOR_DATE\r
89 GIT_COMMITTER_NAME\r
90 GIT_COMMITTER_EMAIL\r
91 GIT_COMMITTER_DATE\r
92 EMAIL</literallayout>\r
93 <simpara>(nb "&lt;", "&gt;" and "\n"s are stripped)</simpara>\r
94 <simpara>In case (some of) these environment variables are not set, the information\r
95 is taken from the configuration items user.name and user.email, or, if not\r
96 present, system user name and fully qualified hostname.</simpara>\r
97 <simpara>A commit comment is read from stdin. If a changelog\r
98 entry is not provided via "&lt;" redirection, <emphasis>git-commit-tree</emphasis> will just wait\r
99 for one to be entered and terminated with ^D.</simpara>\r
100 </simplesect>\r
101 <simplesect id="_diagnostics">\r
102 <title>Diagnostics</title>\r
103 <variablelist>\r
104 <varlistentry>\r
105 <term>\r
106 You don&#8217;t exist. Go away!\r
107 </term>\r
108 <listitem>\r
109 <simpara>\r
110     The passwd(5) gecos field couldn&#8217;t be read\r
111 </simpara>\r
112 </listitem>\r
113 </varlistentry>\r
114 <varlistentry>\r
115 <term>\r
116 Your parents must have hated you!\r
117 </term>\r
118 <listitem>\r
119 <simpara>\r
120     The passwd(5) gecos field is longer than a giant static buffer.\r
121 </simpara>\r
122 </listitem>\r
123 </varlistentry>\r
124 <varlistentry>\r
125 <term>\r
126 Your sysadmin must hate you!\r
127 </term>\r
128 <listitem>\r
129 <simpara>\r
130     The passwd(5) name field is longer than a giant static buffer.\r
131 </simpara>\r
132 </listitem>\r
133 </varlistentry>\r
134 </variablelist>\r
135 </simplesect>\r
136 <simplesect id="_discussion">\r
137 <title>Discussion</title>\r
138 <simpara>At the core level, git is character encoding agnostic.</simpara>\r
139 <itemizedlist>\r
140 <listitem>\r
141 <simpara>\r
142 The pathnames recorded in the index and in the tree objects\r
143    are treated as uninterpreted sequences of non-NUL bytes.\r
144    What readdir(2) returns are what are recorded and compared\r
145    with the data git keeps track of, which in turn are expected\r
146    to be what lstat(2) and creat(2) accepts.  There is no such\r
147    thing as pathname encoding translation.\r
148 </simpara>\r
149 </listitem>\r
150 <listitem>\r
151 <simpara>\r
152 The contents of the blob objects are uninterpreted sequences\r
153    of bytes.  There is no encoding translation at the core\r
154    level.\r
155 </simpara>\r
156 </listitem>\r
157 <listitem>\r
158 <simpara>\r
159 The commit log messages are uninterpreted sequences of non-NUL\r
160    bytes.\r
161 </simpara>\r
162 </listitem>\r
163 </itemizedlist>\r
164 <simpara>Although we encourage that the commit log messages are encoded\r
165 in UTF-8, both the core and git Porcelain are designed not to\r
166 force UTF-8 on projects.  If all participants of a particular\r
167 project find it more convenient to use legacy encodings, git\r
168 does not forbid it.  However, there are a few things to keep in\r
169 mind.</simpara>\r
170 <orderedlist numeration="arabic">\r
171 <listitem>\r
172 <simpara>\r
173 <emphasis>git-commit</emphasis> and <emphasis>git-commit-tree</emphasis> issues\r
174   a warning if the commit log message given to it does not look\r
175   like a valid UTF-8 string, unless you explicitly say your\r
176   project uses a legacy encoding.  The way to say this is to\r
177   have i18n.commitencoding in <literal>.git/config</literal> file, like this:\r
178 </simpara>\r
179 <literallayout>[i18n]\r
180         commitencoding = ISO-8859-1</literallayout>\r
181 <simpara>Commit objects created with the above setting record the value\r
182 of <literal>i18n.commitencoding</literal> in its <literal>encoding</literal> header.  This is to\r
183 help other people who look at them later.  Lack of this header\r
184 implies that the commit log message is encoded in UTF-8.</simpara>\r
185 </listitem>\r
186 <listitem>\r
187 <simpara>\r
188 <emphasis>git-log</emphasis>, <emphasis>git-show</emphasis>, <emphasis>git-blame</emphasis> and friends look at the\r
189   <literal>encoding</literal> header of a commit object, and try to re-code the\r
190   log message into UTF-8 unless otherwise specified.  You can\r
191   specify the desired output encoding with\r
192   <literal>i18n.logoutputencoding</literal> in <literal>.git/config</literal> file, like this:\r
193 </simpara>\r
194 <literallayout>[i18n]\r
195         logoutputencoding = ISO-8859-1</literallayout>\r
196 <simpara>If you do not have this configuration variable, the value of\r
197 <literal>i18n.commitencoding</literal> is used instead.</simpara>\r
198 </listitem>\r
199 </orderedlist>\r
200 <simpara>Note that we deliberately chose not to re-code the commit log\r
201 message when a commit is made to force UTF-8 at the commit\r
202 object level, because re-coding to UTF-8 is not necessarily a\r
203 reversible operation.</simpara>\r
204 </simplesect>\r
205 <simplesect id="_see_also">\r
206 <title>SEE ALSO</title>\r
207 <simpara><xref linkend="git-write-tree(1)"/></simpara>\r
208 </simplesect>\r
209 <simplesect id="_author">\r
210 <title>Author</title>\r
211 <simpara>Written by Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt;</simpara>\r
212 </simplesect>\r
213 <simplesect id="_documentation">\r
214 <title>Documentation</title>\r
215 <simpara>Documentation by David Greaves, Junio C Hamano and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
216 </simplesect>\r
217 <simplesect id="_git">\r
218 <title>GIT</title>\r
219 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
220 </simplesect>\r
221 </article>\r