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