2 * "git add" builtin command
4 * Copyright (C) 2006 Linus Torvalds
6 #define USE_THE_INDEX_COMPATIBILITY_MACROS
14 #include "cache-tree.h"
15 #include "run-command.h"
16 #include "parse-options.h"
20 #include "bulk-checkin.h"
21 #include "argv-array.h"
22 #include "submodule.h"
23 #include "add-interactive.h"
25 static const char * const builtin_add_usage[] = {
26 N_("git add [<options>] [--] <pathspec>..."),
29 static int patch_interactive, add_interactive, edit_interactive;
30 static int take_worktree_changes;
31 static int add_renormalize;
32 static int legacy_stash_p; /* support for the scripted `git stash` */
34 struct update_callback_data {
39 static void chmod_pathspec(struct pathspec *pathspec, char flip)
43 for (i = 0; i < active_nr; i++) {
44 struct cache_entry *ce = active_cache[i];
46 if (pathspec && !ce_path_match(&the_index, ce, pathspec, NULL))
49 if (chmod_cache_entry(ce, flip) < 0)
50 fprintf(stderr, "cannot chmod %cx '%s'\n", flip, ce->name);
54 static int fix_unmerged_status(struct diff_filepair *p,
55 struct update_callback_data *data)
57 if (p->status != DIFF_STATUS_UNMERGED)
59 if (!(data->flags & ADD_CACHE_IGNORE_REMOVAL) && !p->two->mode)
61 * This is not an explicit add request, and the
62 * path is missing from the working tree (deleted)
64 return DIFF_STATUS_DELETED;
67 * Either an explicit add request, or path exists
68 * in the working tree. An attempt to explicitly
69 * add a path that does not exist in the working tree
70 * will be caught as an error by the caller immediately.
72 return DIFF_STATUS_MODIFIED;
75 static void update_callback(struct diff_queue_struct *q,
76 struct diff_options *opt, void *cbdata)
79 struct update_callback_data *data = cbdata;
81 for (i = 0; i < q->nr; i++) {
82 struct diff_filepair *p = q->queue[i];
83 const char *path = p->one->path;
84 switch (fix_unmerged_status(p, data)) {
86 die(_("unexpected diff status %c"), p->status);
87 case DIFF_STATUS_MODIFIED:
88 case DIFF_STATUS_TYPE_CHANGED:
89 if (add_file_to_index(&the_index, path, data->flags)) {
90 if (!(data->flags & ADD_CACHE_IGNORE_ERRORS))
91 die(_("updating files failed"));
95 case DIFF_STATUS_DELETED:
96 if (data->flags & ADD_CACHE_IGNORE_REMOVAL)
98 if (!(data->flags & ADD_CACHE_PRETEND))
99 remove_file_from_index(&the_index, path);
100 if (data->flags & (ADD_CACHE_PRETEND|ADD_CACHE_VERBOSE))
101 printf(_("remove '%s'\n"), path);
107 int add_files_to_cache(const char *prefix,
108 const struct pathspec *pathspec, int flags)
110 struct update_callback_data data;
113 memset(&data, 0, sizeof(data));
116 repo_init_revisions(the_repository, &rev, prefix);
117 setup_revisions(0, NULL, &rev, NULL);
119 copy_pathspec(&rev.prune_data, pathspec);
120 rev.diffopt.output_format = DIFF_FORMAT_CALLBACK;
121 rev.diffopt.format_callback = update_callback;
122 rev.diffopt.format_callback_data = &data;
123 rev.diffopt.flags.override_submodule_config = 1;
124 rev.max_count = 0; /* do not compare unmerged paths with stage #2 */
125 run_diff_files(&rev, DIFF_RACY_IS_MODIFIED);
126 clear_pathspec(&rev.prune_data);
127 return !!data.add_errors;
130 static int renormalize_tracked_files(const struct pathspec *pathspec, int flags)
134 for (i = 0; i < active_nr; i++) {
135 struct cache_entry *ce = active_cache[i];
138 continue; /* do not touch unmerged paths */
139 if (!S_ISREG(ce->ce_mode) && !S_ISLNK(ce->ce_mode))
140 continue; /* do not touch non blobs */
141 if (pathspec && !ce_path_match(&the_index, ce, pathspec, NULL))
143 retval |= add_file_to_cache(ce->name, flags | ADD_CACHE_RENORMALIZE);
149 static char *prune_directory(struct dir_struct *dir, struct pathspec *pathspec, int prefix)
153 struct dir_entry **src, **dst;
155 seen = xcalloc(pathspec->nr, 1);
157 src = dst = dir->entries;
160 struct dir_entry *entry = *src++;
161 if (dir_path_match(&the_index, entry, pathspec, prefix, seen))
164 dir->nr = dst - dir->entries;
165 add_pathspec_matches_against_index(pathspec, &the_index, seen);
169 static void refresh(int verbose, const struct pathspec *pathspec)
174 seen = xcalloc(pathspec->nr, 1);
175 refresh_index(&the_index, verbose ? REFRESH_IN_PORCELAIN : REFRESH_QUIET,
176 pathspec, seen, _("Unstaged changes after refreshing the index:"));
177 for (i = 0; i < pathspec->nr; i++) {
179 die(_("pathspec '%s' did not match any files"),
180 pathspec->items[i].match);
185 int run_add_interactive(const char *revision, const char *patch_mode,
186 const struct pathspec *pathspec)
189 struct argv_array argv = ARGV_ARRAY_INIT;
190 int use_builtin_add_i =
191 git_env_bool("GIT_TEST_ADD_I_USE_BUILTIN", -1);
193 if (use_builtin_add_i < 0)
194 git_config_get_bool("add.interactive.usebuiltin",
197 if (use_builtin_add_i == 1) {
198 enum add_p_mode mode;
201 return !!run_add_i(the_repository, pathspec);
203 if (!strcmp(patch_mode, "--patch"))
205 else if (!strcmp(patch_mode, "--patch=stash"))
207 else if (!strcmp(patch_mode, "--patch=reset"))
209 else if (!strcmp(patch_mode, "--patch=checkout"))
210 mode = ADD_P_CHECKOUT;
212 die("'%s' not supported", patch_mode);
214 return !!run_add_p(the_repository, mode, revision, pathspec);
217 argv_array_push(&argv, "add--interactive");
219 argv_array_push(&argv, patch_mode);
221 argv_array_push(&argv, revision);
222 argv_array_push(&argv, "--");
223 for (i = 0; i < pathspec->nr; i++)
224 /* pass original pathspec, to be re-parsed */
225 argv_array_push(&argv, pathspec->items[i].original);
227 status = run_command_v_opt(argv.argv, RUN_GIT_CMD);
228 argv_array_clear(&argv);
232 int interactive_add(int argc, const char **argv, const char *prefix, int patch)
234 struct pathspec pathspec;
236 parse_pathspec(&pathspec, 0,
237 PATHSPEC_PREFER_FULL |
238 PATHSPEC_SYMLINK_LEADING_PATH |
239 PATHSPEC_PREFIX_ORIGIN,
242 return run_add_interactive(NULL,
243 patch ? "--patch" : NULL,
247 static int edit_patch(int argc, const char **argv, const char *prefix)
249 char *file = git_pathdup("ADD_EDIT.patch");
250 const char *apply_argv[] = { "apply", "--recount", "--cached",
252 struct child_process child = CHILD_PROCESS_INIT;
257 apply_argv[3] = file;
259 git_config(git_diff_basic_config, NULL); /* no "diff" UI options */
261 if (read_cache() < 0)
262 die(_("Could not read the index"));
264 repo_init_revisions(the_repository, &rev, prefix);
265 rev.diffopt.context = 7;
267 argc = setup_revisions(argc, argv, &rev, NULL);
268 rev.diffopt.output_format = DIFF_FORMAT_PATCH;
269 rev.diffopt.use_color = 0;
270 rev.diffopt.flags.ignore_dirty_submodules = 1;
271 out = open(file, O_CREAT | O_WRONLY | O_TRUNC, 0666);
273 die(_("Could not open '%s' for writing."), file);
274 rev.diffopt.file = xfdopen(out, "w");
275 rev.diffopt.close_file = 1;
276 if (run_diff_files(&rev, 0))
277 die(_("Could not write patch"));
279 if (launch_editor(file, NULL, NULL))
280 die(_("editing patch failed"));
283 die_errno(_("Could not stat '%s'"), file);
285 die(_("Empty patch. Aborted."));
288 child.argv = apply_argv;
289 if (run_command(&child))
290 die(_("Could not apply '%s'"), file);
297 static const char ignore_error[] =
298 N_("The following paths are ignored by one of your .gitignore files:\n");
300 static int verbose, show_only, ignored_too, refresh_only;
301 static int ignore_add_errors, intent_to_add, ignore_missing;
302 static int warn_on_embedded_repo = 1;
304 #define ADDREMOVE_DEFAULT 1
305 static int addremove = ADDREMOVE_DEFAULT;
306 static int addremove_explicit = -1; /* unspecified */
308 static char *chmod_arg;
310 static int ignore_removal_cb(const struct option *opt, const char *arg, int unset)
312 /* if we are told to ignore, we are not adding removals */
313 *(int *)opt->value = !unset ? 0 : 1;
317 static struct option builtin_add_options[] = {
318 OPT__DRY_RUN(&show_only, N_("dry run")),
319 OPT__VERBOSE(&verbose, N_("be verbose")),
321 OPT_BOOL('i', "interactive", &add_interactive, N_("interactive picking")),
322 OPT_BOOL('p', "patch", &patch_interactive, N_("select hunks interactively")),
323 OPT_BOOL('e', "edit", &edit_interactive, N_("edit current diff and apply")),
324 OPT__FORCE(&ignored_too, N_("allow adding otherwise ignored files"), 0),
325 OPT_BOOL('u', "update", &take_worktree_changes, N_("update tracked files")),
326 OPT_BOOL(0, "renormalize", &add_renormalize, N_("renormalize EOL of tracked files (implies -u)")),
327 OPT_BOOL('N', "intent-to-add", &intent_to_add, N_("record only the fact that the path will be added later")),
328 OPT_BOOL('A', "all", &addremove_explicit, N_("add changes from all tracked and untracked files")),
329 { OPTION_CALLBACK, 0, "ignore-removal", &addremove_explicit,
330 NULL /* takes no arguments */,
331 N_("ignore paths removed in the working tree (same as --no-all)"),
332 PARSE_OPT_NOARG, ignore_removal_cb },
333 OPT_BOOL( 0 , "refresh", &refresh_only, N_("don't add, only refresh the index")),
334 OPT_BOOL( 0 , "ignore-errors", &ignore_add_errors, N_("just skip files which cannot be added because of errors")),
335 OPT_BOOL( 0 , "ignore-missing", &ignore_missing, N_("check if - even missing - files are ignored in dry run")),
336 OPT_STRING(0, "chmod", &chmod_arg, "(+|-)x",
337 N_("override the executable bit of the listed files")),
338 OPT_HIDDEN_BOOL(0, "warn-embedded-repo", &warn_on_embedded_repo,
339 N_("warn when adding an embedded repository")),
340 OPT_HIDDEN_BOOL(0, "legacy-stash-p", &legacy_stash_p,
341 N_("backend for `git stash -p`")),
345 static int add_config(const char *var, const char *value, void *cb)
347 if (!strcmp(var, "add.ignoreerrors") ||
348 !strcmp(var, "add.ignore-errors")) {
349 ignore_add_errors = git_config_bool(var, value);
353 return git_default_config(var, value, cb);
356 static const char embedded_advice[] = N_(
357 "You've added another git repository inside your current repository.\n"
358 "Clones of the outer repository will not contain the contents of\n"
359 "the embedded repository and will not know how to obtain it.\n"
360 "If you meant to add a submodule, use:\n"
362 " git submodule add <url> %s\n"
364 "If you added this path by mistake, you can remove it from the\n"
367 " git rm --cached %s\n"
369 "See \"git help submodule\" for more information."
372 static void check_embedded_repo(const char *path)
374 struct strbuf name = STRBUF_INIT;
376 if (!warn_on_embedded_repo)
378 if (!ends_with(path, "/"))
381 /* Drop trailing slash for aesthetics */
382 strbuf_addstr(&name, path);
383 strbuf_strip_suffix(&name, "/");
385 warning(_("adding embedded git repository: %s"), name.buf);
386 if (advice_add_embedded_repo) {
387 advise(embedded_advice, name.buf, name.buf);
388 /* there may be multiple entries; advise only once */
389 advice_add_embedded_repo = 0;
392 strbuf_release(&name);
395 static int add_files(struct dir_struct *dir, int flags)
397 int i, exit_status = 0;
399 if (dir->ignored_nr) {
400 fprintf(stderr, _(ignore_error));
401 for (i = 0; i < dir->ignored_nr; i++)
402 fprintf(stderr, "%s\n", dir->ignored[i]->name);
403 fprintf(stderr, _("Use -f if you really want to add them.\n"));
407 for (i = 0; i < dir->nr; i++) {
408 if (add_file_to_index(&the_index, dir->entries[i]->name, flags)) {
409 if (!ignore_add_errors)
410 die(_("adding files failed"));
413 check_embedded_repo(dir->entries[i]->name);
419 int cmd_add(int argc, const char **argv, const char *prefix)
422 struct pathspec pathspec;
423 struct dir_struct dir;
426 int require_pathspec;
428 struct lock_file lock_file = LOCK_INIT;
430 git_config(add_config, NULL);
432 argc = parse_options(argc, argv, prefix, builtin_add_options,
433 builtin_add_usage, PARSE_OPT_KEEP_ARGV0);
434 if (patch_interactive)
437 exit(interactive_add(argc - 1, argv + 1, prefix, patch_interactive));
438 if (legacy_stash_p) {
439 struct pathspec pathspec;
441 parse_pathspec(&pathspec, 0,
442 PATHSPEC_PREFER_FULL |
443 PATHSPEC_SYMLINK_LEADING_PATH |
444 PATHSPEC_PREFIX_ORIGIN,
447 return run_add_interactive(NULL, "--patch=stash", &pathspec);
450 if (edit_interactive)
451 return(edit_patch(argc, argv, prefix));
455 if (0 <= addremove_explicit)
456 addremove = addremove_explicit;
457 else if (take_worktree_changes && ADDREMOVE_DEFAULT)
458 addremove = 0; /* "-u" was given but not "-A" */
460 if (addremove && take_worktree_changes)
461 die(_("-A and -u are mutually incompatible"));
463 if (!take_worktree_changes && addremove_explicit < 0 && argc)
464 /* Turn "git add pathspec..." to "git add -A pathspec..." */
467 if (!show_only && ignore_missing)
468 die(_("Option --ignore-missing can only be used together with --dry-run"));
470 if (chmod_arg && ((chmod_arg[0] != '-' && chmod_arg[0] != '+') ||
471 chmod_arg[1] != 'x' || chmod_arg[2]))
472 die(_("--chmod param '%s' must be either -x or +x"), chmod_arg);
474 add_new_files = !take_worktree_changes && !refresh_only && !add_renormalize;
475 require_pathspec = !(take_worktree_changes || (0 < addremove_explicit));
477 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
479 flags = ((verbose ? ADD_CACHE_VERBOSE : 0) |
480 (show_only ? ADD_CACHE_PRETEND : 0) |
481 (intent_to_add ? ADD_CACHE_INTENT : 0) |
482 (ignore_add_errors ? ADD_CACHE_IGNORE_ERRORS : 0) |
483 (!(addremove || take_worktree_changes)
484 ? ADD_CACHE_IGNORE_REMOVAL : 0));
486 if (require_pathspec && argc == 0) {
487 fprintf(stderr, _("Nothing specified, nothing added.\n"));
488 fprintf(stderr, _("Maybe you wanted to say 'git add .'?\n"));
493 * Check the "pathspec '%s' did not match any files" block
494 * below before enabling new magic.
496 parse_pathspec(&pathspec, PATHSPEC_ATTR,
497 PATHSPEC_PREFER_FULL |
498 PATHSPEC_SYMLINK_LEADING_PATH,
501 if (read_cache_preload(&pathspec) < 0)
502 die(_("index file corrupt"));
504 die_in_unpopulated_submodule(&the_index, prefix);
505 die_path_inside_submodule(&the_index, &pathspec);
510 /* Set up the default git porcelain excludes */
511 memset(&dir, 0, sizeof(dir));
513 dir.flags |= DIR_COLLECT_IGNORED;
514 setup_standard_excludes(&dir);
517 /* This picks up the paths that are not tracked */
518 baselen = fill_directory(&dir, &the_index, &pathspec);
520 seen = prune_directory(&dir, &pathspec, baselen);
524 refresh(verbose, &pathspec);
532 seen = find_pathspecs_matching_against_index(&pathspec, &the_index);
535 * file_exists() assumes exact match
537 GUARD_PATHSPEC(&pathspec,
544 for (i = 0; i < pathspec.nr; i++) {
545 const char *path = pathspec.items[i].match;
546 if (pathspec.items[i].magic & PATHSPEC_EXCLUDE)
548 if (!seen[i] && path[0] &&
549 ((pathspec.items[i].magic &
550 (PATHSPEC_GLOB | PATHSPEC_ICASE)) ||
551 !file_exists(path))) {
552 if (ignore_missing) {
553 int dtype = DT_UNKNOWN;
554 if (is_excluded(&dir, &the_index, path, &dtype))
555 dir_add_ignored(&dir, &the_index,
556 path, pathspec.items[i].len);
558 die(_("pathspec '%s' did not match any files"),
559 pathspec.items[i].original);
568 exit_status |= renormalize_tracked_files(&pathspec, flags);
570 exit_status |= add_files_to_cache(prefix, &pathspec, flags);
573 exit_status |= add_files(&dir, flags);
575 if (chmod_arg && pathspec.nr)
576 chmod_pathspec(&pathspec, chmod_arg[0]);
577 unplug_bulk_checkin();
580 if (write_locked_index(&the_index, &lock_file,
581 COMMIT_LOCK | SKIP_IF_UNCHANGED))
582 die(_("Unable to write new index file"));