[thirdparty/git.git] / Documentation / git-commit-tree.txt

git-commit-tree(1)
==================

NAME
----
git-commit-tree - Creates a new commit object


SYNOPSIS
--------
'git-commit-tree' <tree> [-p <parent commit>]\   < changelog

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.

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.

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.

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 `.git/HEAD`, so that we can
always see what the last committed state was.

OPTIONS
-------
<tree>::
	An existing tree object

-p <parent commit>::
	Each '-p' indicates the id of a parent commit object.
	

Commit Information
------------------

A commit encapsulates:

- all parent object ids
- author name, email and date
- 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.

	GIT_AUTHOR_NAME
	GIT_AUTHOR_EMAIL
	GIT_AUTHOR_DATE
	GIT_COMMITTER_NAME
	GIT_COMMITTER_EMAIL

(nb "<", ">" and "\n"s are stripped)

In `.git/config` file, the following items are used:

	[user]
		name = "Your Name"
		email = "your@email.address.xz"

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.


Diagnostics
-----------
You don't exist. Go away!::
    The passwd(5) gecos field couldn't be read
Your parents must have hated you!::
    The password(5) gecos field is longer than a giant static buffer.
Your sysadmin must hate you!::
    The password(5) name field is longer than a giant static buffer.

See Also
--------
gitlink:git-write-tree[1]


Author
------
Written by Linus Torvalds <torvalds@osdl.org>

Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.

GIT
---
Part of the gitlink:git[7] suite
Commit	Line	Data
	1	git-commit-tree(1)
	2	==================
	3
	4	NAME
	5	----
	6	git-commit-tree - Creates a new commit object
	7
	8
	9	SYNOPSIS
	10	--------
	11	'git-commit-tree' <tree> [-p <parent commit>]\ < changelog
	12
	13	DESCRIPTION
	14	-----------
	15	Creates a new commit object based on the provided tree object and
	16	emits the new commit object id on stdout. If no parent is given then
	17	it is considered to be an initial tree.
	18
	19	A commit object usually has 1 parent (a commit after a change) or up
	20	to 16 parents. More than one parent represents a merge of branches
	21	that led to them.
	22
	23	While a tree represents a particular directory state of a working
	24	directory, a commit represents that state in "time", and explains how
	25	to get there.
	26
	27	Normally a commit would identify a new "HEAD" state, and while git
	28	doesn't care where you save the note about that state, in practice we
	29	tend to just write the result to the file `.git/HEAD`, so that we can
	30	always see what the last committed state was.
	31
	32	OPTIONS
	33	-------
	34	<tree>::
	35	An existing tree object
	36
	37	-p <parent commit>::
	38	Each '-p' indicates the id of a parent commit object.
	39
	40
	41	Commit Information
	42	------------------
	43
	44	A commit encapsulates:
	45
	46	- all parent object ids
	47	- author name, email and date
	48	- committer name and email and the commit time.
	49
	50	If not provided, "git-commit-tree" uses your name, hostname and domain to
	51	provide author and committer info. This can be overridden by
	52	either `.git/config` file, or using the following environment variables.
	53
	54	GIT_AUTHOR_NAME
	55	GIT_AUTHOR_EMAIL
	56	GIT_AUTHOR_DATE
	57	GIT_COMMITTER_NAME
	58	GIT_COMMITTER_EMAIL
	59
	60	(nb "<", ">" and "\n"s are stripped)
	61
	62	In `.git/config` file, the following items are used:
	63
	64	[user]
	65	name = "Your Name"
	66	email = "your@email.address.xz"
	67
	68	A commit comment is read from stdin (max 999 chars). If a changelog
	69	entry is not provided via "<" redirection, "git-commit-tree" will just wait
	70	for one to be entered and terminated with ^D.
	71
	72
	73	Diagnostics
	74	-----------
	75	You don't exist. Go away!::
	76	The passwd(5) gecos field couldn't be read
	77	Your parents must have hated you!::
	78	The password(5) gecos field is longer than a giant static buffer.
	79	Your sysadmin must hate you!::
	80	The password(5) name field is longer than a giant static buffer.
	81
	82	See Also
	83	--------
	84	gitlink:git-write-tree[1]
	85
	86
	87	Author
	88	------
	89	Written by Linus Torvalds <torvalds@osdl.org>
	90
	91	Documentation
	92	--------------
	93	Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
	94
	95	GIT
	96	---
	97	Part of the gitlink:git[7] suite
	98