Merge branch 'sn/diff-doc'
[git/srabbelier.git] / builtin / add.c
blob21dc1f73395b5f6b1491c235f656bea057092eb1
1 /*
2 * "git add" builtin command
4 * Copyright (C) 2006 Linus Torvalds
5 */
6 #include "cache.h"
7 #include "builtin.h"
8 #include "dir.h"
9 #include "exec_cmd.h"
10 #include "cache-tree.h"
11 #include "run-command.h"
12 #include "parse-options.h"
13 #include "diff.h"
14 #include "diffcore.h"
15 #include "revision.h"
17 static const char * const builtin_add_usage[] = {
18 "git add [options] [--] <filepattern>...",
19 NULL
21 static int patch_interactive, add_interactive, edit_interactive;
22 static int take_worktree_changes;
24 struct update_callback_data
26 int flags;
27 int add_errors;
30 static void update_callback(struct diff_queue_struct *q,
31 struct diff_options *opt, void *cbdata)
33 int i;
34 struct update_callback_data *data = cbdata;
36 for (i = 0; i < q->nr; i++) {
37 struct diff_filepair *p = q->queue[i];
38 const char *path = p->one->path;
39 switch (p->status) {
40 default:
41 die("unexpected diff status %c", p->status);
42 case DIFF_STATUS_UNMERGED:
44 * ADD_CACHE_IGNORE_REMOVAL is unset if "git
45 * add -u" is calling us, In such a case, a
46 * missing work tree file needs to be removed
47 * if there is an unmerged entry at stage #2,
48 * but such a diff record is followed by
49 * another with DIFF_STATUS_DELETED (and if
50 * there is no stage #2, we won't see DELETED
51 * nor MODIFIED). We can simply continue
52 * either way.
54 if (!(data->flags & ADD_CACHE_IGNORE_REMOVAL))
55 continue;
57 * Otherwise, it is "git add path" is asking
58 * to explicitly add it; we fall through. A
59 * missing work tree file is an error and is
60 * caught by add_file_to_index() in such a
61 * case.
63 case DIFF_STATUS_MODIFIED:
64 case DIFF_STATUS_TYPE_CHANGED:
65 if (add_file_to_index(&the_index, path, data->flags)) {
66 if (!(data->flags & ADD_CACHE_IGNORE_ERRORS))
67 die("updating files failed");
68 data->add_errors++;
70 break;
71 case DIFF_STATUS_DELETED:
72 if (data->flags & ADD_CACHE_IGNORE_REMOVAL)
73 break;
74 if (!(data->flags & ADD_CACHE_PRETEND))
75 remove_file_from_index(&the_index, path);
76 if (data->flags & (ADD_CACHE_PRETEND|ADD_CACHE_VERBOSE))
77 printf("remove '%s'\n", path);
78 break;
83 int add_files_to_cache(const char *prefix, const char **pathspec, int flags)
85 struct update_callback_data data;
86 struct rev_info rev;
87 init_revisions(&rev, prefix);
88 setup_revisions(0, NULL, &rev, NULL);
89 rev.prune_data = pathspec;
90 rev.diffopt.output_format = DIFF_FORMAT_CALLBACK;
91 rev.diffopt.format_callback = update_callback;
92 data.flags = flags;
93 data.add_errors = 0;
94 rev.diffopt.format_callback_data = &data;
95 run_diff_files(&rev, DIFF_RACY_IS_MODIFIED);
96 return !!data.add_errors;
99 static void fill_pathspec_matches(const char **pathspec, char *seen, int specs)
101 int num_unmatched = 0, i;
104 * Since we are walking the index as if we were walking the directory,
105 * we have to mark the matched pathspec as seen; otherwise we will
106 * mistakenly think that the user gave a pathspec that did not match
107 * anything.
109 for (i = 0; i < specs; i++)
110 if (!seen[i])
111 num_unmatched++;
112 if (!num_unmatched)
113 return;
114 for (i = 0; i < active_nr; i++) {
115 struct cache_entry *ce = active_cache[i];
116 match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, seen);
120 static char *find_used_pathspec(const char **pathspec)
122 char *seen;
123 int i;
125 for (i = 0; pathspec[i]; i++)
126 ; /* just counting */
127 seen = xcalloc(i, 1);
128 fill_pathspec_matches(pathspec, seen, i);
129 return seen;
132 static char *prune_directory(struct dir_struct *dir, const char **pathspec, int prefix)
134 char *seen;
135 int i, specs;
136 struct dir_entry **src, **dst;
138 for (specs = 0; pathspec[specs]; specs++)
139 /* nothing */;
140 seen = xcalloc(specs, 1);
142 src = dst = dir->entries;
143 i = dir->nr;
144 while (--i >= 0) {
145 struct dir_entry *entry = *src++;
146 if (match_pathspec(pathspec, entry->name, entry->len,
147 prefix, seen))
148 *dst++ = entry;
150 dir->nr = dst - dir->entries;
151 fill_pathspec_matches(pathspec, seen, specs);
152 return seen;
155 static void treat_gitlinks(const char **pathspec)
157 int i;
159 if (!pathspec || !*pathspec)
160 return;
162 for (i = 0; i < active_nr; i++) {
163 struct cache_entry *ce = active_cache[i];
164 if (S_ISGITLINK(ce->ce_mode)) {
165 int len = ce_namelen(ce), j;
166 for (j = 0; pathspec[j]; j++) {
167 int len2 = strlen(pathspec[j]);
168 if (len2 <= len || pathspec[j][len] != '/' ||
169 memcmp(ce->name, pathspec[j], len))
170 continue;
171 if (len2 == len + 1)
172 /* strip trailing slash */
173 pathspec[j] = xstrndup(ce->name, len);
174 else
175 die ("Path '%s' is in submodule '%.*s'",
176 pathspec[j], len, ce->name);
182 static void refresh(int verbose, const char **pathspec)
184 char *seen;
185 int i, specs;
187 for (specs = 0; pathspec[specs]; specs++)
188 /* nothing */;
189 seen = xcalloc(specs, 1);
190 refresh_index(&the_index, verbose ? REFRESH_IN_PORCELAIN : REFRESH_QUIET,
191 pathspec, seen, "Unstaged changes after refreshing the index:");
192 for (i = 0; i < specs; i++) {
193 if (!seen[i])
194 die("pathspec '%s' did not match any files", pathspec[i]);
196 free(seen);
199 static const char **validate_pathspec(int argc, const char **argv, const char *prefix)
201 const char **pathspec = get_pathspec(prefix, argv);
203 if (pathspec) {
204 const char **p;
205 for (p = pathspec; *p; p++) {
206 if (has_symlink_leading_path(*p, strlen(*p))) {
207 int len = prefix ? strlen(prefix) : 0;
208 die("'%s' is beyond a symbolic link", *p + len);
213 return pathspec;
216 int run_add_interactive(const char *revision, const char *patch_mode,
217 const char **pathspec)
219 int status, ac, pc = 0;
220 const char **args;
222 if (pathspec)
223 while (pathspec[pc])
224 pc++;
226 args = xcalloc(sizeof(const char *), (pc + 5));
227 ac = 0;
228 args[ac++] = "add--interactive";
229 if (patch_mode)
230 args[ac++] = patch_mode;
231 if (revision)
232 args[ac++] = revision;
233 args[ac++] = "--";
234 if (pc) {
235 memcpy(&(args[ac]), pathspec, sizeof(const char *) * pc);
236 ac += pc;
238 args[ac] = NULL;
240 status = run_command_v_opt(args, RUN_GIT_CMD);
241 free(args);
242 return status;
245 int interactive_add(int argc, const char **argv, const char *prefix)
247 const char **pathspec = NULL;
249 if (argc) {
250 pathspec = validate_pathspec(argc, argv, prefix);
251 if (!pathspec)
252 return -1;
255 return run_add_interactive(NULL,
256 patch_interactive ? "--patch" : NULL,
257 pathspec);
260 static int edit_patch(int argc, const char **argv, const char *prefix)
262 char *file = xstrdup(git_path("ADD_EDIT.patch"));
263 const char *apply_argv[] = { "apply", "--recount", "--cached",
264 NULL, NULL };
265 struct child_process child;
266 struct rev_info rev;
267 int out;
268 struct stat st;
270 apply_argv[3] = file;
272 git_config(git_diff_basic_config, NULL); /* no "diff" UI options */
274 if (read_cache() < 0)
275 die ("Could not read the index");
277 init_revisions(&rev, prefix);
278 rev.diffopt.context = 7;
280 argc = setup_revisions(argc, argv, &rev, NULL);
281 rev.diffopt.output_format = DIFF_FORMAT_PATCH;
282 out = open(file, O_CREAT | O_WRONLY, 0644);
283 if (out < 0)
284 die ("Could not open '%s' for writing.", file);
285 rev.diffopt.file = xfdopen(out, "w");
286 rev.diffopt.close_file = 1;
287 if (run_diff_files(&rev, 0))
288 die ("Could not write patch");
290 launch_editor(file, NULL, NULL);
292 if (stat(file, &st))
293 die_errno("Could not stat '%s'", file);
294 if (!st.st_size)
295 die("Empty patch. Aborted.");
297 memset(&child, 0, sizeof(child));
298 child.git_cmd = 1;
299 child.argv = apply_argv;
300 if (run_command(&child))
301 die ("Could not apply '%s'", file);
303 unlink(file);
304 return 0;
307 static struct lock_file lock_file;
309 static const char ignore_error[] =
310 "The following paths are ignored by one of your .gitignore files:\n";
312 static int verbose = 0, show_only = 0, ignored_too = 0, refresh_only = 0;
313 static int ignore_add_errors, addremove, intent_to_add, ignore_missing = 0;
315 static struct option builtin_add_options[] = {
316 OPT__DRY_RUN(&show_only, "dry run"),
317 OPT__VERBOSE(&verbose, "be verbose"),
318 OPT_GROUP(""),
319 OPT_BOOLEAN('i', "interactive", &add_interactive, "interactive picking"),
320 OPT_BOOLEAN('p', "patch", &patch_interactive, "interactive patching"),
321 OPT_BOOLEAN('e', "edit", &edit_interactive, "edit current diff and apply"),
322 OPT__FORCE(&ignored_too, "allow adding otherwise ignored files"),
323 OPT_BOOLEAN('u', "update", &take_worktree_changes, "update tracked files"),
324 OPT_BOOLEAN('N', "intent-to-add", &intent_to_add, "record only the fact that the path will be added later"),
325 OPT_BOOLEAN('A', "all", &addremove, "add all, noticing removal of tracked files"),
326 OPT_BOOLEAN( 0 , "refresh", &refresh_only, "don't add, only refresh the index"),
327 OPT_BOOLEAN( 0 , "ignore-errors", &ignore_add_errors, "just skip files which cannot be added because of errors"),
328 OPT_BOOLEAN( 0 , "ignore-missing", &ignore_missing, "check if - even missing - files are ignored in dry run"),
329 OPT_END(),
332 static int add_config(const char *var, const char *value, void *cb)
334 if (!strcasecmp(var, "add.ignoreerrors") ||
335 !strcasecmp(var, "add.ignore-errors")) {
336 ignore_add_errors = git_config_bool(var, value);
337 return 0;
339 return git_default_config(var, value, cb);
342 static int add_files(struct dir_struct *dir, int flags)
344 int i, exit_status = 0;
346 if (dir->ignored_nr) {
347 fprintf(stderr, ignore_error);
348 for (i = 0; i < dir->ignored_nr; i++)
349 fprintf(stderr, "%s\n", dir->ignored[i]->name);
350 fprintf(stderr, "Use -f if you really want to add them.\n");
351 die("no files added");
354 for (i = 0; i < dir->nr; i++)
355 if (add_file_to_cache(dir->entries[i]->name, flags)) {
356 if (!ignore_add_errors)
357 die("adding files failed");
358 exit_status = 1;
360 return exit_status;
363 int cmd_add(int argc, const char **argv, const char *prefix)
365 int exit_status = 0;
366 int newfd;
367 const char **pathspec;
368 struct dir_struct dir;
369 int flags;
370 int add_new_files;
371 int require_pathspec;
372 char *seen = NULL;
374 git_config(add_config, NULL);
376 argc = parse_options(argc, argv, prefix, builtin_add_options,
377 builtin_add_usage, PARSE_OPT_KEEP_ARGV0);
378 if (patch_interactive)
379 add_interactive = 1;
380 if (add_interactive)
381 exit(interactive_add(argc - 1, argv + 1, prefix));
383 if (edit_interactive)
384 return(edit_patch(argc, argv, prefix));
385 argc--;
386 argv++;
388 if (addremove && take_worktree_changes)
389 die("-A and -u are mutually incompatible");
390 if (!show_only && ignore_missing)
391 die("Option --ignore-missing can only be used together with --dry-run");
392 if ((addremove || take_worktree_changes) && !argc) {
393 static const char *here[2] = { ".", NULL };
394 argc = 1;
395 argv = here;
398 add_new_files = !take_worktree_changes && !refresh_only;
399 require_pathspec = !take_worktree_changes;
401 newfd = hold_locked_index(&lock_file, 1);
403 flags = ((verbose ? ADD_CACHE_VERBOSE : 0) |
404 (show_only ? ADD_CACHE_PRETEND : 0) |
405 (intent_to_add ? ADD_CACHE_INTENT : 0) |
406 (ignore_add_errors ? ADD_CACHE_IGNORE_ERRORS : 0) |
407 (!(addremove || take_worktree_changes)
408 ? ADD_CACHE_IGNORE_REMOVAL : 0));
410 if (require_pathspec && argc == 0) {
411 fprintf(stderr, "Nothing specified, nothing added.\n");
412 fprintf(stderr, "Maybe you wanted to say 'git add .'?\n");
413 return 0;
415 pathspec = validate_pathspec(argc, argv, prefix);
417 if (read_cache() < 0)
418 die("index file corrupt");
419 treat_gitlinks(pathspec);
421 if (add_new_files) {
422 int baselen;
424 /* Set up the default git porcelain excludes */
425 memset(&dir, 0, sizeof(dir));
426 if (!ignored_too) {
427 dir.flags |= DIR_COLLECT_IGNORED;
428 setup_standard_excludes(&dir);
431 /* This picks up the paths that are not tracked */
432 baselen = fill_directory(&dir, pathspec);
433 if (pathspec)
434 seen = prune_directory(&dir, pathspec, baselen);
437 if (refresh_only) {
438 refresh(verbose, pathspec);
439 goto finish;
442 if (pathspec) {
443 int i;
444 if (!seen)
445 seen = find_used_pathspec(pathspec);
446 for (i = 0; pathspec[i]; i++) {
447 if (!seen[i] && pathspec[i][0]
448 && !file_exists(pathspec[i])) {
449 if (ignore_missing) {
450 if (excluded(&dir, pathspec[i], DT_UNKNOWN))
451 dir_add_ignored(&dir, pathspec[i], strlen(pathspec[i]));
452 } else
453 die("pathspec '%s' did not match any files",
454 pathspec[i]);
457 free(seen);
460 exit_status |= add_files_to_cache(prefix, pathspec, flags);
462 if (add_new_files)
463 exit_status |= add_files(&dir, flags);
465 finish:
466 if (active_cache_changed) {
467 if (write_cache(newfd, active_cache, active_nr) ||
468 commit_locked_index(&lock_file))
469 die("Unable to write new index file");
472 return exit_status;