Autogenerated man pages for v1.2.4-g5a1f
[git.git] / man1 / git-commit.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-COMMIT" 1 "" "" ""
21 .SH NAME
22 git-commit \- Record your changes
23 .SH "SYNOPSIS"
24
25 .nf
26 \fIgit\-commit\fR [\-a] [\-s] [\-v] [(\-c | \-C) <commit> | \-F <file> | \-m <msg>]
27            [\-e] [\-\-author <author>] [\-\-] [[\-i | \-o ]<file>...]
28 .fi
29
30 .SH "DESCRIPTION"
31
32
33 Updates the index file for given paths, or all modified files if \fI\-a\fR is specified, and makes a commit object\&. The command VISUAL and EDITOR environment variables to edit the commit log message\&.
34
35
36 Several environment variable are used during commits\&. They are documented in \fBgit\-commit\-tree\fR(1)\&.
37
38
39 This command can run commit\-msg, pre\-commit, and post\-commit hooks\&. See hooks: \fIhooks.html\fR for more information\&.
40
41 .SH "OPTIONS"
42
43 .TP
44 \-a|\-\-all
45 Update all paths in the index file\&. This flag notices files that have been modified and deleted, but new files you have not told git about are not affected\&.
46
47 .TP
48 \-c or \-C <commit>
49 Take existing commit object, and reuse the log message and the authorship information (including the timestamp) when creating the commit\&. With \fI\-C\fR, the editor is not invoked; with \fI\-c\fR the user can further edit the commit message\&.
50
51 .TP
52 \-F <file>
53 Take the commit message from the given file\&. Use \fI\-\fR to read the message from the standard input\&.
54
55 .TP
56 \-\-author <author>
57 Override the author name used in the commit\&. Use A U Thor <author@example\&.com> format\&.
58
59 .TP
60 \-m <msg>
61 Use the given <msg> as the commit message\&.
62
63 .TP
64 \-s|\-\-signoff
65 Add Signed\-off\-by line at the end of the commit message\&.
66
67 .TP
68 \-v|\-\-verify
69 Look for suspicious lines the commit introduces, and abort committing if there is one\&. The definition of \fIsuspicious lines\fR is currently the lines that has trailing whitespaces, and the lines whose indentation has a SP character immediately followed by a TAB character\&. This is the default\&.
70
71 .TP
72 \-n|\-\-no\-verify
73 The opposite of \-\-verify\&.
74
75 .TP
76 \-e|\-\-edit
77 The message taken from file with \-F, command line with \-m, and from file with \-C are usually used as the commit log message unmodified\&. This option lets you further edit the message taken from these sources\&.
78
79 .TP
80 \-i|\-\-include
81 Instead of committing only the files specified on the command line, update them in the index file and then commit the whole index\&. This is the traditional behaviour\&.
82
83 .TP
84 \-o|\-\-only
85 Commit only the files specified on the command line\&. This format cannot be used during a merge, nor when the index and the latest commit does not match on the specified paths to avoid confusion\&.
86
87 .TP
88 --
89 Do not interpret any more arguments as options\&.
90
91 .TP
92 <file>...
93 Files to be committed\&. The meaning of these is different between \-\-include and \-\-only\&. Without either, it defaults \-\-only semantics\&.
94
95
96 If you make a commit and then found a mistake immediately after that, you can recover from it with \fBgit\-reset\fR(1)\&.
97
98 .SH "DISCUSSION"
99
100
101 git commit without _any_ parameter commits the tree structure recorded by the current index file\&. This is a whole\-tree commit even the command is invoked from a subdirectory\&.
102
103
104 git commit \-\-include paths... is equivalent to
105
106 .nf
107 git update\-index \-\-remove paths\&.\&.\&.
108 git commit
109 .fi
110
111
112 That is, update the specified paths to the index and then commit the whole tree\&.
113
114
115 git commit paths... largely bypasses the index file and commits only the changes made to the specified paths\&. It has however several safety valves to prevent confusion\&.
116
117 .TP 3
118 1.
119 It refuses to run during a merge (i\&.e\&. when $GIT_DIR/MERGE_HEAD exists), and reminds trained git users that the traditional semantics now needs \-i flag\&.
120 .TP
121 2.
122 It refuses to run if named paths... are different in HEAD and the index (ditto about reminding)\&. Added paths are OK\&. This is because an earlier git diff (not git diff HEAD) would have shown the differences since the last git update\-index paths... to the user, and an inexperienced user may mistakenly think that the changes between the index and the HEAD (i\&.e\&. earlier changes made before the last git update\-index paths... was done) are not being committed\&.
123 .TP
124 3.
125 It reads HEAD commit into a temporary index file, updates the specified paths... and makes a commit\&. At the same time, the real index file is also updated with the same paths...\&.
126 .LP
127
128
129 git commit \-\-all updates the index file with _all_ changes to the working tree, and makes a whole\-tree commit, regardless of which subdirectory the command is invoked in\&.
130
131 .SH "AUTHOR"
132
133
134 Written by Linus Torvalds <torvalds@osdl\&.org> and Junio C Hamano <junkio@cox\&.net>
135
136 .SH "GIT"
137
138
139 Part of the \fBgit\fR(7) suite
140