2 * "git reset" builtin command
4 * Copyright (c) 2007 Carlos Rica
6 * Based on git-reset.sh, which is
8 * Copyright (c) 2005, 2006 Linus Torvalds and Junio C Hamano
10 #define USE_THE_INDEX_VARIABLE
17 #include "run-command.h"
23 #include "parse-options.h"
24 #include "unpack-trees.h"
25 #include "cache-tree.h"
26 #include "submodule.h"
27 #include "submodule-config.h"
30 #define REFRESH_INDEX_DELAY_WARNING_IN_MS (2 * 1000)
32 static const char * const git_reset_usage
[] = {
33 N_("git reset [--mixed | --soft | --hard | --merge | --keep] [-q] [<commit>]"),
34 N_("git reset [-q] [<tree-ish>] [--] <pathspec>..."),
35 N_("git reset [-q] [--pathspec-from-file [--pathspec-file-nul]] [<tree-ish>]"),
36 N_("git reset --patch [<tree-ish>] [--] [<pathspec>...]"),
40 enum reset_type
{ MIXED
, SOFT
, HARD
, MERGE
, KEEP
, NONE
};
41 static const char *reset_type_names
[] = {
42 N_("mixed"), N_("soft"), N_("hard"), N_("merge"), N_("keep"), NULL
45 static inline int is_merge(void)
47 return !access(git_path_merge_head(the_repository
), F_OK
);
50 static int reset_index(const char *ref
, const struct object_id
*oid
, int reset_type
, int quiet
)
53 struct tree_desc desc
[2];
55 struct unpack_trees_options opts
;
58 memset(&opts
, 0, sizeof(opts
));
60 opts
.src_index
= &the_index
;
61 opts
.dst_index
= &the_index
;
62 opts
.fn
= oneway_merge
;
64 init_checkout_metadata(&opts
.meta
, ref
, oid
, NULL
);
66 opts
.verbose_update
= 1;
71 opts
.preserve_ignored
= 0; /* FIXME: !overwrite_ignore */
75 opts
.reset
= UNPACK_RESET_OVERWRITE_UNTRACKED
;
76 opts
.skip_cache_tree_update
= 1;
79 opts
.reset
= UNPACK_RESET_PROTECT_UNTRACKED
;
80 opts
.skip_cache_tree_update
= 1;
81 /* but opts.update=0, so working tree not updated */
84 BUG("invalid reset_type passed to reset_index");
87 repo_read_index_unmerged(the_repository
);
89 if (reset_type
== KEEP
) {
90 struct object_id head_oid
;
91 if (get_oid("HEAD", &head_oid
))
92 return error(_("You do not have a valid HEAD."));
93 if (!fill_tree_descriptor(the_repository
, desc
nr
, &head_oid
))
94 return error(_("Failed to find tree of HEAD."));
96 opts
.fn
= twoway_merge
;
99 if (!fill_tree_descriptor(the_repository
, desc
nr
, oid
)) {
100 error(_("Failed to find tree of %s."), oid_to_hex(oid
));
105 if (unpack_trees(nr
, desc
, &opts
))
108 if (reset_type
== MIXED
|| reset_type
== HARD
) {
109 tree
= parse_tree_indirect(oid
);
110 prime_cache_tree(the_repository
, the_repository
->index
, tree
);
116 for (i
= 0; i
< nr
; i
)
117 free((void *)desc
[i
].buffer
);
121 static void print_new_head_line(struct commit
*commit
)
123 struct strbuf buf
= STRBUF_INIT
;
125 printf(_("HEAD is now at %s"),
126 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
));
128 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &buf
);
130 printf(" %s", buf
.buf
);
132 strbuf_release(&buf
);
135 static void update_index_from_diff(struct diff_queue_struct
*q
,
136 struct diff_options
*opt UNUSED
,
140 int intent_to_add
= *(int *)data
;
142 for (i
= 0; i
< q
->nr
; i
) {
144 struct diff_filespec
*one
= q
->queue
[i
]->one
;
145 int is_in_reset_tree
= one
->mode
&& !is_null_oid(&one
->oid
);
146 struct cache_entry
*ce
;
148 if (!is_in_reset_tree
&& !intent_to_add
) {
149 remove_file_from_index(&the_index
, one
->path
);
153 ce
= make_cache_entry(&the_index
, one
->mode
, &one
->oid
, one
->path
,
157 * If the file 1) corresponds to an existing index entry with
158 * skip-worktree set, or 2) does not exist in the index but is
159 * outside the sparse checkout definition, add a skip-worktree bit
160 * to the new index entry. Note that a sparse index will be expanded
161 * if this entry is outside the sparse cone - this is necessary
162 * to properly construct the reset sparse directory.
164 pos
= index_name_pos(&the_index
, one
->path
, strlen(one
->path
));
165 if ((pos
>= 0 && ce_skip_worktree(the_index
.cache
[pos
])) ||
166 (pos
< 0 && !path_in_sparse_checkout(one
->path
, &the_index
)))
167 ce
->ce_flags
|= CE_SKIP_WORKTREE
;
170 die(_("make_cache_entry failed for path '%s'"),
172 if (!is_in_reset_tree
) {
173 ce
->ce_flags
|= CE_INTENT_TO_ADD
;
174 set_object_name_for_intent_to_add_entry(ce
);
176 add_index_entry(&the_index
, ce
,
177 ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
);
181 static int read_from_tree(const struct pathspec
*pathspec
,
182 struct object_id
*tree_oid
,
185 struct diff_options opt
;
187 memset(&opt
, 0, sizeof(opt
));
188 copy_pathspec(&opt
.pathspec
, pathspec
);
189 opt
.output_format
= DIFF_FORMAT_CALLBACK
;
190 opt
.format_callback
= update_index_from_diff
;
191 opt
.format_callback_data
= &intent_to_add
;
192 opt
.flags
.override_submodule_config
= 1;
193 opt
.flags
.recursive
= 1;
194 opt
.repo
= the_repository
;
195 opt
.change
= diff_change
;
196 opt
.add_remove
= diff_addremove
;
198 if (pathspec
->nr
&& pathspec_needs_expanded_index(&the_index
, pathspec
))
199 ensure_full_index(&the_index
);
201 if (do_diff_cache(tree_oid
, &opt
))
209 static void set_reflog_message(struct strbuf
*sb
, const char *action
,
212 const char *rla
= getenv("GIT_REFLOG_ACTION");
216 strbuf_addf(sb
, "%s: %s", rla
, action
);
218 strbuf_addf(sb
, "reset: moving to %s", rev
);
220 strbuf_addf(sb
, "reset: %s", action
);
223 static void die_if_unmerged_cache(int reset_type
)
225 if (is_merge() || unmerged_index(&the_index
))
226 die(_("Cannot do a %s reset in the middle of a merge."),
227 _(reset_type_names
[reset_type
]));
231 static void parse_args(struct pathspec
*pathspec
,
232 const char **argv
, const char *prefix
,
234 const char **rev_ret
)
236 const char *rev
= "HEAD";
237 struct object_id unused
;
239 * Possible arguments are:
241 * git reset [-opts] [<rev>]
242 * git reset [-opts] <tree> [<paths>...]
243 * git reset [-opts] <tree> -- [<paths>...]
244 * git reset [-opts] -- [<paths>...]
245 * git reset [-opts] <paths>...
247 * At this point, argv points immediately after [-opts].
251 if (!strcmp(argv
[0], "--")) {
252 argv
; /* reset to HEAD, possibly with paths */
253 } else if (argv
[1] && !strcmp(argv
[1], "--")) {
258 * Otherwise, argv[0] could be either <rev> or <paths> and
259 * has to be unambiguous. If there is a single argument, it
262 else if ((!argv
[1] && !get_oid_committish(argv
[0], &unused
)) ||
263 (argv
[1] && !get_oid_treeish(argv
[0], &unused
))) {
265 * Ok, argv[0] looks like a commit/tree; it should not
268 verify_non_filename(prefix
, argv
[0]);
271 /* Otherwise we treat this as a filename */
272 verify_filename(prefix
, argv
[0], 1);
277 parse_pathspec(pathspec
, 0,
278 PATHSPEC_PREFER_FULL
|
279 (patch_mode
? PATHSPEC_PREFIX_ORIGIN
: 0),
283 static int reset_refs(const char *rev
, const struct object_id
*oid
)
285 int update_ref_status
;
286 struct strbuf msg
= STRBUF_INIT
;
287 struct object_id
*orig
= NULL
, oid_orig
,
288 *old_orig
= NULL
, oid_old_orig
;
290 if (!get_oid("ORIG_HEAD", &oid_old_orig
))
291 old_orig
= &oid_old_orig
;
292 if (!get_oid("HEAD", &oid_orig
)) {
294 set_reflog_message(&msg
, "updating ORIG_HEAD", NULL
);
295 update_ref(msg
.buf
, "ORIG_HEAD", orig
, old_orig
, 0,
296 UPDATE_REFS_MSG_ON_ERR
);
298 delete_ref(NULL
, "ORIG_HEAD", old_orig
, 0);
299 set_reflog_message(&msg
, "updating HEAD", rev
);
300 update_ref_status
= update_ref(msg
.buf
, "HEAD", oid
, orig
, 0,
301 UPDATE_REFS_MSG_ON_ERR
);
302 strbuf_release(&msg
);
303 return update_ref_status
;
306 static int git_reset_config(const char *var
, const char *value
, void *cb
)
308 if (!strcmp(var
, "submodule.recurse"))
309 return git_default_submodule_config(var
, value
, cb
);
311 return git_default_config(var
, value
, cb
);
314 int cmd_reset(int argc
, const char **argv
, const char *prefix
)
316 int reset_type
= NONE
, update_ref_status
= 0, quiet
= 0;
318 int patch_mode
= 0, pathspec_file_nul
= 0, unborn
;
319 const char *rev
, *pathspec_from_file
= NULL
;
320 struct object_id oid
;
321 struct pathspec pathspec
;
322 int intent_to_add
= 0;
323 const struct option options
[] = {
324 OPT__QUIET(&quiet
, N_("be quiet, only report errors")),
325 OPT_BOOL(0, "no-refresh", &no_refresh
,
326 N_("skip refreshing the index after reset")),
327 OPT_SET_INT(0, "mixed", &reset_type
,
328 N_("reset HEAD and index"), MIXED
),
329 OPT_SET_INT(0, "soft", &reset_type
, N_("reset only HEAD"), SOFT
),
330 OPT_SET_INT(0, "hard", &reset_type
,
331 N_("reset HEAD, index and working tree"), HARD
),
332 OPT_SET_INT(0, "merge", &reset_type
,
333 N_("reset HEAD, index and working tree"), MERGE
),
334 OPT_SET_INT(0, "keep", &reset_type
,
335 N_("reset HEAD but keep local changes"), KEEP
),
336 OPT_CALLBACK_F(0, "recurse-submodules", NULL
,
337 "reset", "control recursive updating of submodules",
338 PARSE_OPT_OPTARG
, option_parse_recurse_submodules_worktree_updater
),
339 OPT_BOOL('p', "patch", &patch_mode
, N_("select hunks interactively")),
340 OPT_BOOL('N', "intent-to-add", &intent_to_add
,
341 N_("record only the fact that removed paths will be added later")),
342 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file
),
343 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul
),
347 git_config(git_reset_config
, NULL
);
349 argc
= parse_options(argc
, argv
, prefix
, options
, git_reset_usage
,
350 PARSE_OPT_KEEP_DASHDASH
);
351 parse_args(&pathspec
, argv
, prefix
, patch_mode
, &rev
);
353 if (pathspec_from_file
) {
355 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--patch");
358 die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
360 parse_pathspec_file(&pathspec
, 0,
361 PATHSPEC_PREFER_FULL
,
362 prefix
, pathspec_from_file
, pathspec_file_nul
);
363 } else if (pathspec_file_nul
) {
364 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
367 unborn
= !strcmp(rev
, "HEAD") && get_oid("HEAD", &oid
);
369 /* reset on unborn branch: treat as reset to empty tree */
370 oidcpy(&oid
, the_hash_algo
->empty_tree
);
371 } else if (!pathspec
.nr
&& !patch_mode
) {
372 struct commit
*commit
;
373 if (get_oid_committish(rev
, &oid
))
374 die(_("Failed to resolve '%s' as a valid revision."), rev
);
375 commit
= lookup_commit_reference(the_repository
, &oid
);
377 die(_("Could not parse object '%s'."), rev
);
378 oidcpy(&oid
, &commit
->object
.oid
);
381 if (get_oid_treeish(rev
, &oid
))
382 die(_("Failed to resolve '%s' as a valid tree."), rev
);
383 tree
= parse_tree_indirect(&oid
);
385 die(_("Could not parse object '%s'."), rev
);
386 oidcpy(&oid
, &tree
->object
.oid
);
390 if (reset_type
!= NONE
)
391 die(_("options '%s' and '%s' cannot be used together"), "--patch", "--{hard,mixed,soft}");
392 trace2_cmd_mode("patch-interactive");
393 return run_add_interactive(rev
, "--patch=reset", &pathspec
);
396 /* git reset tree [--] paths... can be used to
397 * load chosen paths from the tree into the index without
398 * affecting the working tree nor HEAD. */
400 if (reset_type
== MIXED
)
401 warning(_("--mixed with paths is deprecated; use 'git reset -- <paths>' instead."));
402 else if (reset_type
!= NONE
)
403 die(_("Cannot do %s reset with paths."),
404 _(reset_type_names
[reset_type
]));
406 if (reset_type
== NONE
)
407 reset_type
= MIXED
; /* by default */
410 trace2_cmd_mode("path");
412 trace2_cmd_mode(reset_type_names
[reset_type
]);
414 if (reset_type
!= SOFT
&& (reset_type
!= MIXED
|| get_git_work_tree()))
417 if (reset_type
== MIXED
&& is_bare_repository())
418 die(_("%s reset is not allowed in a bare repository"),
419 _(reset_type_names
[reset_type
]));
421 if (intent_to_add
&& reset_type
!= MIXED
)
422 die(_("the option '%s' requires '%s'"), "-N", "--mixed");
424 prepare_repo_settings(the_repository
);
425 the_repository
->settings
.command_requires_full_index
= 0;
427 if (repo_read_index(the_repository
) < 0)
428 die(_("index file corrupt"));
430 /* Soft reset does not touch the index file nor the working tree
431 * at all, but requires them in a good order. Other resets reset
432 * the index file to the tree object we are switching to. */
433 if (reset_type
== SOFT
|| reset_type
== KEEP
)
434 die_if_unmerged_cache(reset_type
);
436 if (reset_type
!= SOFT
) {
437 struct lock_file lock
= LOCK_INIT
;
438 repo_hold_locked_index(the_repository
, &lock
,
440 if (reset_type
== MIXED
) {
441 int flags
= quiet
? REFRESH_QUIET
: REFRESH_IN_PORCELAIN
;
442 if (read_from_tree(&pathspec
, &oid
, intent_to_add
))
444 the_index
.updated_skipworktree
= 1;
445 if (!no_refresh
&& get_git_work_tree()) {
446 uint64_t t_begin
, t_delta_in_ms
;
448 t_begin
= getnanotime();
449 refresh_index(&the_index
, flags
, NULL
, NULL
,
450 _("Unstaged changes after reset:"));
451 t_delta_in_ms
= (getnanotime() - t_begin
) / 1000000;
452 if (!quiet
&& advice_enabled(ADVICE_RESET_NO_REFRESH_WARNING
) && t_delta_in_ms
> REFRESH_INDEX_DELAY_WARNING_IN_MS
) {
453 advise(_("It took %.2f seconds to refresh the index after reset. You can use\n"
454 "'--no-refresh' to avoid this."), t_delta_in_ms
/ 1000.0);
458 struct object_id dummy
;
462 dwim_ref(rev
, strlen(rev
), &dummy
, &ref
, 0);
463 if (ref
&& !starts_with(ref
, "refs/"))
466 err
= reset_index(ref
, &oid
, reset_type
, quiet
);
467 if (reset_type
== KEEP
&& !err
)
468 err
= reset_index(ref
, &oid
, MIXED
, quiet
);
470 die(_("Could not reset index file to revision '%s'."), rev
);
474 if (write_locked_index(&the_index
, &lock
, COMMIT_LOCK
))
475 die(_("Could not write new index file."));
478 if (!pathspec
.nr
&& !unborn
) {
479 /* Any resets without paths update HEAD to the head being
480 * switched to, saving the previous head in ORIG_HEAD before. */
481 update_ref_status
= reset_refs(rev
, &oid
);
483 if (reset_type
== HARD
&& !update_ref_status
&& !quiet
)
484 print_new_head_line(lookup_commit_reference(the_repository
, &oid
));
487 remove_branch_state(the_repository
, 0);
489 return update_ref_status
;