]> git.ipfire.org Git - thirdparty/git.git/blame_incremental - Documentation/git-commit-tree.txt
Sync with 'maint'
[thirdparty/git.git] / Documentation / git-commit-tree.txt
... / ...
CommitLineData
1git-commit-tree(1)
2==================
3
4NAME
5----
6git-commit-tree - Create a new commit object
7
8
9SYNOPSIS
10--------
11[verse]
12'git commit-tree' <tree> [(-p <parent>)...]
13'git commit-tree' [(-p <parent>)...] [-S[<keyid>]] [(-m <message>)...]
14 [(-F <file>)...] <tree>
15
16
17DESCRIPTION
18-----------
19This is usually not what an end user wants to run directly. See
20linkgit:git-commit[1] instead.
21
22Creates a new commit object based on the provided tree object and
23emits the new commit object id on stdout. The log message is read
24from the standard input, unless `-m` or `-F` options are given.
25
26The `-m` and `-F` options can be given any number of times, in any
27order. The commit log message will be composed in the order in which
28the options are given.
29
30A commit object may have any number of parents. With exactly one
31parent, it is an ordinary commit. Having more than one parent makes
32the commit a merge between several lines of history. Initial (root)
33commits have no parents.
34
35While a tree represents a particular directory state of a working
36directory, a commit represents that state in "time", and explains how
37to get there.
38
39Normally a commit would identify a new "HEAD" state, and while Git
40doesn't care where you save the note about that state, in practice we
41tend to just write the result to the file that is pointed at by
42`.git/HEAD`, so that we can always see what the last committed
43state was.
44
45OPTIONS
46-------
47<tree>::
48 An existing tree object.
49
50-p <parent>::
51 Each `-p` indicates the id of a parent commit object.
52
53-m <message>::
54 A paragraph in the commit log message. This can be given more than
55 once and each <message> becomes its own paragraph.
56
57-F <file>::
58 Read the commit log message from the given file. Use `-` to read
59 from the standard input. This can be given more than once and the
60 content of each file becomes its own paragraph.
61
62-S[<keyid>]::
63--gpg-sign[=<keyid>]::
64--no-gpg-sign::
65 GPG-sign commits. The `keyid` argument is optional and
66 defaults to the committer identity; if specified, it must be
67 stuck to the option without a space. `--no-gpg-sign` is useful to
68 countermand a `--gpg-sign` option given earlier on the command line.
69
70Commit Information
71------------------
72
73A commit encapsulates:
74
75- all parent object ids
76- author name, email and date
77- committer name and email and the commit time.
78
79A commit comment is read from stdin. If a changelog
80entry is not provided via "<" redirection, 'git commit-tree' will just wait
81for one to be entered and terminated with ^D.
82
83include::date-formats.txt[]
84
85Discussion
86----------
87
88include::i18n.txt[]
89
90FILES
91-----
92/etc/mailname
93
94SEE ALSO
95--------
96linkgit:git-write-tree[1]
97linkgit:git-commit[1]
98
99GIT
100---
101Part of the linkgit:git[1] suite