]> git.ipfire.org Git - thirdparty/git.git/blame - builtin-commit.c
Merge branch 'sb/maint-octopus' into maint
[thirdparty/git.git] / builtin-commit.c
CommitLineData
f5bbc322
KH
1/*
2 * Builtin "git commit"
3 *
4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
6 */
7
8#include "cache.h"
9#include "cache-tree.h"
6b2f2d98 10#include "color.h"
2888605c 11#include "dir.h"
f5bbc322
KH
12#include "builtin.h"
13#include "diff.h"
14#include "diffcore.h"
15#include "commit.h"
16#include "revision.h"
17#include "wt-status.h"
18#include "run-command.h"
19#include "refs.h"
20#include "log-tree.h"
21#include "strbuf.h"
22#include "utf8.h"
23#include "parse-options.h"
c455c87c 24#include "string-list.h"
5b2fd956 25#include "rerere.h"
fa9dcf80 26#include "unpack-trees.h"
f5bbc322
KH
27
28static const char * const builtin_commit_usage[] = {
1b1dd23f 29 "git commit [options] [--] <filepattern>...",
f5bbc322
KH
30 NULL
31};
32
2f02b25f 33static const char * const builtin_status_usage[] = {
1b1dd23f 34 "git status [options] [--] <filepattern>...",
2f02b25f
SB
35 NULL
36};
37
f5bbc322
KH
38static unsigned char head_sha1[20], merge_head_sha1[20];
39static char *use_message_buffer;
40static const char commit_editmsg[] = "COMMIT_EDITMSG";
2888605c
JH
41static struct lock_file index_lock; /* real index */
42static struct lock_file false_lock; /* used only for partial commits */
43static enum {
44 COMMIT_AS_IS = 1,
45 COMMIT_NORMAL,
46 COMMIT_PARTIAL,
47} commit_style;
f5bbc322 48
dbd0f5c7 49static const char *logfile, *force_author;
984c6e7e 50static const char *template_file;
f5bbc322 51static char *edit_message, *use_message;
e83dbe80 52static char *author_name, *author_email, *author_date;
f5bbc322 53static int all, edit_flag, also, interactive, only, amend, signoff;
c51f6cee 54static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
4bfee30a 55static char *untracked_files_arg;
5f065737
AR
56/*
57 * The default commit message cleanup mode will remove the lines
58 * beginning with # (shell comments) and leading and trailing
59 * whitespaces (empty lines or containing only whitespaces)
60 * if editor is used, and only the whitespaces if the message
61 * is specified explicitly.
62 */
63static enum {
64 CLEANUP_SPACE,
65 CLEANUP_NONE,
66 CLEANUP_ALL,
67} cleanup_mode;
68static char *cleanup_arg;
f5bbc322 69
4803466f 70static int use_editor = 1, initial_commit, in_merge;
3b6aeb3c
JS
71static const char *only_include_assumed;
72static struct strbuf message;
f9568530
JS
73
74static int opt_parse_m(const struct option *opt, const char *arg, int unset)
75{
76 struct strbuf *buf = opt->value;
77 if (unset)
78 strbuf_setlen(buf, 0);
79 else {
80 strbuf_addstr(buf, arg);
3b6aeb3c 81 strbuf_addstr(buf, "\n\n");
f9568530
JS
82 }
83 return 0;
84}
f5bbc322
KH
85
86static struct option builtin_commit_options[] = {
87 OPT__QUIET(&quiet),
88 OPT__VERBOSE(&verbose),
f5bbc322 89
e97ca7f4 90 OPT_GROUP("Commit message options"),
df217ed6 91 OPT_FILENAME('F', "file", &logfile, "read log from file"),
f5bbc322 92 OPT_STRING(0, "author", &force_author, "AUTHOR", "override author for commit"),
f9568530 93 OPT_CALLBACK('m', "message", &message, "MESSAGE", "specify commit message", opt_parse_m),
c51f6cee 94 OPT_STRING('c', "reedit-message", &edit_message, "COMMIT", "reuse and edit message from specified commit"),
f5bbc322 95 OPT_STRING('C', "reuse-message", &use_message, "COMMIT", "reuse message from specified commit"),
c51f6cee 96 OPT_BOOLEAN(0, "reset-author", &renew_authorship, "the commit is authored by me now (used with -C-c/--amend)"),
362b0dd5 97 OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
df217ed6 98 OPT_FILENAME('t', "template", &template_file, "use specified template file"),
f5bbc322 99 OPT_BOOLEAN('e', "edit", &edit_flag, "force edit of commit"),
e97ca7f4
GP
100 OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
101 /* end commit message options */
f5bbc322
KH
102
103 OPT_GROUP("Commit contents options"),
104 OPT_BOOLEAN('a', "all", &all, "commit all changed files"),
105 OPT_BOOLEAN('i', "include", &also, "add specified files to index for commit"),
106 OPT_BOOLEAN(0, "interactive", &interactive, "interactively add files"),
d4ba07ca 107 OPT_BOOLEAN('o', "only", &only, "commit only specified files"),
f5bbc322 108 OPT_BOOLEAN('n', "no-verify", &no_verify, "bypass pre-commit hook"),
3a5d13a3 109 OPT_BOOLEAN(0, "dry-run", &dry_run, "show what would be committed"),
f5bbc322 110 OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
6c2ce048 111 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg, "mode", "show untracked files, optional modes: all, normal, no. (Default: all)", PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
5241b6bf 112 OPT_BOOLEAN(0, "allow-empty", &allow_empty, "ok to record an empty change"),
e97ca7f4 113 /* end commit contents options */
f5bbc322
KH
114
115 OPT_END()
116};
117
2888605c
JH
118static void rollback_index_files(void)
119{
120 switch (commit_style) {
121 case COMMIT_AS_IS:
122 break; /* nothing to do */
123 case COMMIT_NORMAL:
124 rollback_lock_file(&index_lock);
125 break;
126 case COMMIT_PARTIAL:
127 rollback_lock_file(&index_lock);
128 rollback_lock_file(&false_lock);
129 break;
130 }
131}
132
5a9dd399 133static int commit_index_files(void)
2888605c 134{
5a9dd399
BC
135 int err = 0;
136
2888605c
JH
137 switch (commit_style) {
138 case COMMIT_AS_IS:
139 break; /* nothing to do */
140 case COMMIT_NORMAL:
5a9dd399 141 err = commit_lock_file(&index_lock);
2888605c
JH
142 break;
143 case COMMIT_PARTIAL:
5a9dd399 144 err = commit_lock_file(&index_lock);
2888605c
JH
145 rollback_lock_file(&false_lock);
146 break;
147 }
5a9dd399
BC
148
149 return err;
2888605c
JH
150}
151
152/*
153 * Take a union of paths in the index and the named tree (typically, "HEAD"),
154 * and return the paths that match the given pattern in list.
155 */
c455c87c 156static int list_paths(struct string_list *list, const char *with_tree,
2888605c
JH
157 const char *prefix, const char **pattern)
158{
159 int i;
160 char *m;
161
162 for (i = 0; pattern[i]; i++)
163 ;
164 m = xcalloc(1, i);
165
166 if (with_tree)
167 overlay_tree_on_cache(with_tree, prefix);
168
169 for (i = 0; i < active_nr; i++) {
170 struct cache_entry *ce = active_cache[i];
7a51ed66 171 if (ce->ce_flags & CE_UPDATE)
e87e22d0 172 continue;
0b50922a 173 if (!match_pathspec(pattern, ce->name, ce_namelen(ce), 0, m))
2888605c 174 continue;
c455c87c 175 string_list_insert(ce->name, list);
2888605c
JH
176 }
177
178 return report_path_error(m, pattern, prefix ? strlen(prefix) : 0);
179}
180
c455c87c 181static void add_remove_files(struct string_list *list)
2888605c
JH
182{
183 int i;
184 for (i = 0; i < list->nr; i++) {
d177cab0 185 struct stat st;
c455c87c 186 struct string_list_item *p = &(list->items[i]);
d177cab0 187
c455c87c
JS
188 if (!lstat(p->string, &st)) {
189 if (add_to_cache(p->string, &st, 0))
960b8ad1
AR
190 die("updating files failed");
191 } else
c455c87c 192 remove_file_from_cache(p->string);
2888605c
JH
193 }
194}
195
fa9dcf80
LT
196static void create_base_index(void)
197{
198 struct tree *tree;
199 struct unpack_trees_options opts;
200 struct tree_desc t;
201
202 if (initial_commit) {
203 discard_cache();
204 return;
205 }
206
207 memset(&opts, 0, sizeof(opts));
208 opts.head_idx = 1;
209 opts.index_only = 1;
210 opts.merge = 1;
34110cd4
LT
211 opts.src_index = &the_index;
212 opts.dst_index = &the_index;
fa9dcf80
LT
213
214 opts.fn = oneway_merge;
215 tree = parse_tree_indirect(head_sha1);
216 if (!tree)
217 die("failed to unpack HEAD tree object");
218 parse_tree(tree);
219 init_tree_desc(&t, tree->buffer, tree->size);
203a2fe1
DB
220 if (unpack_trees(1, &t, &opts))
221 exit(128); /* We've already reported the error, finish dying */
fa9dcf80
LT
222}
223
50b7e70f 224static char *prepare_index(int argc, const char **argv, const char *prefix, int is_status)
f5bbc322
KH
225{
226 int fd;
c455c87c 227 struct string_list partial;
2888605c 228 const char **pathspec = NULL;
50b7e70f 229 int refresh_flags = REFRESH_QUIET;
f5bbc322 230
50b7e70f
JH
231 if (is_status)
232 refresh_flags |= REFRESH_UNMERGED;
f5bbc322 233 if (interactive) {
4f6a32f8
JK
234 if (interactive_add(argc, argv, prefix) != 0)
235 die("interactive add failed");
671c9b7e 236 if (read_cache_preload(NULL) < 0)
d5350fd2 237 die("index file corrupt");
2888605c 238 commit_style = COMMIT_AS_IS;
f5bbc322
KH
239 return get_index_file();
240 }
241
f64fe7b4
JH
242 if (*argv)
243 pathspec = get_pathspec(prefix, argv);
2888605c 244
671c9b7e
LT
245 if (read_cache_preload(pathspec) < 0)
246 die("index file corrupt");
247
2888605c
JH
248 /*
249 * Non partial, non as-is commit.
250 *
251 * (1) get the real index;
252 * (2) update the_index as necessary;
253 * (3) write the_index out to the real index (still locked);
254 * (4) return the name of the locked index file.
255 *
256 * The caller should run hooks on the locked real index, and
257 * (A) if all goes well, commit the real index;
258 * (B) on failure, rollback the real index.
259 */
260 if (all || (also && pathspec && *pathspec)) {
261 int fd = hold_locked_index(&index_lock, 1);
7ae02a30 262 add_files_to_cache(also ? prefix : NULL, pathspec, 0);
50b7e70f 263 refresh_cache(refresh_flags);
4ed7cd3a
BC
264 if (write_cache(fd, active_cache, active_nr) ||
265 close_lock_file(&index_lock))
f5bbc322 266 die("unable to write new_index file");
2888605c
JH
267 commit_style = COMMIT_NORMAL;
268 return index_lock.filename;
f5bbc322
KH
269 }
270
2888605c
JH
271 /*
272 * As-is commit.
273 *
274 * (1) return the name of the real index file.
275 *
276 * The caller should run hooks on the real index, and run
277 * hooks on the real index, and create commit from the_index.
278 * We still need to refresh the index here.
279 */
280 if (!pathspec || !*pathspec) {
281 fd = hold_locked_index(&index_lock, 1);
50b7e70f 282 refresh_cache(refresh_flags);
2888605c 283 if (write_cache(fd, active_cache, active_nr) ||
4439751d 284 commit_locked_index(&index_lock))
2888605c
JH
285 die("unable to write new_index file");
286 commit_style = COMMIT_AS_IS;
f5bbc322
KH
287 return get_index_file();
288 }
289
2888605c
JH
290 /*
291 * A partial commit.
292 *
293 * (0) find the set of affected paths;
294 * (1) get lock on the real index file;
295 * (2) update the_index with the given paths;
296 * (3) write the_index out to the real index (still locked);
297 * (4) get lock on the false index file;
298 * (5) reset the_index from HEAD;
299 * (6) update the_index the same way as (2);
300 * (7) write the_index out to the false index file;
301 * (8) return the name of the false index file (still locked);
302 *
303 * The caller should run hooks on the locked false index, and
304 * create commit from it. Then
305 * (A) if all goes well, commit the real index;
306 * (B) on failure, rollback the real index;
307 * In either case, rollback the false index.
308 */
309 commit_style = COMMIT_PARTIAL;
310
311 if (file_exists(git_path("MERGE_HEAD")))
312 die("cannot do a partial commit during a merge.");
313
314 memset(&partial, 0, sizeof(partial));
c455c87c 315 partial.strdup_strings = 1;
2888605c
JH
316 if (list_paths(&partial, initial_commit ? NULL : "HEAD", prefix, pathspec))
317 exit(1);
318
319 discard_cache();
320 if (read_cache() < 0)
321 die("cannot read the index");
322
323 fd = hold_locked_index(&index_lock, 1);
324 add_remove_files(&partial);
ef12b50d 325 refresh_cache(REFRESH_QUIET);
4ed7cd3a
BC
326 if (write_cache(fd, active_cache, active_nr) ||
327 close_lock_file(&index_lock))
f5bbc322
KH
328 die("unable to write new_index file");
329
2888605c 330 fd = hold_lock_file_for_update(&false_lock,
a157400c
JH
331 git_path("next-index-%"PRIuMAX,
332 (uintmax_t) getpid()),
acd3b9ec 333 LOCK_DIE_ON_ERROR);
fa9dcf80
LT
334
335 create_base_index();
2888605c 336 add_remove_files(&partial);
d37d3203 337 refresh_cache(REFRESH_QUIET);
f5bbc322 338
4ed7cd3a
BC
339 if (write_cache(fd, active_cache, active_nr) ||
340 close_lock_file(&false_lock))
2888605c 341 die("unable to write temporary index file");
959ba670
JK
342
343 discard_cache();
344 read_cache_from(false_lock.filename);
345
2888605c 346 return false_lock.filename;
f5bbc322
KH
347}
348
d249b098
JH
349static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
350 struct wt_status *s)
f5bbc322 351{
d249b098
JH
352 if (s->relative_paths)
353 s->prefix = prefix;
f5bbc322
KH
354
355 if (amend) {
d249b098
JH
356 s->amend = 1;
357 s->reference = "HEAD^1";
f5bbc322 358 }
d249b098
JH
359 s->verbose = verbose;
360 s->index_file = index_file;
361 s->fp = fp;
362 s->nowarn = nowarn;
f5bbc322 363
d249b098 364 wt_status_print(s);
f5bbc322 365
d249b098 366 return s->commitable;
f5bbc322
KH
367}
368
ec84bd00
PB
369static int is_a_merge(const unsigned char *sha1)
370{
371 struct commit *commit = lookup_commit(sha1);
372 if (!commit || parse_commit(commit))
373 die("could not parse HEAD commit");
374 return !!(commit->parents && commit->parents->next);
375}
376
f5bbc322
KH
377static const char sign_off_header[] = "Signed-off-by: ";
378
e83dbe80 379static void determine_author_info(void)
a45d46ba
SB
380{
381 char *name, *email, *date;
382
383 name = getenv("GIT_AUTHOR_NAME");
384 email = getenv("GIT_AUTHOR_EMAIL");
385 date = getenv("GIT_AUTHOR_DATE");
386
c51f6cee 387 if (use_message && !renew_authorship) {
a45d46ba
SB
388 const char *a, *lb, *rb, *eol;
389
390 a = strstr(use_message_buffer, "\nauthor ");
391 if (!a)
392 die("invalid commit: %s", use_message);
393
394 lb = strstr(a + 8, " <");
395 rb = strstr(a + 8, "> ");
396 eol = strchr(a + 8, '\n');
397 if (!lb || !rb || !eol)
398 die("invalid commit: %s", use_message);
399
400 name = xstrndup(a + 8, lb - (a + 8));
401 email = xstrndup(lb + 2, rb - (lb + 2));
402 date = xstrndup(rb + 2, eol - (rb + 2));
403 }
404
405 if (force_author) {
406 const char *lb = strstr(force_author, " <");
407 const char *rb = strchr(force_author, '>');
408
409 if (!lb || !rb)
410 die("malformed --author parameter");
411 name = xstrndup(force_author, lb - force_author);
412 email = xstrndup(lb + 2, rb - (lb + 2));
413 }
414
e83dbe80
SB
415 author_name = name;
416 author_email = email;
417 author_date = date;
a45d46ba
SB
418}
419
c1e01b0c
DB
420static int ends_rfc2822_footer(struct strbuf *sb)
421{
422 int ch;
423 int hit = 0;
424 int i, j, k;
425 int len = sb->len;
426 int first = 1;
427 const char *buf = sb->buf;
428
429 for (i = len - 1; i > 0; i--) {
430 if (hit && buf[i] == '\n')
431 break;
432 hit = (buf[i] == '\n');
433 }
434
435 while (i < len - 1 && buf[i] == '\n')
436 i++;
437
438 for (; i < len; i = k) {
439 for (k = i; k < len && buf[k] != '\n'; k++)
440 ; /* do nothing */
441 k++;
442
443 if ((buf[k] == ' ' || buf[k] == '\t') && !first)
444 continue;
445
446 first = 0;
447
448 for (j = 0; i + j < len; j++) {
449 ch = buf[i + j];
450 if (ch == ':')
451 break;
452 if (isalnum(ch) ||
453 (ch == '-'))
454 continue;
455 return 0;
456 }
457 }
458 return 1;
459}
460
d249b098
JH
461static int prepare_to_commit(const char *index_file, const char *prefix,
462 struct wt_status *s)
f5bbc322
KH
463{
464 struct stat statbuf;
bc5d248a 465 int commitable, saved_color_setting;
f285a2d7 466 struct strbuf sb = STRBUF_INIT;
f5bbc322
KH
467 char *buffer;
468 FILE *fp;
8089c85b
PB
469 const char *hook_arg1 = NULL;
470 const char *hook_arg2 = NULL;
bb1ae3f6 471 int ident_shown = 0;
f5bbc322 472
ec84bd00
PB
473 if (!no_verify && run_hook(index_file, "pre-commit", NULL))
474 return 0;
f5bbc322 475
f9568530
JS
476 if (message.len) {
477 strbuf_addbuf(&sb, &message);
8089c85b 478 hook_arg1 = "message";
f5bbc322
KH
479 } else if (logfile && !strcmp(logfile, "-")) {
480 if (isatty(0))
481 fprintf(stderr, "(reading log message from standard input)\n");
482 if (strbuf_read(&sb, 0, 0) < 0)
0721c314 483 die_errno("could not read log from standard input");
8089c85b 484 hook_arg1 = "message";
f5bbc322
KH
485 } else if (logfile) {
486 if (strbuf_read_file(&sb, logfile, 0) < 0)
d824cbba
TR
487 die_errno("could not read log file '%s'",
488 logfile);
8089c85b 489 hook_arg1 = "message";
f5bbc322
KH
490 } else if (use_message) {
491 buffer = strstr(use_message_buffer, "\n\n");
492 if (!buffer || buffer[2] == '\0')
493 die("commit has empty message");
494 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
8089c85b
PB
495 hook_arg1 = "commit";
496 hook_arg2 = use_message;
f5bbc322
KH
497 } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
498 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
d824cbba 499 die_errno("could not read MERGE_MSG");
8089c85b 500 hook_arg1 = "merge";
f5bbc322
KH
501 } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
502 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
d824cbba 503 die_errno("could not read SQUASH_MSG");
8089c85b 504 hook_arg1 = "squash";
f5bbc322
KH
505 } else if (template_file && !stat(template_file, &statbuf)) {
506 if (strbuf_read_file(&sb, template_file, 0) < 0)
d824cbba 507 die_errno("could not read '%s'", template_file);
8089c85b 508 hook_arg1 = "template";
f5bbc322
KH
509 }
510
8089c85b
PB
511 /*
512 * This final case does not modify the template message,
513 * it just sets the argument to the prepare-commit-msg hook.
514 */
515 else if (in_merge)
516 hook_arg1 = "merge";
517
f5bbc322
KH
518 fp = fopen(git_path(commit_editmsg), "w");
519 if (fp == NULL)
d824cbba 520 die_errno("could not open '%s'", git_path(commit_editmsg));
f5bbc322 521
5f065737
AR
522 if (cleanup_mode != CLEANUP_NONE)
523 stripspace(&sb, 0);
f5bbc322
KH
524
525 if (signoff) {
f285a2d7 526 struct strbuf sob = STRBUF_INIT;
13208572
JS
527 int i;
528
13208572 529 strbuf_addstr(&sob, sign_off_header);
d9ccfe77
JH
530 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
531 getenv("GIT_COMMITTER_EMAIL")));
13208572 532 strbuf_addch(&sob, '\n');
13208572
JS
533 for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
534 ; /* do nothing */
2150554b 535 if (prefixcmp(sb.buf + i, sob.buf)) {
e5138436 536 if (!i || !ends_rfc2822_footer(&sb))
2150554b 537 strbuf_addch(&sb, '\n');
13208572 538 strbuf_addbuf(&sb, &sob);
2150554b 539 }
13208572 540 strbuf_release(&sob);
f5bbc322
KH
541 }
542
13208572 543 if (fwrite(sb.buf, 1, sb.len, fp) < sb.len)
d824cbba 544 die_errno("could not write commit template");
13208572 545
f5bbc322
KH
546 strbuf_release(&sb);
547
e83dbe80
SB
548 determine_author_info();
549
bb1ae3f6
SB
550 /* This checks if committer ident is explicitly given */
551 git_committer_info(0);
ec84bd00 552 if (use_editor) {
e83dbe80
SB
553 char *author_ident;
554 const char *committer_ident;
555
ec84bd00
PB
556 if (in_merge)
557 fprintf(fp,
558 "#\n"
559 "# It looks like you may be committing a MERGE.\n"
560 "# If this is not correct, please remove the file\n"
561 "# %s\n"
562 "# and try again.\n"
563 "#\n",
564 git_path("MERGE_HEAD"));
565
566 fprintf(fp,
567 "\n"
fdc7c811 568 "# Please enter the commit message for your changes.");
ec84bd00 569 if (cleanup_mode == CLEANUP_ALL)
fdc7c811
JK
570 fprintf(fp,
571 " Lines starting\n"
572 "# with '#' will be ignored, and an empty"
573 " message aborts the commit.\n");
ec84bd00 574 else /* CLEANUP_SPACE, that is. */
fdc7c811
JK
575 fprintf(fp,
576 " Lines starting\n"
577 "# with '#' will be kept; you may remove them"
578 " yourself if you want to.\n"
579 "# An empty message aborts the commit.\n");
ec84bd00
PB
580 if (only_include_assumed)
581 fprintf(fp, "# %s\n", only_include_assumed);
582
e83dbe80
SB
583 author_ident = xstrdup(fmt_name(author_name, author_email));
584 committer_ident = fmt_name(getenv("GIT_COMMITTER_NAME"),
585 getenv("GIT_COMMITTER_EMAIL"));
586 if (strcmp(author_ident, committer_ident))
587 fprintf(fp,
bb1ae3f6
SB
588 "%s"
589 "# Author: %s\n",
590 ident_shown++ ? "" : "#\n",
e83dbe80
SB
591 author_ident);
592 free(author_ident);
593
bb1ae3f6
SB
594 if (!user_ident_explicitly_given)
595 fprintf(fp,
596 "%s"
597 "# Committer: %s\n",
598 ident_shown++ ? "" : "#\n",
599 committer_ident);
600
601 if (ident_shown)
602 fprintf(fp, "#\n");
603
d249b098
JH
604 saved_color_setting = s->use_color;
605 s->use_color = 0;
606 commitable = run_status(fp, index_file, prefix, 1, s);
607 s->use_color = saved_color_setting;
ec84bd00 608 } else {
d616a239 609 unsigned char sha1[20];
fbcf1184 610 const char *parent = "HEAD";
7168624c 611
7168624c
AR
612 if (!active_nr && read_cache() < 0)
613 die("Cannot read index");
614
fbcf1184
JH
615 if (amend)
616 parent = "HEAD^1";
617
d616a239 618 if (get_sha1(parent, sha1))
ec84bd00 619 commitable = !!active_nr;
75f3ff2e
SB
620 else
621 commitable = index_differs_from(parent, 0);
ec84bd00 622 }
d616a239 623
ec84bd00 624 fclose(fp);
7168624c 625
ec84bd00
PB
626 if (!commitable && !in_merge && !allow_empty &&
627 !(amend && is_a_merge(head_sha1))) {
d249b098 628 run_status(stdout, index_file, prefix, 0, s);
ec84bd00 629 return 0;
7168624c
AR
630 }
631
ec84bd00
PB
632 /*
633 * Re-read the index as pre-commit hook could have updated it,
634 * and write it out as a tree. We must do this before we invoke
635 * the editor and after we invoke run_status above.
636 */
637 discard_cache();
638 read_cache_from(index_file);
639 if (!active_cache_tree)
640 active_cache_tree = cache_tree();
641 if (cache_tree_update(active_cache_tree,
642 active_cache, active_nr, 0, 0) < 0) {
331fcb59 643 error("Error building trees");
ec84bd00 644 return 0;
7168624c 645 }
f5bbc322 646
8089c85b
PB
647 if (run_hook(index_file, "prepare-commit-msg",
648 git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
649 return 0;
f5bbc322 650
ec84bd00
PB
651 if (use_editor) {
652 char index[PATH_MAX];
653 const char *env[2] = { index, NULL };
654 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
7198203a
SB
655 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
656 fprintf(stderr,
657 "Please supply the message using either -m or -F option.\n");
658 exit(1);
659 }
ec84bd00 660 }
f5bbc322 661
ec84bd00
PB
662 if (!no_verify &&
663 run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
664 return 0;
665 }
f5bbc322 666
ec84bd00 667 return 1;
f5bbc322
KH
668}
669
670/*
6bb6b034
MV
671 * Find out if the message in the strbuf contains only whitespace and
672 * Signed-off-by lines.
f5bbc322 673 */
6bb6b034 674static int message_is_empty(struct strbuf *sb)
f5bbc322 675{
f285a2d7 676 struct strbuf tmpl = STRBUF_INIT;
f5bbc322 677 const char *nl;
6bb6b034 678 int eol, i, start = 0;
f5bbc322 679
5f065737
AR
680 if (cleanup_mode == CLEANUP_NONE && sb->len)
681 return 0;
682
f5bbc322 683 /* See if the template is just a prefix of the message. */
f5bbc322 684 if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
5f065737 685 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
f5bbc322
KH
686 if (start + tmpl.len <= sb->len &&
687 memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
688 start += tmpl.len;
689 }
690 strbuf_release(&tmpl);
691
692 /* Check if the rest is just whitespace and Signed-of-by's. */
693 for (i = start; i < sb->len; i++) {
694 nl = memchr(sb->buf + i, '\n', sb->len - i);
695 if (nl)
696 eol = nl - sb->buf;
697 else
698 eol = sb->len;
699
700 if (strlen(sign_off_header) <= eol - i &&
701 !prefixcmp(sb->buf + i, sign_off_header)) {
702 i = eol;
703 continue;
704 }
705 while (i < eol)
706 if (!isspace(sb->buf[i++]))
707 return 0;
708 }
709
710 return 1;
711}
712
146ea068
JH
713static const char *find_author_by_nickname(const char *name)
714{
715 struct rev_info revs;
716 struct commit *commit;
717 struct strbuf buf = STRBUF_INIT;
718 const char *av[20];
719 int ac = 0;
720
721 init_revisions(&revs, NULL);
722 strbuf_addf(&buf, "--author=%s", name);
723 av[++ac] = "--all";
724 av[++ac] = "-i";
725 av[++ac] = buf.buf;
726 av[++ac] = NULL;
727 setup_revisions(ac, av, &revs, NULL);
728 prepare_revision_walk(&revs);
729 commit = get_revision(&revs);
730 if (commit) {
dd2e794a
TR
731 struct pretty_print_context ctx = {0};
732 ctx.date_mode = DATE_NORMAL;
146ea068 733 strbuf_release(&buf);
dd2e794a 734 format_commit_message(commit, "%an <%ae>", &buf, &ctx);
146ea068
JH
735 return strbuf_detach(&buf, NULL);
736 }
737 die("No existing author found with '%s'", name);
738}
739
2f02b25f 740static int parse_and_validate_options(int argc, const char *argv[],
dbd0f5c7 741 const char * const usage[],
d249b098
JH
742 const char *prefix,
743 struct wt_status *s)
f5bbc322
KH
744{
745 int f = 0;
746
37782920
SB
747 argc = parse_options(argc, argv, prefix, builtin_commit_options, usage,
748 0);
f5bbc322 749
146ea068
JH
750 if (force_author && !strchr(force_author, '>'))
751 force_author = find_author_by_nickname(force_author);
752
c51f6cee
EM
753 if (force_author && renew_authorship)
754 die("Using both --reset-author and --author does not make sense");
755
f9568530 756 if (logfile || message.len || use_message)
4803466f 757 use_editor = 0;
f5bbc322 758 if (edit_flag)
4803466f 759 use_editor = 1;
406400ce
PB
760 if (!use_editor)
761 setenv("GIT_EDITOR", ":", 1);
f5bbc322
KH
762
763 if (get_sha1("HEAD", head_sha1))
764 initial_commit = 1;
765
766 if (!get_sha1("MERGE_HEAD", merge_head_sha1))
767 in_merge = 1;
768
769 /* Sanity check options */
770 if (amend && initial_commit)
771 die("You have nothing to amend.");
772 if (amend && in_merge)
b5b644a9 773 die("You are in the middle of a merge -- cannot amend.");
f5bbc322
KH
774
775 if (use_message)
776 f++;
777 if (edit_message)
778 f++;
779 if (logfile)
780 f++;
781 if (f > 1)
782 die("Only one of -c/-C/-F can be used.");
f9568530 783 if (message.len && f > 0)
f5bbc322
KH
784 die("Option -m cannot be combined with -c/-C/-F.");
785 if (edit_message)
786 use_message = edit_message;
1eb1e9ee 787 if (amend && !use_message)
f5bbc322 788 use_message = "HEAD";
c51f6cee
EM
789 if (!use_message && renew_authorship)
790 die("--reset-author can be used only with -C, -c or --amend.");
f5bbc322
KH
791 if (use_message) {
792 unsigned char sha1[20];
793 static char utf8[] = "UTF-8";
794 const char *out_enc;
795 char *enc, *end;
796 struct commit *commit;
797
798 if (get_sha1(use_message, sha1))
799 die("could not lookup commit %s", use_message);
8a2f8733 800 commit = lookup_commit_reference(sha1);
f5bbc322
KH
801 if (!commit || parse_commit(commit))
802 die("could not parse commit %s", use_message);
803
804 enc = strstr(commit->buffer, "\nencoding");
805 if (enc) {
806 end = strchr(enc + 10, '\n');
807 enc = xstrndup(enc + 10, end - (enc + 10));
808 } else {
809 enc = utf8;
810 }
811 out_enc = git_commit_encoding ? git_commit_encoding : utf8;
812
813 if (strcmp(out_enc, enc))
814 use_message_buffer =
815 reencode_string(commit->buffer, out_enc, enc);
816
817 /*
818 * If we failed to reencode the buffer, just copy it
819 * byte for byte so the user can try to fix it up.
820 * This also handles the case where input and output
821 * encodings are identical.
822 */
823 if (use_message_buffer == NULL)
824 use_message_buffer = xstrdup(commit->buffer);
825 if (enc != utf8)
826 free(enc);
827 }
828
829 if (!!also + !!only + !!all + !!interactive > 1)
830 die("Only one of --include/--only/--all/--interactive can be used.");
831 if (argc == 0 && (also || (only && !amend)))
832 die("No paths with --include/--only does not make sense.");
833 if (argc == 0 && only && amend)
834 only_include_assumed = "Clever... amending the last one with dirty index.";
3c5283f8 835 if (argc > 0 && !also && !only)
f5bbc322 836 only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
5f065737
AR
837 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
838 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
839 else if (!strcmp(cleanup_arg, "verbatim"))
840 cleanup_mode = CLEANUP_NONE;
841 else if (!strcmp(cleanup_arg, "whitespace"))
842 cleanup_mode = CLEANUP_SPACE;
843 else if (!strcmp(cleanup_arg, "strip"))
844 cleanup_mode = CLEANUP_ALL;
845 else
846 die("Invalid cleanup mode %s", cleanup_arg);
f5bbc322 847
4bfee30a
MSO
848 if (!untracked_files_arg)
849 ; /* default already initialized */
6c2ce048 850 else if (!strcmp(untracked_files_arg, "no"))
d249b098 851 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
4bfee30a 852 else if (!strcmp(untracked_files_arg, "normal"))
d249b098 853 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
4bfee30a 854 else if (!strcmp(untracked_files_arg, "all"))
d249b098 855 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
4bfee30a
MSO
856 else
857 die("Invalid untracked files mode '%s'", untracked_files_arg);
858
f5bbc322
KH
859 if (all && argc > 0)
860 die("Paths with -a does not make sense.");
861 else if (interactive && argc > 0)
862 die("Paths with --interactive does not make sense.");
863
864 return argc;
865}
866
d249b098
JH
867static int dry_run_commit(int argc, const char **argv, const char *prefix,
868 struct wt_status *s)
f5bbc322 869{
f5bbc322 870 int commitable;
3a5d13a3 871 const char *index_file;
f5bbc322 872
3a5d13a3 873 index_file = prepare_index(argc, argv, prefix, 1);
d249b098 874 commitable = run_status(stdout, index_file, prefix, 0, s);
3a5d13a3 875 rollback_index_files();
f5bbc322 876
3a5d13a3
JH
877 return commitable ? 0 : 1;
878}
879
f766b367
JH
880static int parse_status_slot(const char *var, int offset)
881{
882 if (!strcasecmp(var+offset, "header"))
883 return WT_STATUS_HEADER;
884 if (!strcasecmp(var+offset, "updated")
885 || !strcasecmp(var+offset, "added"))
886 return WT_STATUS_UPDATED;
887 if (!strcasecmp(var+offset, "changed"))
888 return WT_STATUS_CHANGED;
889 if (!strcasecmp(var+offset, "untracked"))
890 return WT_STATUS_UNTRACKED;
891 if (!strcasecmp(var+offset, "nobranch"))
892 return WT_STATUS_NOBRANCH;
893 if (!strcasecmp(var+offset, "unmerged"))
894 return WT_STATUS_UNMERGED;
8b8e8624 895 return -1;
f766b367
JH
896}
897
898static int git_status_config(const char *k, const char *v, void *cb)
899{
900 struct wt_status *s = cb;
901
902 if (!strcmp(k, "status.submodulesummary")) {
903 int is_bool;
904 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
905 if (is_bool && s->submodule_summary)
906 s->submodule_summary = -1;
907 return 0;
908 }
909 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
910 s->use_color = git_config_colorbool(k, v, -1);
911 return 0;
912 }
913 if (!prefixcmp(k, "status.color.") || !prefixcmp(k, "color.status.")) {
914 int slot = parse_status_slot(k, 13);
8b8e8624
JK
915 if (slot < 0)
916 return 0;
f766b367
JH
917 if (!v)
918 return config_error_nonbool(k);
919 color_parse(v, k, s->color_palette[slot]);
920 return 0;
921 }
922 if (!strcmp(k, "status.relativepaths")) {
923 s->relative_paths = git_config_bool(k, v);
924 return 0;
925 }
926 if (!strcmp(k, "status.showuntrackedfiles")) {
927 if (!v)
928 return config_error_nonbool(k);
929 else if (!strcmp(v, "no"))
930 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
931 else if (!strcmp(v, "normal"))
932 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
933 else if (!strcmp(v, "all"))
934 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
935 else
936 return error("Invalid untracked files mode '%s'", v);
937 return 0;
938 }
939 return git_diff_ui_config(k, v, NULL);
940}
941
3a5d13a3
JH
942int cmd_status(int argc, const char **argv, const char *prefix)
943{
d249b098
JH
944 struct wt_status s;
945
946 wt_status_prepare(&s);
947 git_config(git_status_config, &s);
948 if (s.use_color == -1)
949 s.use_color = git_use_color_default;
38920dd6
MH
950 if (diff_use_color_default == -1)
951 diff_use_color_default = git_use_color_default;
952
d249b098
JH
953 argc = parse_and_validate_options(argc, argv, builtin_status_usage,
954 prefix, &s);
955 return dry_run_commit(argc, argv, prefix, &s);
f5bbc322
KH
956}
957
f5bbc322
KH
958static void print_summary(const char *prefix, const unsigned char *sha1)
959{
960 struct rev_info rev;
961 struct commit *commit;
c5ee71fd 962 static const char *format = "format:%h] %s";
c85db254
JK
963 unsigned char junk_sha1[20];
964 const char *head = resolve_ref("HEAD", junk_sha1, 0, NULL);
f5bbc322
KH
965
966 commit = lookup_commit(sha1);
967 if (!commit)
b5b644a9 968 die("couldn't look up newly created commit");
f5bbc322
KH
969 if (!commit || parse_commit(commit))
970 die("could not parse newly created commit");
971
972 init_revisions(&rev, prefix);
973 setup_revisions(0, NULL, &rev, NULL);
974
975 rev.abbrev = 0;
976 rev.diff = 1;
977 rev.diffopt.output_format =
978 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
979
980 rev.verbose_header = 1;
981 rev.show_root_diff = 1;
e502f9e7 982 get_commit_format(format, &rev);
bf82a150 983 rev.always_show_header = 0;
3eb2a15e
JH
984 rev.diffopt.detect_rename = 1;
985 rev.diffopt.rename_limit = 100;
986 rev.diffopt.break_opt = 0;
15964563 987 diff_setup_done(&rev.diffopt);
f5bbc322 988
c5ee71fd 989 printf("[%s%s ",
c85db254
JK
990 !prefixcmp(head, "refs/heads/") ?
991 head + 11 :
992 !strcmp(head, "HEAD") ?
993 "detached HEAD" :
994 head,
995 initial_commit ? " (root-commit)" : "");
f5bbc322 996
bf82a150 997 if (!log_tree_commit(&rev, commit)) {
dd2e794a 998 struct pretty_print_context ctx = {0};
bf82a150 999 struct strbuf buf = STRBUF_INIT;
dd2e794a
TR
1000 ctx.date_mode = DATE_NORMAL;
1001 format_commit_message(commit, format + 7, &buf, &ctx);
bf82a150
JH
1002 printf("%s\n", buf.buf);
1003 strbuf_release(&buf);
1004 }
f5bbc322
KH
1005}
1006
186458b1 1007static int git_commit_config(const char *k, const char *v, void *cb)
f5bbc322 1008{
d249b098
JH
1009 struct wt_status *s = cb;
1010
984c6e7e 1011 if (!strcmp(k, "commit.template"))
395de250 1012 return git_config_pathname(&template_file, k, v);
f5bbc322 1013
d249b098 1014 return git_status_config(k, v, s);
f5bbc322
KH
1015}
1016
f5bbc322
KH
1017int cmd_commit(int argc, const char **argv, const char *prefix)
1018{
f285a2d7 1019 struct strbuf sb = STRBUF_INIT;
f5bbc322 1020 const char *index_file, *reflog_msg;
99a12694 1021 char *nl, *p;
f5bbc322
KH
1022 unsigned char commit_sha1[20];
1023 struct ref_lock *ref_lock;
6bb6b034 1024 struct commit_list *parents = NULL, **pptr = &parents;
cf10f9fd
MV
1025 struct stat statbuf;
1026 int allow_fast_forward = 1;
d249b098 1027 struct wt_status s;
f5bbc322 1028
d249b098
JH
1029 wt_status_prepare(&s);
1030 git_config(git_commit_config, &s);
f5bbc322 1031
d249b098
JH
1032 if (s.use_color == -1)
1033 s.use_color = git_use_color_default;
3f4b609f 1034
d249b098
JH
1035 argc = parse_and_validate_options(argc, argv, builtin_commit_usage,
1036 prefix, &s);
3fa509df
JH
1037 if (dry_run) {
1038 if (diff_use_color_default == -1)
1039 diff_use_color_default = git_use_color_default;
d249b098 1040 return dry_run_commit(argc, argv, prefix, &s);
3fa509df 1041 }
50b7e70f 1042 index_file = prepare_index(argc, argv, prefix, 0);
f5bbc322 1043
ec84bd00
PB
1044 /* Set up everything for writing the commit object. This includes
1045 running hooks, writing the trees, and interacting with the user. */
d249b098 1046 if (!prepare_to_commit(index_file, prefix, &s)) {
2888605c 1047 rollback_index_files();
f5bbc322
KH
1048 return 1;
1049 }
1050
f5bbc322
KH
1051 /* Determine parents */
1052 if (initial_commit) {
1053 reflog_msg = "commit (initial)";
f5bbc322
KH
1054 } else if (amend) {
1055 struct commit_list *c;
1056 struct commit *commit;
1057
1058 reflog_msg = "commit (amend)";
1059 commit = lookup_commit(head_sha1);
1060 if (!commit || parse_commit(commit))
1061 die("could not parse HEAD commit");
1062
1063 for (c = commit->parents; c; c = c->next)
6bb6b034 1064 pptr = &commit_list_insert(c->item, pptr)->next;
f5bbc322 1065 } else if (in_merge) {
f285a2d7 1066 struct strbuf m = STRBUF_INIT;
f5bbc322
KH
1067 FILE *fp;
1068
1069 reflog_msg = "commit (merge)";
6bb6b034 1070 pptr = &commit_list_insert(lookup_commit(head_sha1), pptr)->next;
f5bbc322
KH
1071 fp = fopen(git_path("MERGE_HEAD"), "r");
1072 if (fp == NULL)
d824cbba
TR
1073 die_errno("could not open '%s' for reading",
1074 git_path("MERGE_HEAD"));
7c3fd25d
LT
1075 while (strbuf_getline(&m, fp, '\n') != EOF) {
1076 unsigned char sha1[20];
1077 if (get_sha1_hex(m.buf, sha1) < 0)
1078 die("Corrupt MERGE_HEAD file (%s)", m.buf);
6bb6b034 1079 pptr = &commit_list_insert(lookup_commit(sha1), pptr)->next;
7c3fd25d 1080 }
f5bbc322
KH
1081 fclose(fp);
1082 strbuf_release(&m);
cf10f9fd
MV
1083 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
1084 if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
d824cbba 1085 die_errno("could not read MERGE_MODE");
cf10f9fd
MV
1086 if (!strcmp(sb.buf, "no-ff"))
1087 allow_fast_forward = 0;
1088 }
1089 if (allow_fast_forward)
1090 parents = reduce_heads(parents);
f5bbc322
KH
1091 } else {
1092 reflog_msg = "commit";
6bb6b034 1093 pptr = &commit_list_insert(lookup_commit(head_sha1), pptr)->next;
f5bbc322 1094 }
f5bbc322 1095
ec84bd00 1096 /* Finally, get the commit message */
cf10f9fd 1097 strbuf_reset(&sb);
740001a5 1098 if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
0721c314 1099 int saved_errno = errno;
740001a5 1100 rollback_index_files();
0721c314 1101 die("could not read commit message: %s", strerror(saved_errno));
740001a5 1102 }
99a12694
KH
1103
1104 /* Truncate the message just before the diff, if any. */
0b38227f
JK
1105 if (verbose) {
1106 p = strstr(sb.buf, "\ndiff --git ");
1107 if (p != NULL)
1108 strbuf_setlen(&sb, p - sb.buf + 1);
1109 }
99a12694 1110
5f065737
AR
1111 if (cleanup_mode != CLEANUP_NONE)
1112 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
6bb6b034 1113 if (message_is_empty(&sb)) {
2888605c 1114 rollback_index_files();
fdc7c811
JK
1115 fprintf(stderr, "Aborting commit due to empty commit message.\n");
1116 exit(1);
2888605c 1117 }
f5bbc322 1118
6bb6b034
MV
1119 if (commit_tree(sb.buf, active_cache_tree->sha1, parents, commit_sha1,
1120 fmt_ident(author_name, author_email, author_date,
1121 IDENT_ERROR_ON_NO_NAME))) {
2888605c 1122 rollback_index_files();
f5bbc322 1123 die("failed to write commit object");
2888605c 1124 }
f5bbc322
KH
1125
1126 ref_lock = lock_any_ref_for_update("HEAD",
1127 initial_commit ? NULL : head_sha1,
1128 0);
1129
6bb6b034 1130 nl = strchr(sb.buf, '\n');
741707b1
JS
1131 if (nl)
1132 strbuf_setlen(&sb, nl + 1 - sb.buf);
1133 else
1134 strbuf_addch(&sb, '\n');
741707b1
JS
1135 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1136 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
f5bbc322 1137
2888605c
JH
1138 if (!ref_lock) {
1139 rollback_index_files();
f5bbc322 1140 die("cannot lock HEAD ref");
2888605c
JH
1141 }
1142 if (write_ref_sha1(ref_lock, commit_sha1, sb.buf) < 0) {
1143 rollback_index_files();
f5bbc322 1144 die("cannot update HEAD ref");
2888605c 1145 }
f5bbc322
KH
1146
1147 unlink(git_path("MERGE_HEAD"));
1148 unlink(git_path("MERGE_MSG"));
cf10f9fd 1149 unlink(git_path("MERGE_MODE"));
5a95b855 1150 unlink(git_path("SQUASH_MSG"));
f5bbc322 1151
5a9dd399
BC
1152 if (commit_index_files())
1153 die ("Repository has been updated, but unable to write\n"
1154 "new_index file. Check that disk is not full or quota is\n"
1155 "not exceeded, and then \"git reset HEAD\" to recover.");
f5bbc322
KH
1156
1157 rerere();
2888605c 1158 run_hook(get_index_file(), "post-commit", NULL);
f5bbc322
KH
1159 if (!quiet)
1160 print_summary(prefix, commit_sha1);
1161
1162 return 0;
1163}