git-commit-tree.1   [plain text]


'\" t
.\"     Title: git-commit-tree
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 06/01/2011
.\"    Manual: Git Manual
.\"    Source: Git 1.7.5.4
.\"  Language: English
.\"
.TH "GIT\-COMMIT\-TREE" "1" "06/01/2011" "Git 1\&.7\&.5\&.4" "Git Manual"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-commit-tree \- Create a new commit object
.SH "SYNOPSIS"
.sp
\fIgit commit\-tree\fR <tree> [(\-p <parent commit>)\&...] < changelog
.SH "DESCRIPTION"
.sp
This is usually not what an end user wants to run directly\&. See \fBgit-commit\fR(1) instead\&.
.sp
Creates a new commit object based on the provided tree object and emits the new commit object id on stdout\&.
.sp
A commit object may have any number of parents\&. With exactly one parent, it is an ordinary commit\&. Having more than one parent makes the commit a merge between several lines of history\&. Initial (root) commits have no parents\&.
.sp
While a tree represents a particular directory state of a working directory, a commit represents that state in "time", and explains how to get there\&.
.sp
Normally a commit would identify a new "HEAD" state, and while git doesn\(cqt care where you save the note about that state, in practice we tend to just write the result to the file that is pointed at by \&.git/HEAD, so that we can always see what the last committed state was\&.
.SH "OPTIONS"
.PP
<tree>
.RS 4
An existing tree object
.RE
.PP
\-p <parent commit>
.RS 4
Each
\fI\-p\fR
indicates the id of a parent commit object\&.
.RE
.SH "COMMIT INFORMATION"
.sp
A commit encapsulates:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
all parent object ids
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
author name, email and date
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
committer name and email and the commit time\&.
.RE
.sp
While parent object ids are provided on the command line, author and committer information is taken from the following environment variables, if set:
.sp
.if n \{\
.RS 4
.\}
.nf
GIT_AUTHOR_NAME
GIT_AUTHOR_EMAIL
GIT_AUTHOR_DATE
GIT_COMMITTER_NAME
GIT_COMMITTER_EMAIL
GIT_COMMITTER_DATE
EMAIL
.fi
.if n \{\
.RE
.\}
.sp
(nb "<", ">" and "\en"s are stripped)
.sp
In case (some of) these environment variables are not set, the information is taken from the configuration items user\&.name and user\&.email, or, if not present, system user name and fully qualified hostname\&.
.sp
A commit comment is read from stdin\&. If a changelog entry is not provided via "<" redirection, \fIgit commit\-tree\fR will just wait for one to be entered and terminated with ^D\&.
.SH "DATE FORMATS"
.sp
The GIT_AUTHOR_DATE, GIT_COMMITTER_DATE environment variables support the following date formats:
.PP
Git internal format
.RS 4
It is
<unix timestamp> <timezone offset>, where
<unix timestamp>
is the number of seconds since the UNIX epoch\&.
<timezone offset>
is a positive or negative offset from UTC\&. For example CET (which is 2 hours ahead UTC) is
+0200\&.
.RE
.PP
RFC 2822
.RS 4
The standard email format as described by RFC 2822, for example
Thu, 07 Apr 2005 22:13:13 +0200\&.
.RE
.PP
ISO 8601
.RS 4
Time and date specified by the ISO 8601 standard, for example
2005\-04\-07T22:13:13\&. The parser accepts a space instead of the
T
character as well\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
In addition, the date part is accepted in the following formats:
YYYY\&.MM\&.DD,
MM/DD/YYYY
and
DD\&.MM\&.YYYY\&.
.sp .5v
.RE
.RE
.SH "DIAGNOSTICS"
.PP
You don\(cqt exist\&. Go away!
.RS 4
The passwd(5) gecos field couldn\(cqt be read
.RE
.PP
Your parents must have hated you!
.RS 4
The passwd(5) gecos field is longer than a giant static buffer\&.
.RE
.PP
Your sysadmin must hate you!
.RS 4
The passwd(5) name field is longer than a giant static buffer\&.
.RE
.SH "DISCUSSION"
.sp
At the core level, git is character encoding agnostic\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The pathnames recorded in the index and in the tree objects are treated as uninterpreted sequences of non\-NUL bytes\&. What readdir(2) returns are what are recorded and compared with the data git keeps track of, which in turn are expected to be what lstat(2) and creat(2) accepts\&. There is no such thing as pathname encoding translation\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The contents of the blob objects are uninterpreted sequences of bytes\&. There is no encoding translation at the core level\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The commit log messages are uninterpreted sequences of non\-NUL bytes\&.
.RE
.sp
Although we encourage that the commit log messages are encoded in UTF\-8, both the core and git Porcelain are designed not to force UTF\-8 on projects\&. If all participants of a particular project find it more convenient to use legacy encodings, git does not forbid it\&. However, there are a few things to keep in mind\&.
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}

\fIgit commit\fR
and
\fIgit commit\-tree\fR
issues a warning if the commit log message given to it does not look like a valid UTF\-8 string, unless you explicitly say your project uses a legacy encoding\&. The way to say this is to have i18n\&.commitencoding in
\&.git/config
file, like this:
.sp
.if n \{\
.RS 4
.\}
.nf
[i18n]
        commitencoding = ISO\-8859\-1
.fi
.if n \{\
.RE
.\}
.sp
Commit objects created with the above setting record the value of
i18n\&.commitencoding
in its
encoding
header\&. This is to help other people who look at them later\&. Lack of this header implies that the commit log message is encoded in UTF\-8\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}

\fIgit log\fR,
\fIgit show\fR,
\fIgit blame\fR
and friends look at the
encoding
header of a commit object, and try to re\-code the log message into UTF\-8 unless otherwise specified\&. You can specify the desired output encoding with
i18n\&.logoutputencoding
in
\&.git/config
file, like this:
.sp
.if n \{\
.RS 4
.\}
.nf
[i18n]
        logoutputencoding = ISO\-8859\-1
.fi
.if n \{\
.RE
.\}
.sp
If you do not have this configuration variable, the value of
i18n\&.commitencoding
is used instead\&.
.RE
.sp
Note that we deliberately chose not to re\-code the commit log message when a commit is made to force UTF\-8 at the commit object level, because re\-coding to UTF\-8 is not necessarily a reversible operation\&.
.SH "SEE ALSO"
.sp
\fBgit-write-tree\fR(1)
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite