2 * "git add" builtin command
4 * Copyright (C) 2006 Linus Torvalds
15 #include "run-command.h"
16 #include "parse-options.h"
18 #include "preload-index.h"
20 #include "read-cache.h"
21 #include "repository.h"
23 #include "bulk-checkin.h"
25 #include "submodule.h"
26 #include "add-interactive.h"
28 static const char * const builtin_add_usage
[] = {
29 N_("git add [<options>] [--] <pathspec>..."),
32 static int patch_interactive
, add_interactive
, edit_interactive
;
33 static int take_worktree_changes
;
34 static int add_renormalize
;
35 static int pathspec_file_nul
;
36 static int include_sparse
;
37 static const char *pathspec_from_file
;
39 static int chmod_pathspec(struct pathspec
*pathspec
, char flip
, int show_only
)
43 for (i
= 0; i
< the_repository
->index
->cache_nr
; i
++) {
44 struct cache_entry
*ce
= the_repository
->index
->cache
[i
];
47 if (!include_sparse
&&
48 (ce_skip_worktree(ce
) ||
49 !path_in_sparse_checkout(ce
->name
, the_repository
->index
)))
52 if (pathspec
&& !ce_path_match(the_repository
->index
, ce
, pathspec
, NULL
))
56 err
= chmod_index_entry(the_repository
->index
, ce
, flip
);
58 err
= S_ISREG(ce
->ce_mode
) ? 0 : -1;
61 ret
= error(_("cannot chmod %cx '%s'"), flip
, ce
->name
);
67 static int renormalize_tracked_files(const struct pathspec
*pathspec
, int flags
)
71 for (i
= 0; i
< the_repository
->index
->cache_nr
; i
++) {
72 struct cache_entry
*ce
= the_repository
->index
->cache
[i
];
74 if (!include_sparse
&&
75 (ce_skip_worktree(ce
) ||
76 !path_in_sparse_checkout(ce
->name
, the_repository
->index
)))
79 continue; /* do not touch unmerged paths */
80 if (!S_ISREG(ce
->ce_mode
) && !S_ISLNK(ce
->ce_mode
))
81 continue; /* do not touch non blobs */
82 if (pathspec
&& !ce_path_match(the_repository
->index
, ce
, pathspec
, NULL
))
84 retval
|= add_file_to_index(the_repository
->index
, ce
->name
,
85 flags
| ADD_CACHE_RENORMALIZE
);
91 static char *prune_directory(struct dir_struct
*dir
, struct pathspec
*pathspec
, int prefix
)
95 struct dir_entry
**src
, **dst
;
97 seen
= xcalloc(pathspec
->nr
, 1);
99 src
= dst
= dir
->entries
;
102 struct dir_entry
*entry
= *src
++;
103 if (dir_path_match(the_repository
->index
, entry
, pathspec
, prefix
, seen
))
106 dir
->nr
= dst
- dir
->entries
;
107 add_pathspec_matches_against_index(pathspec
, the_repository
->index
, seen
,
108 PS_IGNORE_SKIP_WORKTREE
);
112 static int refresh(int verbose
, const struct pathspec
*pathspec
)
116 char *skip_worktree_seen
= NULL
;
117 struct string_list only_match_skip_worktree
= STRING_LIST_INIT_NODUP
;
118 unsigned int flags
= REFRESH_IGNORE_SKIP_WORKTREE
|
119 (verbose
? REFRESH_IN_PORCELAIN
: REFRESH_QUIET
);
121 seen
= xcalloc(pathspec
->nr
, 1);
122 refresh_index(the_repository
->index
, flags
, pathspec
, seen
,
123 _("Unstaged changes after refreshing the index:"));
124 for (i
= 0; i
< pathspec
->nr
; i
++) {
126 const char *path
= pathspec
->items
[i
].original
;
128 if (matches_skip_worktree(pathspec
, i
, &skip_worktree_seen
) ||
129 !path_in_sparse_checkout(path
, the_repository
->index
)) {
130 string_list_append(&only_match_skip_worktree
,
131 pathspec
->items
[i
].original
);
133 die(_("pathspec '%s' did not match any files"),
134 pathspec
->items
[i
].original
);
139 if (only_match_skip_worktree
.nr
) {
140 advise_on_updating_sparse_paths(&only_match_skip_worktree
);
145 free(skip_worktree_seen
);
146 string_list_clear(&only_match_skip_worktree
, 0);
150 int interactive_add(const char **argv
, const char *prefix
, int patch
)
152 struct pathspec pathspec
;
155 parse_pathspec(&pathspec
, 0,
156 PATHSPEC_PREFER_FULL
|
157 PATHSPEC_SYMLINK_LEADING_PATH
|
158 PATHSPEC_PREFIX_ORIGIN
,
162 ret
= !!run_add_p(the_repository
, ADD_P_ADD
, NULL
, &pathspec
);
164 ret
= !!run_add_i(the_repository
, &pathspec
);
166 clear_pathspec(&pathspec
);
170 static int edit_patch(int argc
, const char **argv
, const char *prefix
)
172 char *file
= git_pathdup("ADD_EDIT.patch");
173 struct child_process child
= CHILD_PROCESS_INIT
;
178 git_config(git_diff_basic_config
, NULL
); /* no "diff" UI options */
180 if (repo_read_index(the_repository
) < 0)
181 die(_("could not read the index"));
183 repo_init_revisions(the_repository
, &rev
, prefix
);
184 rev
.diffopt
.context
= 7;
186 argc
= setup_revisions(argc
, argv
, &rev
, NULL
);
187 rev
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
188 rev
.diffopt
.use_color
= 0;
189 rev
.diffopt
.flags
.ignore_dirty_submodules
= 1;
190 out
= xopen(file
, O_CREAT
| O_WRONLY
| O_TRUNC
, 0666);
191 rev
.diffopt
.file
= xfdopen(out
, "w");
192 rev
.diffopt
.close_file
= 1;
193 run_diff_files(&rev
, 0);
195 if (launch_editor(file
, NULL
, NULL
))
196 die(_("editing patch failed"));
199 die_errno(_("could not stat '%s'"), file
);
201 die(_("empty patch. aborted"));
204 strvec_pushl(&child
.args
, "apply", "--recount", "--cached", file
,
206 if (run_command(&child
))
207 die(_("could not apply '%s'"), file
);
211 release_revisions(&rev
);
215 static const char ignore_error
[] =
216 N_("The following paths are ignored by one of your .gitignore files:\n");
218 static int verbose
, show_only
, ignored_too
, refresh_only
;
219 static int ignore_add_errors
, intent_to_add
, ignore_missing
;
220 static int warn_on_embedded_repo
= 1;
222 #define ADDREMOVE_DEFAULT 1
223 static int addremove
= ADDREMOVE_DEFAULT
;
224 static int addremove_explicit
= -1; /* unspecified */
226 static char *chmod_arg
;
228 static int ignore_removal_cb(const struct option
*opt
, const char *arg
, int unset
)
232 /* if we are told to ignore, we are not adding removals */
233 *(int *)opt
->value
= !unset
? 0 : 1;
237 static struct option builtin_add_options
[] = {
238 OPT__DRY_RUN(&show_only
, N_("dry run")),
239 OPT__VERBOSE(&verbose
, N_("be verbose")),
241 OPT_BOOL('i', "interactive", &add_interactive
, N_("interactive picking")),
242 OPT_BOOL('p', "patch", &patch_interactive
, N_("select hunks interactively")),
243 OPT_BOOL('e', "edit", &edit_interactive
, N_("edit current diff and apply")),
244 OPT__FORCE(&ignored_too
, N_("allow adding otherwise ignored files"), 0),
245 OPT_BOOL('u', "update", &take_worktree_changes
, N_("update tracked files")),
246 OPT_BOOL(0, "renormalize", &add_renormalize
, N_("renormalize EOL of tracked files (implies -u)")),
247 OPT_BOOL('N', "intent-to-add", &intent_to_add
, N_("record only the fact that the path will be added later")),
248 OPT_BOOL('A', "all", &addremove_explicit
, N_("add changes from all tracked and untracked files")),
249 OPT_CALLBACK_F(0, "ignore-removal", &addremove_explicit
,
250 NULL
/* takes no arguments */,
251 N_("ignore paths removed in the working tree (same as --no-all)"),
252 PARSE_OPT_NOARG
, ignore_removal_cb
),
253 OPT_BOOL( 0 , "refresh", &refresh_only
, N_("don't add, only refresh the index")),
254 OPT_BOOL( 0 , "ignore-errors", &ignore_add_errors
, N_("just skip files which cannot be added because of errors")),
255 OPT_BOOL( 0 , "ignore-missing", &ignore_missing
, N_("check if - even missing - files are ignored in dry run")),
256 OPT_BOOL(0, "sparse", &include_sparse
, N_("allow updating entries outside of the sparse-checkout cone")),
257 OPT_STRING(0, "chmod", &chmod_arg
, "(+|-)x",
258 N_("override the executable bit of the listed files")),
259 OPT_HIDDEN_BOOL(0, "warn-embedded-repo", &warn_on_embedded_repo
,
260 N_("warn when adding an embedded repository")),
261 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file
),
262 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul
),
266 static int add_config(const char *var
, const char *value
,
267 const struct config_context
*ctx
, void *cb
)
269 if (!strcmp(var
, "add.ignoreerrors") ||
270 !strcmp(var
, "add.ignore-errors")) {
271 ignore_add_errors
= git_config_bool(var
, value
);
275 if (git_color_config(var
, value
, cb
) < 0)
278 return git_default_config(var
, value
, ctx
, cb
);
281 static const char embedded_advice
[] = N_(
282 "You've added another git repository inside your current repository.\n"
283 "Clones of the outer repository will not contain the contents of\n"
284 "the embedded repository and will not know how to obtain it.\n"
285 "If you meant to add a submodule, use:\n"
287 " git submodule add <url> %s\n"
289 "If you added this path by mistake, you can remove it from the\n"
292 " git rm --cached %s\n"
294 "See \"git help submodule\" for more information."
297 static void check_embedded_repo(const char *path
)
299 struct strbuf name
= STRBUF_INIT
;
300 static int adviced_on_embedded_repo
= 0;
302 if (!warn_on_embedded_repo
)
304 if (!ends_with(path
, "/"))
307 /* Drop trailing slash for aesthetics */
308 strbuf_addstr(&name
, path
);
309 strbuf_strip_suffix(&name
, "/");
311 warning(_("adding embedded git repository: %s"), name
.buf
);
312 if (!adviced_on_embedded_repo
) {
313 advise_if_enabled(ADVICE_ADD_EMBEDDED_REPO
,
314 embedded_advice
, name
.buf
, name
.buf
);
315 adviced_on_embedded_repo
= 1;
318 strbuf_release(&name
);
321 static int add_files(struct dir_struct
*dir
, int flags
)
323 int i
, exit_status
= 0;
324 struct string_list matched_sparse_paths
= STRING_LIST_INIT_NODUP
;
326 if (dir
->ignored_nr
) {
327 fprintf(stderr
, _(ignore_error
));
328 for (i
= 0; i
< dir
->ignored_nr
; i
++)
329 fprintf(stderr
, "%s\n", dir
->ignored
[i
]->name
);
330 advise_if_enabled(ADVICE_ADD_IGNORED_FILE
,
331 _("Use -f if you really want to add them."));
335 for (i
= 0; i
< dir
->nr
; i
++) {
336 if (!include_sparse
&&
337 !path_in_sparse_checkout(dir
->entries
[i
]->name
, the_repository
->index
)) {
338 string_list_append(&matched_sparse_paths
,
339 dir
->entries
[i
]->name
);
342 if (add_file_to_index(the_repository
->index
, dir
->entries
[i
]->name
, flags
)) {
343 if (!ignore_add_errors
)
344 die(_("adding files failed"));
347 check_embedded_repo(dir
->entries
[i
]->name
);
351 if (matched_sparse_paths
.nr
) {
352 advise_on_updating_sparse_paths(&matched_sparse_paths
);
356 string_list_clear(&matched_sparse_paths
, 0);
361 int cmd_add(int argc
, const char **argv
, const char *prefix
)
364 struct pathspec pathspec
;
365 struct dir_struct dir
= DIR_INIT
;
368 int require_pathspec
;
370 char *ps_matched
= NULL
;
371 struct lock_file lock_file
= LOCK_INIT
;
373 git_config(add_config
, NULL
);
375 argc
= parse_options(argc
, argv
, prefix
, builtin_add_options
,
376 builtin_add_usage
, PARSE_OPT_KEEP_ARGV0
);
377 if (patch_interactive
)
379 if (add_interactive
) {
381 die(_("options '%s' and '%s' cannot be used together"), "--dry-run", "--interactive/--patch");
382 if (pathspec_from_file
)
383 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--interactive/--patch");
384 exit(interactive_add(argv
+ 1, prefix
, patch_interactive
));
387 if (edit_interactive
) {
388 if (pathspec_from_file
)
389 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--edit");
390 return(edit_patch(argc
, argv
, prefix
));
395 if (0 <= addremove_explicit
)
396 addremove
= addremove_explicit
;
397 else if (take_worktree_changes
&& ADDREMOVE_DEFAULT
)
398 addremove
= 0; /* "-u" was given but not "-A" */
400 if (addremove
&& take_worktree_changes
)
401 die(_("options '%s' and '%s' cannot be used together"), "-A", "-u");
403 if (!show_only
&& ignore_missing
)
404 die(_("the option '%s' requires '%s'"), "--ignore-missing", "--dry-run");
406 if (chmod_arg
&& ((chmod_arg
[0] != '-' && chmod_arg
[0] != '+') ||
407 chmod_arg
[1] != 'x' || chmod_arg
[2]))
408 die(_("--chmod param '%s' must be either -x or +x"), chmod_arg
);
410 add_new_files
= !take_worktree_changes
&& !refresh_only
&& !add_renormalize
;
411 require_pathspec
= !(take_worktree_changes
|| (0 < addremove_explicit
));
413 prepare_repo_settings(the_repository
);
414 the_repository
->settings
.command_requires_full_index
= 0;
416 repo_hold_locked_index(the_repository
, &lock_file
, LOCK_DIE_ON_ERROR
);
419 * Check the "pathspec '%s' did not match any files" block
420 * below before enabling new magic.
422 parse_pathspec(&pathspec
, 0,
423 PATHSPEC_PREFER_FULL
|
424 PATHSPEC_SYMLINK_LEADING_PATH
,
427 if (pathspec_from_file
) {
429 die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
431 parse_pathspec_file(&pathspec
, 0,
432 PATHSPEC_PREFER_FULL
|
433 PATHSPEC_SYMLINK_LEADING_PATH
,
434 prefix
, pathspec_from_file
, pathspec_file_nul
);
435 } else if (pathspec_file_nul
) {
436 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
439 if (require_pathspec
&& pathspec
.nr
== 0) {
440 fprintf(stderr
, _("Nothing specified, nothing added.\n"));
441 advise_if_enabled(ADVICE_ADD_EMPTY_PATHSPEC
,
442 _("Maybe you wanted to say 'git add .'?"));
446 if (!take_worktree_changes
&& addremove_explicit
< 0 && pathspec
.nr
)
447 /* Turn "git add pathspec..." to "git add -A pathspec..." */
450 flags
= ((verbose
? ADD_CACHE_VERBOSE
: 0) |
451 (show_only
? ADD_CACHE_PRETEND
: 0) |
452 (intent_to_add
? ADD_CACHE_INTENT
: 0) |
453 (ignore_add_errors
? ADD_CACHE_IGNORE_ERRORS
: 0) |
454 (!(addremove
|| take_worktree_changes
)
455 ? ADD_CACHE_IGNORE_REMOVAL
: 0));
457 if (repo_read_index_preload(the_repository
, &pathspec
, 0) < 0)
458 die(_("index file corrupt"));
460 die_in_unpopulated_submodule(the_repository
->index
, prefix
);
461 die_path_inside_submodule(the_repository
->index
, &pathspec
);
466 /* Set up the default git porcelain excludes */
468 dir
.flags
|= DIR_COLLECT_IGNORED
;
469 setup_standard_excludes(&dir
);
472 /* This picks up the paths that are not tracked */
473 baselen
= fill_directory(&dir
, the_repository
->index
, &pathspec
);
475 seen
= prune_directory(&dir
, &pathspec
, baselen
);
479 exit_status
|= refresh(verbose
, &pathspec
);
485 char *skip_worktree_seen
= NULL
;
486 struct string_list only_match_skip_worktree
= STRING_LIST_INIT_NODUP
;
489 seen
= find_pathspecs_matching_against_index(&pathspec
,
490 the_repository
->index
, PS_IGNORE_SKIP_WORKTREE
);
493 * file_exists() assumes exact match
495 GUARD_PATHSPEC(&pathspec
,
503 for (i
= 0; i
< pathspec
.nr
; i
++) {
504 const char *path
= pathspec
.items
[i
].match
;
506 if (pathspec
.items
[i
].magic
& PATHSPEC_EXCLUDE
)
511 if (!include_sparse
&&
512 matches_skip_worktree(&pathspec
, i
, &skip_worktree_seen
)) {
513 string_list_append(&only_match_skip_worktree
,
514 pathspec
.items
[i
].original
);
518 /* Don't complain at 'git add .' on empty repo */
522 if ((pathspec
.items
[i
].magic
& (PATHSPEC_GLOB
| PATHSPEC_ICASE
)) ||
523 !file_exists(path
)) {
524 if (ignore_missing
) {
525 int dtype
= DT_UNKNOWN
;
526 if (is_excluded(&dir
, the_repository
->index
, path
, &dtype
))
527 dir_add_ignored(&dir
, the_repository
->index
,
528 path
, pathspec
.items
[i
].len
);
530 die(_("pathspec '%s' did not match any files"),
531 pathspec
.items
[i
].original
);
536 if (only_match_skip_worktree
.nr
) {
537 advise_on_updating_sparse_paths(&only_match_skip_worktree
);
542 free(skip_worktree_seen
);
543 string_list_clear(&only_match_skip_worktree
, 0);
546 begin_odb_transaction();
548 ps_matched
= xcalloc(pathspec
.nr
, 1);
550 exit_status
|= renormalize_tracked_files(&pathspec
, flags
);
552 exit_status
|= add_files_to_cache(the_repository
, prefix
,
553 &pathspec
, ps_matched
,
554 include_sparse
, flags
);
556 if (take_worktree_changes
&& !add_renormalize
&& !ignore_add_errors
&&
557 report_path_error(ps_matched
, &pathspec
))
561 exit_status
|= add_files(&dir
, flags
);
563 if (chmod_arg
&& pathspec
.nr
)
564 exit_status
|= chmod_pathspec(&pathspec
, chmod_arg
[0], show_only
);
565 end_odb_transaction();
568 if (write_locked_index(the_repository
->index
, &lock_file
,
569 COMMIT_LOCK
| SKIP_IF_UNCHANGED
))
570 die(_("unable to write new index file"));
574 clear_pathspec(&pathspec
);