Merge branch 'fg/document-commit-message-stripping'
[git] / builtin / add.c
1 /*
2  * "git add" builtin command
3  *
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"
20
21 static const char * const builtin_add_usage[] = {
22         N_("git add [<options>] [--] <pathspec>..."),
23         NULL
24 };
25 static int patch_interactive, add_interactive, edit_interactive;
26 static int take_worktree_changes;
27
28 struct update_callback_data {
29         int flags;
30         int add_errors;
31 };
32
33 static int fix_unmerged_status(struct diff_filepair *p,
34                                struct update_callback_data *data)
35 {
36         if (p->status != DIFF_STATUS_UNMERGED)
37                 return p->status;
38         if (!(data->flags & ADD_CACHE_IGNORE_REMOVAL) && !p->two->mode)
39                 /*
40                  * This is not an explicit add request, and the
41                  * path is missing from the working tree (deleted)
42                  */
43                 return DIFF_STATUS_DELETED;
44         else
45                 /*
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.
50                  */
51                 return DIFF_STATUS_MODIFIED;
52 }
53
54 static void update_callback(struct diff_queue_struct *q,
55                             struct diff_options *opt, void *cbdata)
56 {
57         int i;
58         struct update_callback_data *data = cbdata;
59
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_ADDED:
67                 case DIFF_STATUS_MODIFIED:
68                 case DIFF_STATUS_TYPE_CHANGED:
69                         if (add_file_to_index(&the_index, path, data->flags)) {
70                                 if (!(data->flags & ADD_CACHE_IGNORE_ERRORS))
71                                         die(_("updating files failed"));
72                                 data->add_errors++;
73                         }
74                         break;
75                 case DIFF_STATUS_DELETED:
76                         if (data->flags & ADD_CACHE_IGNORE_REMOVAL)
77                                 break;
78                         if (!(data->flags & ADD_CACHE_PRETEND))
79                                 remove_file_from_index(&the_index, path);
80                         if (data->flags & (ADD_CACHE_PRETEND|ADD_CACHE_VERBOSE))
81                                 printf(_("remove '%s'\n"), path);
82                         break;
83                 }
84         }
85 }
86
87 int add_files_to_cache(const char *prefix,
88                        const struct pathspec *pathspec, int flags)
89 {
90         struct update_callback_data data;
91         struct rev_info rev;
92
93         memset(&data, 0, sizeof(data));
94         data.flags = flags;
95
96         init_revisions(&rev, prefix);
97         setup_revisions(0, NULL, &rev, NULL);
98         if (pathspec)
99                 copy_pathspec(&rev.prune_data, pathspec);
100         rev.diffopt.output_format = DIFF_FORMAT_CALLBACK;
101         rev.diffopt.format_callback = update_callback;
102         rev.diffopt.format_callback_data = &data;
103         rev.max_count = 0; /* do not compare unmerged paths with stage #2 */
104         run_diff_files(&rev, DIFF_RACY_IS_MODIFIED);
105         return !!data.add_errors;
106 }
107
108 static char *prune_directory(struct dir_struct *dir, struct pathspec *pathspec, int prefix)
109 {
110         char *seen;
111         int i;
112         struct dir_entry **src, **dst;
113
114         seen = xcalloc(pathspec->nr, 1);
115
116         src = dst = dir->entries;
117         i = dir->nr;
118         while (--i >= 0) {
119                 struct dir_entry *entry = *src++;
120                 if (dir_path_match(entry, pathspec, prefix, seen))
121                         *dst++ = entry;
122         }
123         dir->nr = dst - dir->entries;
124         add_pathspec_matches_against_index(pathspec, seen);
125         return seen;
126 }
127
128 static void refresh(int verbose, const struct pathspec *pathspec)
129 {
130         char *seen;
131         int i;
132
133         seen = xcalloc(pathspec->nr, 1);
134         refresh_index(&the_index, verbose ? REFRESH_IN_PORCELAIN : REFRESH_QUIET,
135                       pathspec, seen, _("Unstaged changes after refreshing the index:"));
136         for (i = 0; i < pathspec->nr; i++) {
137                 if (!seen[i])
138                         die(_("pathspec '%s' did not match any files"),
139                             pathspec->items[i].match);
140         }
141         free(seen);
142 }
143
144 int run_add_interactive(const char *revision, const char *patch_mode,
145                         const struct pathspec *pathspec)
146 {
147         int status, i;
148         struct argv_array argv = ARGV_ARRAY_INIT;
149
150         argv_array_push(&argv, "add--interactive");
151         if (patch_mode)
152                 argv_array_push(&argv, patch_mode);
153         if (revision)
154                 argv_array_push(&argv, revision);
155         argv_array_push(&argv, "--");
156         for (i = 0; i < pathspec->nr; i++)
157                 /* pass original pathspec, to be re-parsed */
158                 argv_array_push(&argv, pathspec->items[i].original);
159
160         status = run_command_v_opt(argv.argv, RUN_GIT_CMD);
161         argv_array_clear(&argv);
162         return status;
163 }
164
165 int interactive_add(int argc, const char **argv, const char *prefix, int patch)
166 {
167         struct pathspec pathspec;
168
169         parse_pathspec(&pathspec, 0,
170                        PATHSPEC_PREFER_FULL |
171                        PATHSPEC_SYMLINK_LEADING_PATH |
172                        PATHSPEC_PREFIX_ORIGIN,
173                        prefix, argv);
174
175         return run_add_interactive(NULL,
176                                    patch ? "--patch" : NULL,
177                                    &pathspec);
178 }
179
180 static int edit_patch(int argc, const char **argv, const char *prefix)
181 {
182         char *file = git_pathdup("ADD_EDIT.patch");
183         const char *apply_argv[] = { "apply", "--recount", "--cached",
184                 NULL, NULL };
185         struct child_process child = CHILD_PROCESS_INIT;
186         struct rev_info rev;
187         int out;
188         struct stat st;
189
190         apply_argv[3] = file;
191
192         git_config(git_diff_basic_config, NULL); /* no "diff" UI options */
193
194         if (read_cache() < 0)
195                 die(_("Could not read the index"));
196
197         init_revisions(&rev, prefix);
198         rev.diffopt.context = 7;
199
200         argc = setup_revisions(argc, argv, &rev, NULL);
201         rev.diffopt.output_format = DIFF_FORMAT_PATCH;
202         rev.diffopt.use_color = 0;
203         DIFF_OPT_SET(&rev.diffopt, IGNORE_DIRTY_SUBMODULES);
204         out = open(file, O_CREAT | O_WRONLY, 0666);
205         if (out < 0)
206                 die(_("Could not open '%s' for writing."), file);
207         rev.diffopt.file = xfdopen(out, "w");
208         rev.diffopt.close_file = 1;
209         if (run_diff_files(&rev, 0))
210                 die(_("Could not write patch"));
211
212         launch_editor(file, NULL, NULL);
213
214         if (stat(file, &st))
215                 die_errno(_("Could not stat '%s'"), file);
216         if (!st.st_size)
217                 die(_("Empty patch. Aborted."));
218
219         child.git_cmd = 1;
220         child.argv = apply_argv;
221         if (run_command(&child))
222                 die(_("Could not apply '%s'"), file);
223
224         unlink(file);
225         free(file);
226         return 0;
227 }
228
229 static struct lock_file lock_file;
230
231 static const char ignore_error[] =
232 N_("The following paths are ignored by one of your .gitignore files:\n");
233
234 static int verbose, show_only, ignored_too, refresh_only;
235 static int ignore_add_errors, intent_to_add, ignore_missing;
236
237 #define ADDREMOVE_DEFAULT 1
238 static int addremove = ADDREMOVE_DEFAULT;
239 static int addremove_explicit = -1; /* unspecified */
240
241 static int ignore_removal_cb(const struct option *opt, const char *arg, int unset)
242 {
243         /* if we are told to ignore, we are not adding removals */
244         *(int *)opt->value = !unset ? 0 : 1;
245         return 0;
246 }
247
248 static struct option builtin_add_options[] = {
249         OPT__DRY_RUN(&show_only, N_("dry run")),
250         OPT__VERBOSE(&verbose, N_("be verbose")),
251         OPT_GROUP(""),
252         OPT_BOOL('i', "interactive", &add_interactive, N_("interactive picking")),
253         OPT_BOOL('p', "patch", &patch_interactive, N_("select hunks interactively")),
254         OPT_BOOL('e', "edit", &edit_interactive, N_("edit current diff and apply")),
255         OPT__FORCE(&ignored_too, N_("allow adding otherwise ignored files")),
256         OPT_BOOL('u', "update", &take_worktree_changes, N_("update tracked files")),
257         OPT_BOOL('N', "intent-to-add", &intent_to_add, N_("record only the fact that the path will be added later")),
258         OPT_BOOL('A', "all", &addremove_explicit, N_("add changes from all tracked and untracked files")),
259         { OPTION_CALLBACK, 0, "ignore-removal", &addremove_explicit,
260           NULL /* takes no arguments */,
261           N_("ignore paths removed in the working tree (same as --no-all)"),
262           PARSE_OPT_NOARG, ignore_removal_cb },
263         OPT_BOOL( 0 , "refresh", &refresh_only, N_("don't add, only refresh the index")),
264         OPT_BOOL( 0 , "ignore-errors", &ignore_add_errors, N_("just skip files which cannot be added because of errors")),
265         OPT_BOOL( 0 , "ignore-missing", &ignore_missing, N_("check if - even missing - files are ignored in dry run")),
266         OPT_END(),
267 };
268
269 static int add_config(const char *var, const char *value, void *cb)
270 {
271         if (!strcmp(var, "add.ignoreerrors") ||
272             !strcmp(var, "add.ignore-errors")) {
273                 ignore_add_errors = git_config_bool(var, value);
274                 return 0;
275         }
276         return git_default_config(var, value, cb);
277 }
278
279 static int add_files(struct dir_struct *dir, int flags)
280 {
281         int i, exit_status = 0;
282
283         if (dir->ignored_nr) {
284                 fprintf(stderr, _(ignore_error));
285                 for (i = 0; i < dir->ignored_nr; i++)
286                         fprintf(stderr, "%s\n", dir->ignored[i]->name);
287                 fprintf(stderr, _("Use -f if you really want to add them.\n"));
288                 exit_status = 1;
289         }
290
291         for (i = 0; i < dir->nr; i++)
292                 if (add_file_to_cache(dir->entries[i]->name, flags)) {
293                         if (!ignore_add_errors)
294                                 die(_("adding files failed"));
295                         exit_status = 1;
296                 }
297         return exit_status;
298 }
299
300 int cmd_add(int argc, const char **argv, const char *prefix)
301 {
302         int exit_status = 0;
303         struct pathspec pathspec;
304         struct dir_struct dir;
305         int flags;
306         int add_new_files;
307         int require_pathspec;
308         char *seen = NULL;
309
310         git_config(add_config, NULL);
311
312         argc = parse_options(argc, argv, prefix, builtin_add_options,
313                           builtin_add_usage, PARSE_OPT_KEEP_ARGV0);
314         if (patch_interactive)
315                 add_interactive = 1;
316         if (add_interactive)
317                 exit(interactive_add(argc - 1, argv + 1, prefix, patch_interactive));
318
319         if (edit_interactive)
320                 return(edit_patch(argc, argv, prefix));
321         argc--;
322         argv++;
323
324         if (0 <= addremove_explicit)
325                 addremove = addremove_explicit;
326         else if (take_worktree_changes && ADDREMOVE_DEFAULT)
327                 addremove = 0; /* "-u" was given but not "-A" */
328
329         if (addremove && take_worktree_changes)
330                 die(_("-A and -u are mutually incompatible"));
331
332         if (!take_worktree_changes && addremove_explicit < 0 && argc)
333                 /* Turn "git add pathspec..." to "git add -A pathspec..." */
334                 addremove = 1;
335
336         if (!show_only && ignore_missing)
337                 die(_("Option --ignore-missing can only be used together with --dry-run"));
338
339         if ((0 < addremove_explicit || take_worktree_changes) && !argc) {
340                 static const char *whole[2] = { ":/", NULL };
341                 argc = 1;
342                 argv = whole;
343         }
344
345         add_new_files = !take_worktree_changes && !refresh_only;
346         require_pathspec = !take_worktree_changes;
347
348         hold_locked_index(&lock_file, 1);
349
350         flags = ((verbose ? ADD_CACHE_VERBOSE : 0) |
351                  (show_only ? ADD_CACHE_PRETEND : 0) |
352                  (intent_to_add ? ADD_CACHE_INTENT : 0) |
353                  (ignore_add_errors ? ADD_CACHE_IGNORE_ERRORS : 0) |
354                  (!(addremove || take_worktree_changes)
355                   ? ADD_CACHE_IGNORE_REMOVAL : 0));
356
357         if (require_pathspec && argc == 0) {
358                 fprintf(stderr, _("Nothing specified, nothing added.\n"));
359                 fprintf(stderr, _("Maybe you wanted to say 'git add .'?\n"));
360                 return 0;
361         }
362
363         if (read_cache() < 0)
364                 die(_("index file corrupt"));
365
366         /*
367          * Check the "pathspec '%s' did not match any files" block
368          * below before enabling new magic.
369          */
370         parse_pathspec(&pathspec, 0,
371                        PATHSPEC_PREFER_FULL |
372                        PATHSPEC_SYMLINK_LEADING_PATH |
373                        PATHSPEC_STRIP_SUBMODULE_SLASH_EXPENSIVE,
374                        prefix, argv);
375
376         if (add_new_files) {
377                 int baselen;
378                 struct pathspec empty_pathspec;
379
380                 /* Set up the default git porcelain excludes */
381                 memset(&dir, 0, sizeof(dir));
382                 if (!ignored_too) {
383                         dir.flags |= DIR_COLLECT_IGNORED;
384                         setup_standard_excludes(&dir);
385                 }
386
387                 memset(&empty_pathspec, 0, sizeof(empty_pathspec));
388                 /* This picks up the paths that are not tracked */
389                 baselen = fill_directory(&dir, &pathspec);
390                 if (pathspec.nr)
391                         seen = prune_directory(&dir, &pathspec, baselen);
392         }
393
394         if (refresh_only) {
395                 refresh(verbose, &pathspec);
396                 goto finish;
397         }
398
399         if (pathspec.nr) {
400                 int i;
401
402                 if (!seen)
403                         seen = find_pathspecs_matching_against_index(&pathspec);
404
405                 /*
406                  * file_exists() assumes exact match
407                  */
408                 GUARD_PATHSPEC(&pathspec,
409                                PATHSPEC_FROMTOP |
410                                PATHSPEC_LITERAL |
411                                PATHSPEC_GLOB |
412                                PATHSPEC_ICASE |
413                                PATHSPEC_EXCLUDE);
414
415                 for (i = 0; i < pathspec.nr; i++) {
416                         const char *path = pathspec.items[i].match;
417                         if (pathspec.items[i].magic & PATHSPEC_EXCLUDE)
418                                 continue;
419                         if (!seen[i] && path[0] &&
420                             ((pathspec.items[i].magic &
421                               (PATHSPEC_GLOB | PATHSPEC_ICASE)) ||
422                              !file_exists(path))) {
423                                 if (ignore_missing) {
424                                         int dtype = DT_UNKNOWN;
425                                         if (is_excluded(&dir, path, &dtype))
426                                                 dir_add_ignored(&dir, path, pathspec.items[i].len);
427                                 } else
428                                         die(_("pathspec '%s' did not match any files"),
429                                             pathspec.items[i].original);
430                         }
431                 }
432                 free(seen);
433         }
434
435         plug_bulk_checkin();
436
437         exit_status |= add_files_to_cache(prefix, &pathspec, flags);
438
439         if (add_new_files)
440                 exit_status |= add_files(&dir, flags);
441
442         unplug_bulk_checkin();
443
444 finish:
445         if (active_cache_changed) {
446                 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
447                         die(_("Unable to write new index file"));
448         }
449
450         return exit_status;
451 }