standardize usage info string format
[git/debian.git] / builtin / add.c
blob3390933d68b2dd6c7296a7d2103d009fa27f2ca8
1 /*
2 * "git add" builtin command
4 * Copyright (C) 2006 Linus Torvalds
5 */
6 #include "cache.h"
7 #include "builtin.h"
8 #include "lockfile.h"
9 #include "dir.h"
10 #include "pathspec.h"
11 #include "exec_cmd.h"
12 #include "cache-tree.h"
13 #include "run-command.h"
14 #include "parse-options.h"
15 #include "diff.h"
16 #include "diffcore.h"
17 #include "revision.h"
18 #include "bulk-checkin.h"
19 #include "argv-array.h"
21 static const char * const builtin_add_usage[] = {
22 N_("git add [<options>] [--] <pathspec>..."),
23 NULL
25 static int patch_interactive, add_interactive, edit_interactive;
26 static int take_worktree_changes;
28 struct update_callback_data {
29 int flags;
30 int add_errors;
33 static int fix_unmerged_status(struct diff_filepair *p,
34 struct update_callback_data *data)
36 if (p->status != DIFF_STATUS_UNMERGED)
37 return p->status;
38 if (!(data->flags & ADD_CACHE_IGNORE_REMOVAL) && !p->two->mode)
40 * This is not an explicit add request, and the
41 * path is missing from the working tree (deleted)
43 return DIFF_STATUS_DELETED;
44 else
46 * Either an explicit add request, or path exists
47 * in the working tree. An attempt to explicitly
48 * add a path that does not exist in the working tree
49 * will be caught as an error by the caller immediately.
51 return DIFF_STATUS_MODIFIED;
54 static void update_callback(struct diff_queue_struct *q,
55 struct diff_options *opt, void *cbdata)
57 int i;
58 struct update_callback_data *data = cbdata;
60 for (i = 0; i < q->nr; i++) {
61 struct diff_filepair *p = q->queue[i];
62 const char *path = p->one->path;
63 switch (fix_unmerged_status(p, data)) {
64 default:
65 die(_("unexpected diff status %c"), p->status);
66 case DIFF_STATUS_MODIFIED:
67 case DIFF_STATUS_TYPE_CHANGED:
68 if (add_file_to_index(&the_index, path, data->flags)) {
69 if (!(data->flags & ADD_CACHE_IGNORE_ERRORS))
70 die(_("updating files failed"));
71 data->add_errors++;
73 break;
74 case DIFF_STATUS_DELETED:
75 if (data->flags & ADD_CACHE_IGNORE_REMOVAL)
76 break;
77 if (!(data->flags & ADD_CACHE_PRETEND))
78 remove_file_from_index(&the_index, path);
79 if (data->flags & (ADD_CACHE_PRETEND|ADD_CACHE_VERBOSE))
80 printf(_("remove '%s'\n"), path);
81 break;
86 int add_files_to_cache(const char *prefix,
87 const struct pathspec *pathspec, int flags)
89 struct update_callback_data data;
90 struct rev_info rev;
92 memset(&data, 0, sizeof(data));
93 data.flags = flags;
95 init_revisions(&rev, prefix);
96 setup_revisions(0, NULL, &rev, NULL);
97 if (pathspec)
98 copy_pathspec(&rev.prune_data, pathspec);
99 rev.diffopt.output_format = DIFF_FORMAT_CALLBACK;
100 rev.diffopt.format_callback = update_callback;
101 rev.diffopt.format_callback_data = &data;
102 rev.max_count = 0; /* do not compare unmerged paths with stage #2 */
103 run_diff_files(&rev, DIFF_RACY_IS_MODIFIED);
104 return !!data.add_errors;
107 static char *prune_directory(struct dir_struct *dir, struct pathspec *pathspec, int prefix)
109 char *seen;
110 int i;
111 struct dir_entry **src, **dst;
113 seen = xcalloc(pathspec->nr, 1);
115 src = dst = dir->entries;
116 i = dir->nr;
117 while (--i >= 0) {
118 struct dir_entry *entry = *src++;
119 if (dir_path_match(entry, pathspec, prefix, seen))
120 *dst++ = entry;
122 dir->nr = dst - dir->entries;
123 add_pathspec_matches_against_index(pathspec, seen);
124 return seen;
127 static void refresh(int verbose, const struct pathspec *pathspec)
129 char *seen;
130 int i;
132 seen = xcalloc(pathspec->nr, 1);
133 refresh_index(&the_index, verbose ? REFRESH_IN_PORCELAIN : REFRESH_QUIET,
134 pathspec, seen, _("Unstaged changes after refreshing the index:"));
135 for (i = 0; i < pathspec->nr; i++) {
136 if (!seen[i])
137 die(_("pathspec '%s' did not match any files"),
138 pathspec->items[i].match);
140 free(seen);
143 int run_add_interactive(const char *revision, const char *patch_mode,
144 const struct pathspec *pathspec)
146 int status, i;
147 struct argv_array argv = ARGV_ARRAY_INIT;
149 argv_array_push(&argv, "add--interactive");
150 if (patch_mode)
151 argv_array_push(&argv, patch_mode);
152 if (revision)
153 argv_array_push(&argv, revision);
154 argv_array_push(&argv, "--");
155 for (i = 0; i < pathspec->nr; i++)
156 /* pass original pathspec, to be re-parsed */
157 argv_array_push(&argv, pathspec->items[i].original);
159 status = run_command_v_opt(argv.argv, RUN_GIT_CMD);
160 argv_array_clear(&argv);
161 return status;
164 int interactive_add(int argc, const char **argv, const char *prefix, int patch)
166 struct pathspec pathspec;
168 parse_pathspec(&pathspec, 0,
169 PATHSPEC_PREFER_FULL |
170 PATHSPEC_SYMLINK_LEADING_PATH |
171 PATHSPEC_PREFIX_ORIGIN,
172 prefix, argv);
174 return run_add_interactive(NULL,
175 patch ? "--patch" : NULL,
176 &pathspec);
179 static int edit_patch(int argc, const char **argv, const char *prefix)
181 char *file = git_pathdup("ADD_EDIT.patch");
182 const char *apply_argv[] = { "apply", "--recount", "--cached",
183 NULL, NULL };
184 struct child_process child = CHILD_PROCESS_INIT;
185 struct rev_info rev;
186 int out;
187 struct stat st;
189 apply_argv[3] = file;
191 git_config(git_diff_basic_config, NULL); /* no "diff" UI options */
193 if (read_cache() < 0)
194 die(_("Could not read the index"));
196 init_revisions(&rev, prefix);
197 rev.diffopt.context = 7;
199 argc = setup_revisions(argc, argv, &rev, NULL);
200 rev.diffopt.output_format = DIFF_FORMAT_PATCH;
201 rev.diffopt.use_color = 0;
202 DIFF_OPT_SET(&rev.diffopt, IGNORE_DIRTY_SUBMODULES);
203 out = open(file, O_CREAT | O_WRONLY, 0666);
204 if (out < 0)
205 die(_("Could not open '%s' for writing."), file);
206 rev.diffopt.file = xfdopen(out, "w");
207 rev.diffopt.close_file = 1;
208 if (run_diff_files(&rev, 0))
209 die(_("Could not write patch"));
211 launch_editor(file, NULL, NULL);
213 if (stat(file, &st))
214 die_errno(_("Could not stat '%s'"), file);
215 if (!st.st_size)
216 die(_("Empty patch. Aborted."));
218 child.git_cmd = 1;
219 child.argv = apply_argv;
220 if (run_command(&child))
221 die(_("Could not apply '%s'"), file);
223 unlink(file);
224 free(file);
225 return 0;
228 static struct lock_file lock_file;
230 static const char ignore_error[] =
231 N_("The following paths are ignored by one of your .gitignore files:\n");
233 static int verbose, show_only, ignored_too, refresh_only;
234 static int ignore_add_errors, intent_to_add, ignore_missing;
236 #define ADDREMOVE_DEFAULT 1
237 static int addremove = ADDREMOVE_DEFAULT;
238 static int addremove_explicit = -1; /* unspecified */
240 static int ignore_removal_cb(const struct option *opt, const char *arg, int unset)
242 /* if we are told to ignore, we are not adding removals */
243 *(int *)opt->value = !unset ? 0 : 1;
244 return 0;
247 static struct option builtin_add_options[] = {
248 OPT__DRY_RUN(&show_only, N_("dry run")),
249 OPT__VERBOSE(&verbose, N_("be verbose")),
250 OPT_GROUP(""),
251 OPT_BOOL('i', "interactive", &add_interactive, N_("interactive picking")),
252 OPT_BOOL('p', "patch", &patch_interactive, N_("select hunks interactively")),
253 OPT_BOOL('e', "edit", &edit_interactive, N_("edit current diff and apply")),
254 OPT__FORCE(&ignored_too, N_("allow adding otherwise ignored files")),
255 OPT_BOOL('u', "update", &take_worktree_changes, N_("update tracked files")),
256 OPT_BOOL('N', "intent-to-add", &intent_to_add, N_("record only the fact that the path will be added later")),
257 OPT_BOOL('A', "all", &addremove_explicit, N_("add changes from all tracked and untracked files")),
258 { OPTION_CALLBACK, 0, "ignore-removal", &addremove_explicit,
259 NULL /* takes no arguments */,
260 N_("ignore paths removed in the working tree (same as --no-all)"),
261 PARSE_OPT_NOARG, ignore_removal_cb },
262 OPT_BOOL( 0 , "refresh", &refresh_only, N_("don't add, only refresh the index")),
263 OPT_BOOL( 0 , "ignore-errors", &ignore_add_errors, N_("just skip files which cannot be added because of errors")),
264 OPT_BOOL( 0 , "ignore-missing", &ignore_missing, N_("check if - even missing - files are ignored in dry run")),
265 OPT_END(),
268 static int add_config(const char *var, const char *value, void *cb)
270 if (!strcmp(var, "add.ignoreerrors") ||
271 !strcmp(var, "add.ignore-errors")) {
272 ignore_add_errors = git_config_bool(var, value);
273 return 0;
275 return git_default_config(var, value, cb);
278 static int add_files(struct dir_struct *dir, int flags)
280 int i, exit_status = 0;
282 if (dir->ignored_nr) {
283 fprintf(stderr, _(ignore_error));
284 for (i = 0; i < dir->ignored_nr; i++)
285 fprintf(stderr, "%s\n", dir->ignored[i]->name);
286 fprintf(stderr, _("Use -f if you really want to add them.\n"));
287 exit_status = 1;
290 for (i = 0; i < dir->nr; i++)
291 if (add_file_to_cache(dir->entries[i]->name, flags)) {
292 if (!ignore_add_errors)
293 die(_("adding files failed"));
294 exit_status = 1;
296 return exit_status;
299 int cmd_add(int argc, const char **argv, const char *prefix)
301 int exit_status = 0;
302 struct pathspec pathspec;
303 struct dir_struct dir;
304 int flags;
305 int add_new_files;
306 int require_pathspec;
307 char *seen = NULL;
309 git_config(add_config, NULL);
311 argc = parse_options(argc, argv, prefix, builtin_add_options,
312 builtin_add_usage, PARSE_OPT_KEEP_ARGV0);
313 if (patch_interactive)
314 add_interactive = 1;
315 if (add_interactive)
316 exit(interactive_add(argc - 1, argv + 1, prefix, patch_interactive));
318 if (edit_interactive)
319 return(edit_patch(argc, argv, prefix));
320 argc--;
321 argv++;
323 if (0 <= addremove_explicit)
324 addremove = addremove_explicit;
325 else if (take_worktree_changes && ADDREMOVE_DEFAULT)
326 addremove = 0; /* "-u" was given but not "-A" */
328 if (addremove && take_worktree_changes)
329 die(_("-A and -u are mutually incompatible"));
331 if (!take_worktree_changes && addremove_explicit < 0 && argc)
332 /* Turn "git add pathspec..." to "git add -A pathspec..." */
333 addremove = 1;
335 if (!show_only && ignore_missing)
336 die(_("Option --ignore-missing can only be used together with --dry-run"));
338 if ((0 < addremove_explicit || take_worktree_changes) && !argc) {
339 static const char *whole[2] = { ":/", NULL };
340 argc = 1;
341 argv = whole;
344 add_new_files = !take_worktree_changes && !refresh_only;
345 require_pathspec = !take_worktree_changes;
347 hold_locked_index(&lock_file, 1);
349 flags = ((verbose ? ADD_CACHE_VERBOSE : 0) |
350 (show_only ? ADD_CACHE_PRETEND : 0) |
351 (intent_to_add ? ADD_CACHE_INTENT : 0) |
352 (ignore_add_errors ? ADD_CACHE_IGNORE_ERRORS : 0) |
353 (!(addremove || take_worktree_changes)
354 ? ADD_CACHE_IGNORE_REMOVAL : 0));
356 if (require_pathspec && argc == 0) {
357 fprintf(stderr, _("Nothing specified, nothing added.\n"));
358 fprintf(stderr, _("Maybe you wanted to say 'git add .'?\n"));
359 return 0;
362 if (read_cache() < 0)
363 die(_("index file corrupt"));
366 * Check the "pathspec '%s' did not match any files" block
367 * below before enabling new magic.
369 parse_pathspec(&pathspec, 0,
370 PATHSPEC_PREFER_FULL |
371 PATHSPEC_SYMLINK_LEADING_PATH |
372 PATHSPEC_STRIP_SUBMODULE_SLASH_EXPENSIVE,
373 prefix, argv);
375 if (add_new_files) {
376 int baselen;
377 struct pathspec empty_pathspec;
379 /* Set up the default git porcelain excludes */
380 memset(&dir, 0, sizeof(dir));
381 if (!ignored_too) {
382 dir.flags |= DIR_COLLECT_IGNORED;
383 setup_standard_excludes(&dir);
386 memset(&empty_pathspec, 0, sizeof(empty_pathspec));
387 /* This picks up the paths that are not tracked */
388 baselen = fill_directory(&dir, &pathspec);
389 if (pathspec.nr)
390 seen = prune_directory(&dir, &pathspec, baselen);
393 if (refresh_only) {
394 refresh(verbose, &pathspec);
395 goto finish;
398 if (pathspec.nr) {
399 int i;
401 if (!seen)
402 seen = find_pathspecs_matching_against_index(&pathspec);
405 * file_exists() assumes exact match
407 GUARD_PATHSPEC(&pathspec,
408 PATHSPEC_FROMTOP |
409 PATHSPEC_LITERAL |
410 PATHSPEC_GLOB |
411 PATHSPEC_ICASE |
412 PATHSPEC_EXCLUDE);
414 for (i = 0; i < pathspec.nr; i++) {
415 const char *path = pathspec.items[i].match;
416 if (pathspec.items[i].magic & PATHSPEC_EXCLUDE)
417 continue;
418 if (!seen[i] && path[0] &&
419 ((pathspec.items[i].magic &
420 (PATHSPEC_GLOB | PATHSPEC_ICASE)) ||
421 !file_exists(path))) {
422 if (ignore_missing) {
423 int dtype = DT_UNKNOWN;
424 if (is_excluded(&dir, path, &dtype))
425 dir_add_ignored(&dir, path, pathspec.items[i].len);
426 } else
427 die(_("pathspec '%s' did not match any files"),
428 pathspec.items[i].original);
431 free(seen);
434 plug_bulk_checkin();
436 exit_status |= add_files_to_cache(prefix, &pathspec, flags);
438 if (add_new_files)
439 exit_status |= add_files(&dir, flags);
441 unplug_bulk_checkin();
443 finish:
444 if (active_cache_changed) {
445 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
446 die(_("Unable to write new index file"));
449 return exit_status;