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"
24 static const char * const builtin_add_usage[] = {
25 N_("git add [<options>] [--] <pathspec>..."),
28 static int patch_interactive, add_interactive, edit_interactive;
29 static int take_worktree_changes;
30 static int add_renormalize;
32 struct update_callback_data {
37 static void chmod_pathspec(struct pathspec *pathspec, char flip)
41 for (i = 0; i < active_nr; i++) {
42 struct cache_entry *ce = active_cache[i];
44 if (pathspec && !ce_path_match(&the_index, ce, pathspec, NULL))
47 if (chmod_cache_entry(ce, flip) < 0)
48 fprintf(stderr, "cannot chmod %cx '%s'\n", flip, ce->name);
52 static int fix_unmerged_status(struct diff_filepair *p,
53 struct update_callback_data *data)
55 if (p->status != DIFF_STATUS_UNMERGED)
57 if (!(data->flags & ADD_CACHE_IGNORE_REMOVAL) && !p->two->mode)
59 * This is not an explicit add request, and the
60 * path is missing from the working tree (deleted)
62 return DIFF_STATUS_DELETED;
65 * Either an explicit add request, or path exists
66 * in the working tree. An attempt to explicitly
67 * add a path that does not exist in the working tree
68 * will be caught as an error by the caller immediately.
70 return DIFF_STATUS_MODIFIED;
73 static void update_callback(struct diff_queue_struct *q,
74 struct diff_options *opt, void *cbdata)
77 struct update_callback_data *data = cbdata;
79 for (i = 0; i < q->nr; i++) {
80 struct diff_filepair *p = q->queue[i];
81 const char *path = p->one->path;
82 switch (fix_unmerged_status(p, data)) {
84 die(_("unexpected diff status %c"), p->status);
85 case DIFF_STATUS_MODIFIED:
86 case DIFF_STATUS_TYPE_CHANGED:
87 if (add_file_to_index(&the_index, path, data->flags)) {
88 if (!(data->flags & ADD_CACHE_IGNORE_ERRORS))
89 die(_("updating files failed"));
93 case DIFF_STATUS_DELETED:
94 if (data->flags & ADD_CACHE_IGNORE_REMOVAL)
96 if (!(data->flags & ADD_CACHE_PRETEND))
97 remove_file_from_index(&the_index, path);
98 if (data->flags & (ADD_CACHE_PRETEND|ADD_CACHE_VERBOSE))
99 printf(_("remove '%s'\n"), path);
105 int add_files_to_cache(const char *prefix,
106 const struct pathspec *pathspec, int flags)
108 struct update_callback_data data;
111 memset(&data, 0, sizeof(data));
114 repo_init_revisions(the_repository, &rev, prefix);
115 setup_revisions(0, NULL, &rev, NULL);
117 copy_pathspec(&rev.prune_data, pathspec);
118 rev.diffopt.output_format = DIFF_FORMAT_CALLBACK;
119 rev.diffopt.format_callback = update_callback;
120 rev.diffopt.format_callback_data = &data;
121 rev.diffopt.flags.override_submodule_config = 1;
122 rev.max_count = 0; /* do not compare unmerged paths with stage #2 */
123 run_diff_files(&rev, DIFF_RACY_IS_MODIFIED);
124 clear_pathspec(&rev.prune_data);
125 return !!data.add_errors;
128 static int renormalize_tracked_files(const struct pathspec *pathspec, int flags)
132 for (i = 0; i < active_nr; i++) {
133 struct cache_entry *ce = active_cache[i];
136 continue; /* do not touch unmerged paths */
137 if (!S_ISREG(ce->ce_mode) && !S_ISLNK(ce->ce_mode))
138 continue; /* do not touch non blobs */
139 if (pathspec && !ce_path_match(&the_index, ce, pathspec, NULL))
141 retval |= add_file_to_cache(ce->name, flags | ADD_CACHE_RENORMALIZE);
147 static char *prune_directory(struct dir_struct *dir, struct pathspec *pathspec, int prefix)
151 struct dir_entry **src, **dst;
153 seen = xcalloc(pathspec->nr, 1);
155 src = dst = dir->entries;
158 struct dir_entry *entry = *src++;
159 if (dir_path_match(&the_index, entry, pathspec, prefix, seen))
162 dir->nr = dst - dir->entries;
163 add_pathspec_matches_against_index(pathspec, &the_index, seen);
167 static void refresh(int verbose, const struct pathspec *pathspec)
172 seen = xcalloc(pathspec->nr, 1);
173 refresh_index(&the_index, verbose ? REFRESH_IN_PORCELAIN : REFRESH_QUIET,
174 pathspec, seen, _("Unstaged changes after refreshing the index:"));
175 for (i = 0; i < pathspec->nr; i++) {
177 die(_("pathspec '%s' did not match any files"),
178 pathspec->items[i].match);
183 int run_add_interactive(const char *revision, const char *patch_mode,
184 const struct pathspec *pathspec)
187 struct argv_array argv = ARGV_ARRAY_INIT;
189 argv_array_push(&argv, "add--interactive");
191 argv_array_push(&argv, patch_mode);
193 argv_array_push(&argv, revision);
194 argv_array_push(&argv, "--");
195 for (i = 0; i < pathspec->nr; i++)
196 /* pass original pathspec, to be re-parsed */
197 argv_array_push(&argv, pathspec->items[i].original);
199 status = run_command_v_opt(argv.argv, RUN_GIT_CMD);
200 argv_array_clear(&argv);
204 int interactive_add(int argc, const char **argv, const char *prefix, int patch)
206 struct pathspec pathspec;
208 parse_pathspec(&pathspec, 0,
209 PATHSPEC_PREFER_FULL |
210 PATHSPEC_SYMLINK_LEADING_PATH |
211 PATHSPEC_PREFIX_ORIGIN,
214 return run_add_interactive(NULL,
215 patch ? "--patch" : NULL,
219 static int edit_patch(int argc, const char **argv, const char *prefix)
221 char *file = git_pathdup("ADD_EDIT.patch");
222 const char *apply_argv[] = { "apply", "--recount", "--cached",
224 struct child_process child = CHILD_PROCESS_INIT;
229 apply_argv[3] = file;
231 git_config(git_diff_basic_config, NULL); /* no "diff" UI options */
233 if (read_cache() < 0)
234 die(_("Could not read the index"));
236 repo_init_revisions(the_repository, &rev, prefix);
237 rev.diffopt.context = 7;
239 argc = setup_revisions(argc, argv, &rev, NULL);
240 rev.diffopt.output_format = DIFF_FORMAT_PATCH;
241 rev.diffopt.use_color = 0;
242 rev.diffopt.flags.ignore_dirty_submodules = 1;
243 out = open(file, O_CREAT | O_WRONLY | O_TRUNC, 0666);
245 die(_("Could not open '%s' for writing."), file);
246 rev.diffopt.file = xfdopen(out, "w");
247 rev.diffopt.close_file = 1;
248 if (run_diff_files(&rev, 0))
249 die(_("Could not write patch"));
251 if (launch_editor(file, NULL, NULL))
252 die(_("editing patch failed"));
255 die_errno(_("Could not stat '%s'"), file);
257 die(_("Empty patch. Aborted."));
260 child.argv = apply_argv;
261 if (run_command(&child))
262 die(_("Could not apply '%s'"), file);
269 static const char ignore_error[] =
270 N_("The following paths are ignored by one of your .gitignore files:\n");
272 static int verbose, show_only, ignored_too, refresh_only;
273 static int ignore_add_errors, intent_to_add, ignore_missing;
274 static int warn_on_embedded_repo = 1;
276 #define ADDREMOVE_DEFAULT 1
277 static int addremove = ADDREMOVE_DEFAULT;
278 static int addremove_explicit = -1; /* unspecified */
280 static char *chmod_arg;
282 static int ignore_removal_cb(const struct option *opt, const char *arg, int unset)
284 /* if we are told to ignore, we are not adding removals */
285 *(int *)opt->value = !unset ? 0 : 1;
289 static struct option builtin_add_options[] = {
290 OPT__DRY_RUN(&show_only, N_("dry run")),
291 OPT__VERBOSE(&verbose, N_("be verbose")),
293 OPT_BOOL('i', "interactive", &add_interactive, N_("interactive picking")),
294 OPT_BOOL('p', "patch", &patch_interactive, N_("select hunks interactively")),
295 OPT_BOOL('e', "edit", &edit_interactive, N_("edit current diff and apply")),
296 OPT__FORCE(&ignored_too, N_("allow adding otherwise ignored files"), 0),
297 OPT_BOOL('u', "update", &take_worktree_changes, N_("update tracked files")),
298 OPT_BOOL(0, "renormalize", &add_renormalize, N_("renormalize EOL of tracked files (implies -u)")),
299 OPT_BOOL('N', "intent-to-add", &intent_to_add, N_("record only the fact that the path will be added later")),
300 OPT_BOOL('A', "all", &addremove_explicit, N_("add changes from all tracked and untracked files")),
301 { OPTION_CALLBACK, 0, "ignore-removal", &addremove_explicit,
302 NULL /* takes no arguments */,
303 N_("ignore paths removed in the working tree (same as --no-all)"),
304 PARSE_OPT_NOARG, ignore_removal_cb },
305 OPT_BOOL( 0 , "refresh", &refresh_only, N_("don't add, only refresh the index")),
306 OPT_BOOL( 0 , "ignore-errors", &ignore_add_errors, N_("just skip files which cannot be added because of errors")),
307 OPT_BOOL( 0 , "ignore-missing", &ignore_missing, N_("check if - even missing - files are ignored in dry run")),
308 OPT_STRING(0, "chmod", &chmod_arg, "(+|-)x",
309 N_("override the executable bit of the listed files")),
310 OPT_HIDDEN_BOOL(0, "warn-embedded-repo", &warn_on_embedded_repo,
311 N_("warn when adding an embedded repository")),
315 static int add_config(const char *var, const char *value, void *cb)
317 if (!strcmp(var, "add.ignoreerrors") ||
318 !strcmp(var, "add.ignore-errors")) {
319 ignore_add_errors = git_config_bool(var, value);
322 return git_default_config(var, value, cb);
325 static const char embedded_advice[] = N_(
326 "You've added another git repository inside your current repository.\n"
327 "Clones of the outer repository will not contain the contents of\n"
328 "the embedded repository and will not know how to obtain it.\n"
329 "If you meant to add a submodule, use:\n"
331 " git submodule add <url> %s\n"
333 "If you added this path by mistake, you can remove it from the\n"
336 " git rm --cached %s\n"
338 "See \"git help submodule\" for more information."
341 static void check_embedded_repo(const char *path)
343 struct strbuf name = STRBUF_INIT;
345 if (!warn_on_embedded_repo)
347 if (!ends_with(path, "/"))
350 /* Drop trailing slash for aesthetics */
351 strbuf_addstr(&name, path);
352 strbuf_strip_suffix(&name, "/");
354 warning(_("adding embedded git repository: %s"), name.buf);
355 if (advice_add_embedded_repo) {
356 advise(embedded_advice, name.buf, name.buf);
357 /* there may be multiple entries; advise only once */
358 advice_add_embedded_repo = 0;
361 strbuf_release(&name);
364 static int add_files(struct dir_struct *dir, int flags)
366 int i, exit_status = 0;
368 if (dir->ignored_nr) {
369 fprintf(stderr, _(ignore_error));
370 for (i = 0; i < dir->ignored_nr; i++)
371 fprintf(stderr, "%s\n", dir->ignored[i]->name);
372 fprintf(stderr, _("Use -f if you really want to add them.\n"));
376 for (i = 0; i < dir->nr; i++) {
377 check_embedded_repo(dir->entries[i]->name);
378 if (add_file_to_index(&the_index, dir->entries[i]->name, flags)) {
379 if (!ignore_add_errors)
380 die(_("adding files failed"));
387 int cmd_add(int argc, const char **argv, const char *prefix)
390 struct pathspec pathspec;
391 struct dir_struct dir;
394 int require_pathspec;
396 struct lock_file lock_file = LOCK_INIT;
398 git_config(add_config, NULL);
400 argc = parse_options(argc, argv, prefix, builtin_add_options,
401 builtin_add_usage, PARSE_OPT_KEEP_ARGV0);
402 if (patch_interactive)
405 exit(interactive_add(argc - 1, argv + 1, prefix, patch_interactive));
407 if (edit_interactive)
408 return(edit_patch(argc, argv, prefix));
412 if (0 <= addremove_explicit)
413 addremove = addremove_explicit;
414 else if (take_worktree_changes && ADDREMOVE_DEFAULT)
415 addremove = 0; /* "-u" was given but not "-A" */
417 if (addremove && take_worktree_changes)
418 die(_("-A and -u are mutually incompatible"));
420 if (!take_worktree_changes && addremove_explicit < 0 && argc)
421 /* Turn "git add pathspec..." to "git add -A pathspec..." */
424 if (!show_only && ignore_missing)
425 die(_("Option --ignore-missing can only be used together with --dry-run"));
427 if (chmod_arg && ((chmod_arg[0] != '-' && chmod_arg[0] != '+') ||
428 chmod_arg[1] != 'x' || chmod_arg[2]))
429 die(_("--chmod param '%s' must be either -x or +x"), chmod_arg);
431 add_new_files = !take_worktree_changes && !refresh_only && !add_renormalize;
432 require_pathspec = !(take_worktree_changes || (0 < addremove_explicit));
434 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
436 flags = ((verbose ? ADD_CACHE_VERBOSE : 0) |
437 (show_only ? ADD_CACHE_PRETEND : 0) |
438 (intent_to_add ? ADD_CACHE_INTENT : 0) |
439 (ignore_add_errors ? ADD_CACHE_IGNORE_ERRORS : 0) |
440 (!(addremove || take_worktree_changes)
441 ? ADD_CACHE_IGNORE_REMOVAL : 0));
443 if (require_pathspec && argc == 0) {
444 fprintf(stderr, _("Nothing specified, nothing added.\n"));
445 fprintf(stderr, _("Maybe you wanted to say 'git add .'?\n"));
450 * Check the "pathspec '%s' did not match any files" block
451 * below before enabling new magic.
453 parse_pathspec(&pathspec, PATHSPEC_ATTR,
454 PATHSPEC_PREFER_FULL |
455 PATHSPEC_SYMLINK_LEADING_PATH,
458 if (read_cache_preload(&pathspec) < 0)
459 die(_("index file corrupt"));
461 die_in_unpopulated_submodule(&the_index, prefix);
462 die_path_inside_submodule(&the_index, &pathspec);
467 /* Set up the default git porcelain excludes */
468 memset(&dir, 0, sizeof(dir));
470 dir.flags |= DIR_COLLECT_IGNORED;
471 setup_standard_excludes(&dir);
474 /* This picks up the paths that are not tracked */
475 baselen = fill_directory(&dir, &the_index, &pathspec);
477 seen = prune_directory(&dir, &pathspec, baselen);
481 refresh(verbose, &pathspec);
489 seen = find_pathspecs_matching_against_index(&pathspec, &the_index);
492 * file_exists() assumes exact match
494 GUARD_PATHSPEC(&pathspec,
501 for (i = 0; i < pathspec.nr; i++) {
502 const char *path = pathspec.items[i].match;
503 if (pathspec.items[i].magic & PATHSPEC_EXCLUDE)
505 if (!seen[i] && path[0] &&
506 ((pathspec.items[i].magic &
507 (PATHSPEC_GLOB | PATHSPEC_ICASE)) ||
508 !file_exists(path))) {
509 if (ignore_missing) {
510 int dtype = DT_UNKNOWN;
511 if (is_excluded(&dir, &the_index, path, &dtype))
512 dir_add_ignored(&dir, &the_index,
513 path, pathspec.items[i].len);
515 die(_("pathspec '%s' did not match any files"),
516 pathspec.items[i].original);
525 exit_status |= renormalize_tracked_files(&pathspec, flags);
527 exit_status |= add_files_to_cache(prefix, &pathspec, flags);
530 exit_status |= add_files(&dir, flags);
532 if (chmod_arg && pathspec.nr)
533 chmod_pathspec(&pathspec, chmod_arg[0]);
534 unplug_bulk_checkin();
537 if (write_locked_index(&the_index, &lock_file,
538 COMMIT_LOCK | SKIP_IF_UNCHANGED))
539 die(_("Unable to write new index file"));