.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-COMMIT\-TREE" "1" "10/03/2006" "" ""
+.TH "GIT\-COMMIT\-TREE" "1" "12/31/2006" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
git\-commit\-tree \- Creates a new commit object
.SH "SYNOPSIS"
\fIgit\-commit\-tree\fR <tree> [\-p <parent commit>]* < changelog
-.sp
.SH "DESCRIPTION"
Creates a new commit object based on the provided tree object and emits the new commit object id on stdout. If no parent is given then it is considered to be an initial tree.
-.sp
+
A commit object usually has 1 parent (a commit after a change) or up to 16 parents. More than one parent represents a merge of branches that led to them.
-.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't 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.
-.sp
.SH "OPTIONS"
.TP
<tree>
An existing tree object
.TP
\-p <parent commit>
-Each
-\fI\-p\fR
-indicates the id of a parent commit object.
+Each \fI\-p\fR indicates the id of a parent commit object.
.SH "COMMIT INFORMATION"
A commit encapsulates:
-.sp
.TP 3
\(bu
all parent object ids
.TP
\(bu
committer name and email and the commit time.
+
If not provided, "git\-commit\-tree" uses your name, hostname and domain to provide author and committer info. This can be overridden by either .git/config file, or using the following environment variables.
.sp
-.sp
.nf
GIT_AUTHOR_NAME
GIT_AUTHOR_EMAIL
GIT_COMMITTER_EMAIL
.fi
(nb "<", ">" and "\\n"s are stripped)
-.sp
+
In .git/config file, the following items are used for GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL:
.sp
-.sp
.nf
[user]
name = "Your Name"
email = "your@email.address.xz"
.fi
A commit comment is read from stdin (max 999 chars). If a changelog entry is not provided via "<" redirection, "git\-commit\-tree" will just wait for one to be entered and terminated with ^D.
-.sp
.SH "DIAGNOSTICS"
.TP
You don't exist. Go away!
.TP
Your sysadmin must hate you!
The password(5) name field is longer than a giant static buffer.
+.SH "DISCUSSION"
+At the core level, git is character encoding agnostic.
+.TP 3
+\(bu
+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.
+.TP
+\(bu
+The contents of the blob objects are uninterpreted sequence of bytes. There is no encoding translation at the core level.
+.TP
+\(bu
+The commit log messages are uninterpreted sequence of non\-NUL bytes.
+
+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.
+.TP 3
+1.
+git\-commit\-tree (hence, git\-commit which uses it) issues an 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 core.commitencoding in .git/config file, like this:
+.sp
+.nf
+[core]
+ commitencoding = ISO\-8859\-1
+.fi
+Commit objects created with the above setting record the value of core.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.
+.TP
+2.
+git\-log, git\-show and friends looks at the encoding header of a commit object, and tries to re\-code the log message into UTF\-8 unless otherwise specified. You can specify the desired output encoding with core.logoutputencoding in .git/config file, like this:
+.sp
+.nf
+[core]
+ logoutputencoding = ISO\-8859\-1
+.fi
+If you do not have this configuration variable, the value of core.commitencoding is used instead.
+
+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"
\fBgit\-write\-tree\fR(1)
-.sp
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-COMMIT" "1" "12/16/2006" "" ""
+.TH "GIT\-COMMIT" "1" "12/31/2006" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
$ git commit
.fi
As with the case to record your own changes, you can use \-a option to save typing. One difference is that during a merge resolution, you cannot use git commit with pathnames to alter the order the changes are committed, because the merge should be recorded as a single commit. In fact, the command refuses to run when given pathnames (but see \-i option).
+.SH "DISCUSSION"
+At the core level, git is character encoding agnostic.
+.TP 3
+\(bu
+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.
+.TP
+\(bu
+The contents of the blob objects are uninterpreted sequence of bytes. There is no encoding translation at the core level.
+.TP
+\(bu
+The commit log messages are uninterpreted sequence of non\-NUL bytes.
+
+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.
+.TP 3
+1.
+git\-commit\-tree (hence, git\-commit which uses it) issues an 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 core.commitencoding in .git/config file, like this:
+.sp
+.nf
+[core]
+ commitencoding = ISO\-8859\-1
+.fi
+Commit objects created with the above setting record the value of core.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.
+.TP
+2.
+git\-log, git\-show and friends looks at the encoding header of a commit object, and tries to re\-code the log message into UTF\-8 unless otherwise specified. You can specify the desired output encoding with core.logoutputencoding in .git/config file, like this:
+.sp
+.nf
+[core]
+ logoutputencoding = ISO\-8859\-1
+.fi
+If you do not have this configuration variable, the value of core.commitencoding is used instead.
+
+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 "ENVIRONMENT VARIABLES"
The command specified by either the VISUAL or EDITOR environment variables is used to edit the commit log message.
.SH "HOOKS"
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-DIFF\-TREE" "1" "12/26/2006" "" ""
+.TH "GIT\-DIFF\-TREE" "1" "12/31/2006" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
The \fIraw\fR format shows the entire commit exactly as stored in the commit object. Notably, the SHA1s are displayed in full, regardless of whether \-\-abbrev or \-\-no\-abbrev are used, and \fIparents\fR information show the true parent commits, without taking grafts nor history simplification into account.
.RE
.TP
+\-\-encoding[=<encoding>]
+The commit objects record the encoding used for the log message in their encoding header; this option can be used to tell the command to re\-code the commit log message in the encoding preferred by the user. For non plumbing commands this defaults to UTF\-8.
+.TP
\-\-no\-commit\-id
git\-diff\-tree outputs a line with the commit ID when applicable. This flag suppressed the commit ID output.
.TP
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-LOG" "1" "11/23/2006" "" ""
+.TH "GIT\-LOG" "1" "12/31/2006" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
git\-log \- Show commit logs
.SH "SYNOPSIS"
\fIgit\-log\fR <option>\&...
-.sp
.SH "DESCRIPTION"
Shows the commit logs.
-.sp
+
The command takes options applicable to the \fBgit\-rev\-list\fR(1) command to control what is shown and how, and options applicable to the \fBgit\-diff\-tree\fR(1) commands to control how the change each commit introduces are shown.
-.sp
+
This manual page describes only the most frequently used options.
-.sp
.SH "OPTIONS"
.TP
\-\-pretty[=\fI<format>\fR]
-Pretty\-prints the details of a commit.
-\-\-pretty
-without an explicit
-=<format>
-defaults to
-\fImedium\fR. If the commit is a merge, and if the pretty\-format is not
-\fIoneline\fR,
-\fIemail\fR
-or
-\fIraw\fR, an additional line is inserted before the
-\fIAuthor:\fR
-line. This line begins with "Merge: " and the sha1s of ancestral commits are printed, separated by spaces. Note that the listed commits may not necessarily be the list of the
-\fBdirect\fR
-parent commits if you have limited your view of history: for example, if you are only interested in changes related to a certain directory or file. Here are some additional details for each format:
+Pretty\-prints the details of a commit. \-\-pretty without an explicit =<format> defaults to \fImedium\fR. If the commit is a merge, and if the pretty\-format is not \fIoneline\fR, \fIemail\fR or \fIraw\fR, an additional line is inserted before the \fIAuthor:\fR line. This line begins with "Merge: " and the sha1s of ancestral commits are printed, separated by spaces. Note that the listed commits may not necessarily be the list of the \fBdirect\fR parent commits if you have limited your view of history: for example, if you are only interested in changes related to a certain directory or file. Here are some additional details for each format:
.RS
.TP 3
\(bu
.TP
\(bu
\fIraw\fR
-.sp
-The
-\fIraw\fR
-format shows the entire commit exactly as stored in the commit object. Notably, the SHA1s are displayed in full, regardless of whether \-\-abbrev or \-\-no\-abbrev are used, and
-\fIparents\fR
-information show the true parent commits, without taking grafts nor history simplification into account.
+
+The \fIraw\fR format shows the entire commit exactly as stored in the commit object. Notably, the SHA1s are displayed in full, regardless of whether \-\-abbrev or \-\-no\-abbrev are used, and \fIparents\fR information show the true parent commits, without taking grafts nor history simplification into account.
.RE
.TP
+\-\-encoding[=<encoding>]
+The commit objects record the encoding used for the log message in their encoding header; this option can be used to tell the command to re\-code the commit log message in the encoding preferred by the user. For non plumbing commands this defaults to UTF\-8.
+.TP
\-\-max\-count=<n>
Limits the number of commits to show.
.TP
<since>..<until>
-Show only commits between the named two commits.
+Show only commits between the named two commits. When either <since> or <until> is omitted, it defaults to HEAD, i.e. the tip of the current branch.
.TP
\-p
Show the change the commit introduces in a patch form.
Show the whole commit history, but skip any merges
.TP
git log v2.6.12.. include/scsi drivers/scsi
-Show all commits since version
-\fIv2.6.12\fR
-that changed any file in the include/scsi or drivers/scsi subdirectories
+Show all commits since version \fIv2.6.12\fR that changed any file in the include/scsi or drivers/scsi subdirectories
.TP
git log \-\-since="2 weeks ago" \-\- gitk
-Show the changes during the last two weeks to the file
-\fIgitk\fR. The "\-\-" is necessary to avoid confusion with the
-\fBbranch\fR
-named
-\fIgitk\fR
+Show the changes during the last two weeks to the file \fIgitk\fR. The "\-\-" is necessary to avoid confusion with the \fBbranch\fR named \fIgitk\fR
.TP
git log \-r \-\-name\-status release..test
Show the commits that are in the "test" branch but not yet in the "release" branch, along with the list of paths each commit modifies.
+.SH "DISCUSSION"
+At the core level, git is character encoding agnostic.
+.TP 3
+\(bu
+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.
+.TP
+\(bu
+The contents of the blob objects are uninterpreted sequence of bytes. There is no encoding translation at the core level.
+.TP
+\(bu
+The commit log messages are uninterpreted sequence of non\-NUL bytes.
+
+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.
+.TP 3
+1.
+git\-commit\-tree (hence, git\-commit which uses it) issues an 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 core.commitencoding in .git/config file, like this:
+.sp
+.nf
+[core]
+ commitencoding = ISO\-8859\-1
+.fi
+Commit objects created with the above setting record the value of core.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.
+.TP
+2.
+git\-log, git\-show and friends looks at the encoding header of a commit object, and tries to re\-code the log message into UTF\-8 unless otherwise specified. You can specify the desired output encoding with core.logoutputencoding in .git/config file, like this:
+.sp
+.nf
+[core]
+ logoutputencoding = ISO\-8859\-1
+.fi
+If you do not have this configuration variable, the value of core.commitencoding is used instead.
+
+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 "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-REV\-LIST" "1" "12/25/2006" "" ""
+.TH "GIT\-REV\-LIST" "1" "12/31/2006" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
[ \-\-stdin ]
[ \-\-topo\-order ]
[ \-\-parents ]
+ [ \-\-encoding[=<encoding>] ]
[ \-\-(author|committer|grep)=<pattern> ]
[ [\-\-objects | \-\-objects\-edge] [ \-\-unpacked ] ]
[ \-\-pretty | \-\-header ]
The \fIraw\fR format shows the entire commit exactly as stored in the commit object. Notably, the SHA1s are displayed in full, regardless of whether \-\-abbrev or \-\-no\-abbrev are used, and \fIparents\fR information show the true parent commits, without taking grafts nor history simplification into account.
.RE
.TP
+\-\-encoding[=<encoding>]
+The commit objects record the encoding used for the log message in their encoding header; this option can be used to tell the command to re\-code the commit log message in the encoding preferred by the user. For non plumbing commands this defaults to UTF\-8.
+.TP
\-\-relative\-date
Show dates relative to the current time, e.g. "2 hours ago". Only takes effect for dates shown in human\-readable format, such as when using "\-\-pretty".
.TP
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-SHOW" "1" "12/16/2006" "" ""
+.TH "GIT\-SHOW" "1" "12/31/2006" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
This manual page describes only the most frequently used options.
.SH "OPTIONS"
.TP
-<commitid>
-ID of the commit to show.
+<object>
+The name of the object to show.
.TP
\-\-pretty[=\fI<format>\fR]
Pretty\-prints the details of a commit. \-\-pretty without an explicit =<format> defaults to \fImedium\fR. If the commit is a merge, and if the pretty\-format is not \fIoneline\fR, \fIemail\fR or \fIraw\fR, an additional line is inserted before the \fIAuthor:\fR line. This line begins with "Merge: " and the sha1s of ancestral commits are printed, separated by spaces. Note that the listed commits may not necessarily be the list of the \fBdirect\fR parent commits if you have limited your view of history: for example, if you are only interested in changes related to a certain directory or file. Here are some additional details for each format:
The \fIraw\fR format shows the entire commit exactly as stored in the commit object. Notably, the SHA1s are displayed in full, regardless of whether \-\-abbrev or \-\-no\-abbrev are used, and \fIparents\fR information show the true parent commits, without taking grafts nor history simplification into account.
.RE
+.TP
+\-\-encoding[=<encoding>]
+The commit objects record the encoding used for the log message in their encoding header; this option can be used to tell the command to re\-code the commit log message in the encoding preferred by the user. For non plumbing commands this defaults to UTF\-8.
.SH "EXAMPLES"
.TP
git show v1.0.0
-Shows the tag v1.0.0.
+Shows the tag v1.0.0, along with the object the tags points at.
.TP
Shows the tree pointed to by the tag v1.0.0.
git show next~10:Documentation/README Shows the contents of the file Documentation/README as they were current in the 10th last commit of the branch next.
git show master:Makefile master:t/Makefile Concatenates the contents of said Makefiles in the head of the branch master.
+.SH "DISCUSSION"
+At the core level, git is character encoding agnostic.
+.TP 3
+\(bu
+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.
+.TP
+\(bu
+The contents of the blob objects are uninterpreted sequence of bytes. There is no encoding translation at the core level.
+.TP
+\(bu
+The commit log messages are uninterpreted sequence of non\-NUL bytes.
+
+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.
+.TP 3
+1.
+git\-commit\-tree (hence, git\-commit which uses it) issues an 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 core.commitencoding in .git/config file, like this:
+.sp
+.nf
+[core]
+ commitencoding = ISO\-8859\-1
+.fi
+Commit objects created with the above setting record the value of core.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.
+.TP
+2.
+git\-log, git\-show and friends looks at the encoding header of a commit object, and tries to re\-code the log message into UTF\-8 unless otherwise specified. You can specify the desired output encoding with core.logoutputencoding in .git/config file, like this:
+.sp
+.nf
+[core]
+ logoutputencoding = ISO\-8859\-1
+.fi
+If you do not have this configuration variable, the value of core.commitencoding is used instead.
+
+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 "AUTHOR"
-Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <junkio@cox.net>
+Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <junkio@cox.net>. Significantly enhanced by Johannes Schindelin <Johannes.Schindelin@gmx.de>.
.SH "DOCUMENTATION"
Documentation by David Greaves, Petr Baudis and the git\-list <git@vger.kernel.org>.
projects / git.git / commitdiff