builtin/reset.c

   1 /*
   2  * "git reset" builtin command
   3  *
   4  * Copyright (c) 2007 Carlos Rica
   5  *
   6  * Based on git-reset.sh, which is
   7  *
   8  * Copyright (c) 2005, 2006 Linus Torvalds and Junio C Hamano
   9  */
  10 #define USE_THE_INDEX_VARIABLE
  11 #include "builtin.h"
  12 #include "advice.h"
  13 #include "config.h"
  14 #include "environment.h"
  15 #include "gettext.h"
  16 #include "hash.h"
  17 #include "hex.h"
  18 #include "lockfile.h"
  19 #include "object.h"
  20 #include "pretty.h"
  21 #include "refs.h"
  22 #include "diff.h"
  23 #include "diffcore.h"
  24 #include "tree.h"
  25 #include "branch.h"
  26 #include "object-name.h"
  27 #include "parse-options.h"
  28 #include "path.h"
  29 #include "unpack-trees.h"
  30 #include "cache-tree.h"
  31 #include "setup.h"
  32 #include "sparse-index.h"
  33 #include "submodule.h"
  34 #include "trace.h"
  35 #include "trace2.h"
  36 #include "dir.h"
  37 #include "add-interactive.h"
  38
  39 #define REFRESH_INDEX_DELAY_WARNING_IN_MS (2 * 1000)
  40
  41 static const char * const git_reset_usage[] = {
  42         N_("git reset [--mixed | --soft | --hard | --merge | --keep] [-q] [<commit>]"),
  43         N_("git reset [-q] [<tree-ish>] [--] <pathspec>..."),
  44         N_("git reset [-q] [--pathspec-from-file [--pathspec-file-nul]] [<tree-ish>]"),
  45         N_("git reset --patch [<tree-ish>] [--] [<pathspec>...]"),
  46         NULL
  47 };
  48
  49 enum reset_type { MIXED, SOFT, HARD, MERGE, KEEP, NONE };
  50 static const char *reset_type_names[] = {
  51         N_("mixed"), N_("soft"), N_("hard"), N_("merge"), N_("keep"), NULL
  52 };
  53
  54 static inline int is_merge(void)
  55 {
  56         return !access(git_path_merge_head(the_repository), F_OK);
  57 }
  58
  59 static int reset_index(const char *ref, const struct object_id *oid, int reset_type, int quiet)
  60 {
  61         int i, nr = 0;
  62         struct tree_desc desc[2];
  63         struct tree *tree;
  64         struct unpack_trees_options opts;
  65         int ret = -1;
  66
  67         memset(&opts, 0, sizeof(opts));
  68         opts.head_idx = 1;
  69         opts.src_index = &the_index;
  70         opts.dst_index = &the_index;
  71         opts.fn = oneway_merge;
  72         opts.merge = 1;
  73         init_checkout_metadata(&opts.meta, ref, oid, NULL);
  74         if (!quiet)
  75                 opts.verbose_update = 1;
  76         switch (reset_type) {
  77         case KEEP:
  78         case MERGE:
  79                 opts.update = 1;
  80                 opts.preserve_ignored = 0; /* FIXME: !overwrite_ignore */
  81                 break;
  82         case HARD:
  83                 opts.update = 1;
  84                 opts.reset = UNPACK_RESET_OVERWRITE_UNTRACKED;
  85                 opts.skip_cache_tree_update = 1;
  86                 break;
  87         case MIXED:
  88                 opts.reset = UNPACK_RESET_PROTECT_UNTRACKED;
  89                 opts.skip_cache_tree_update = 1;
  90                 /* but opts.update=0, so working tree not updated */
  91                 break;
  92         default:
  93                 BUG("invalid reset_type passed to reset_index");
  94         }
  95
  96         repo_read_index_unmerged(the_repository);
  97
  98         if (reset_type == KEEP) {
  99                 struct object_id head_oid;
 100                 if (repo_get_oid(the_repository, "HEAD", &head_oid))
 101                         return error(_("You do not have a valid HEAD."));
 102                 if (!fill_tree_descriptor(the_repository, desc + nr, &head_oid))
 103                         return error(_("Failed to find tree of HEAD."));
 104                 nr++;
 105                 opts.fn = twoway_merge;
 106         }
 107
 108         if (!fill_tree_descriptor(the_repository, desc + nr, oid)) {
 109                 error(_("Failed to find tree of %s."), oid_to_hex(oid));
 110                 goto out;
 111         }
 112         nr++;
 113
 114         if (unpack_trees(nr, desc, &opts))
 115                 goto out;
 116
 117         if (reset_type == MIXED || reset_type == HARD) {
 118                 tree = parse_tree_indirect(oid);
 119                 prime_cache_tree(the_repository, the_repository->index, tree);
 120         }
 121
 122         ret = 0;
 123
 124 out:
 125         for (i = 0; i < nr; i++)
 126                 free((void *)desc[i].buffer);
 127         return ret;
 128 }
 129
 130 static void print_new_head_line(struct commit *commit)
 131 {
 132         struct strbuf buf = STRBUF_INIT;
 133
 134         printf(_("HEAD is now at %s"),
 135                 repo_find_unique_abbrev(the_repository, &commit->object.oid, DEFAULT_ABBREV));
 136
 137         pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
 138         if (buf.len > 0)
 139                 printf(" %s", buf.buf);
 140         putchar('\n');
 141         strbuf_release(&buf);
 142 }
 143
 144 static void update_index_from_diff(struct diff_queue_struct *q,
 145                                    struct diff_options *opt UNUSED,
 146                                    void *data)
 147 {
 148         int i;
 149         int intent_to_add = *(int *)data;
 150
 151         for (i = 0; i < q->nr; i++) {
 152                 int pos;
 153                 struct diff_filespec *one = q->queue[i]->one;
 154                 int is_in_reset_tree = one->mode && !is_null_oid(&one->oid);
 155                 struct cache_entry *ce;
 156
 157                 if (!is_in_reset_tree && !intent_to_add) {
 158                         remove_file_from_index(&the_index, one->path);
 159                         continue;
 160                 }
 161
 162                 ce = make_cache_entry(&the_index, one->mode, &one->oid, one->path,
 163                                       0, 0);
 164
 165                 /*
 166                  * If the file 1) corresponds to an existing index entry with
 167                  * skip-worktree set, or 2) does not exist in the index but is
 168                  * outside the sparse checkout definition, add a skip-worktree bit
 169                  * to the new index entry. Note that a sparse index will be expanded
 170                  * if this entry is outside the sparse cone - this is necessary
 171                  * to properly construct the reset sparse directory.
 172                  */
 173                 pos = index_name_pos(&the_index, one->path, strlen(one->path));
 174                 if ((pos >= 0 && ce_skip_worktree(the_index.cache[pos])) ||
 175                     (pos < 0 && !path_in_sparse_checkout(one->path, &the_index)))
 176                         ce->ce_flags |= CE_SKIP_WORKTREE;
 177
 178                 if (!ce)
 179                         die(_("make_cache_entry failed for path '%s'"),
 180                             one->path);
 181                 if (!is_in_reset_tree) {
 182                         ce->ce_flags |= CE_INTENT_TO_ADD;
 183                         set_object_name_for_intent_to_add_entry(ce);
 184                 }
 185                 add_index_entry(&the_index, ce,
 186                                 ADD_CACHE_OK_TO_ADD | ADD_CACHE_OK_TO_REPLACE);
 187         }
 188 }
 189
 190 static int read_from_tree(const struct pathspec *pathspec,
 191                           struct object_id *tree_oid,
 192                           int intent_to_add)
 193 {
 194         struct diff_options opt;
 195
 196         memset(&opt, 0, sizeof(opt));
 197         copy_pathspec(&opt.pathspec, pathspec);
 198         opt.output_format = DIFF_FORMAT_CALLBACK;
 199         opt.format_callback = update_index_from_diff;
 200         opt.format_callback_data = &intent_to_add;
 201         opt.flags.override_submodule_config = 1;
 202         opt.flags.recursive = 1;
 203         opt.repo = the_repository;
 204         opt.change = diff_change;
 205         opt.add_remove = diff_addremove;
 206
 207         if (pathspec->nr && pathspec_needs_expanded_index(&the_index, pathspec))
 208                 ensure_full_index(&the_index);
 209
 210         if (do_diff_cache(tree_oid, &opt))
 211                 return 1;
 212         diffcore_std(&opt);
 213         diff_flush(&opt);
 214
 215         return 0;
 216 }
 217
 218 static void set_reflog_message(struct strbuf *sb, const char *action,
 219                                const char *rev)
 220 {
 221         const char *rla = getenv("GIT_REFLOG_ACTION");
 222
 223         strbuf_reset(sb);
 224         if (rla)
 225                 strbuf_addf(sb, "%s: %s", rla, action);
 226         else if (rev)
 227                 strbuf_addf(sb, "reset: moving to %s", rev);
 228         else
 229                 strbuf_addf(sb, "reset: %s", action);
 230 }
 231
 232 static void die_if_unmerged_cache(int reset_type)
 233 {
 234         if (is_merge() || unmerged_index(&the_index))
 235                 die(_("Cannot do a %s reset in the middle of a merge."),
 236                     _(reset_type_names[reset_type]));
 237
 238 }
 239
 240 static void parse_args(struct pathspec *pathspec,
 241                        const char **argv, const char *prefix,
 242                        int patch_mode,
 243                        const char **rev_ret)
 244 {
 245         const char *rev = "HEAD";
 246         struct object_id unused;
 247         /*
 248          * Possible arguments are:
 249          *
 250          * git reset [-opts] [<rev>]
 251          * git reset [-opts] <tree> [<paths>...]
 252          * git reset [-opts] <tree> -- [<paths>...]
 253          * git reset [-opts] -- [<paths>...]
 254          * git reset [-opts] <paths>...
 255          *
 256          * At this point, argv points immediately after [-opts].
 257          */
 258
 259         if (argv[0]) {
 260                 if (!strcmp(argv[0], "--")) {
 261                         argv++; /* reset to HEAD, possibly with paths */
 262                 } else if (argv[1] && !strcmp(argv[1], "--")) {
 263                         rev = argv[0];
 264                         argv += 2;
 265                 }
 266                 /*
 267                  * Otherwise, argv[0] could be either <rev> or <paths> and
 268                  * has to be unambiguous. If there is a single argument, it
 269                  * can not be a tree
 270                  */
 271                 else if ((!argv[1] && !repo_get_oid_committish(the_repository, argv[0], &unused)) ||
 272                          (argv[1] && !repo_get_oid_treeish(the_repository, argv[0], &unused))) {
 273                         /*
 274                          * Ok, argv[0] looks like a commit/tree; it should not
 275                          * be a filename.
 276                          */
 277                         verify_non_filename(prefix, argv[0]);
 278                         rev = *argv++;
 279                 } else {
 280                         /* Otherwise we treat this as a filename */
 281                         verify_filename(prefix, argv[0], 1);
 282                 }
 283         }
 284         *rev_ret = rev;
 285
 286         parse_pathspec(pathspec, 0,
 287                        PATHSPEC_PREFER_FULL |
 288                        (patch_mode ? PATHSPEC_PREFIX_ORIGIN : 0),
 289                        prefix, argv);
 290 }
 291
 292 static int reset_refs(const char *rev, const struct object_id *oid)
 293 {
 294         int update_ref_status;
 295         struct strbuf msg = STRBUF_INIT;
 296         struct object_id *orig = NULL, oid_orig,
 297                 *old_orig = NULL, oid_old_orig;
 298
 299         if (!repo_get_oid(the_repository, "ORIG_HEAD", &oid_old_orig))
 300                 old_orig = &oid_old_orig;
 301         if (!repo_get_oid(the_repository, "HEAD", &oid_orig)) {
 302                 orig = &oid_orig;
 303                 set_reflog_message(&msg, "updating ORIG_HEAD", NULL);
 304                 update_ref(msg.buf, "ORIG_HEAD", orig, old_orig, 0,
 305                            UPDATE_REFS_MSG_ON_ERR);
 306         } else if (old_orig)
 307                 delete_ref(NULL, "ORIG_HEAD", old_orig, 0);
 308         set_reflog_message(&msg, "updating HEAD", rev);
 309         update_ref_status = update_ref(msg.buf, "HEAD", oid, orig, 0,
 310                                        UPDATE_REFS_MSG_ON_ERR);
 311         strbuf_release(&msg);
 312         return update_ref_status;
 313 }
 314
 315 static int git_reset_config(const char *var, const char *value,
 316                             const struct config_context *ctx, void *cb)
 317 {
 318         if (!strcmp(var, "submodule.recurse"))
 319                 return git_default_submodule_config(var, value, cb);
 320
 321         return git_default_config(var, value, ctx, cb);
 322 }
 323
 324 int cmd_reset(int argc, const char **argv, const char *prefix)
 325 {
 326         int reset_type = NONE, update_ref_status = 0, quiet = 0;
 327         int no_refresh = 0;
 328         int patch_mode = 0, pathspec_file_nul = 0, unborn;
 329         const char *rev;
 330         char *pathspec_from_file = NULL;
 331         struct object_id oid;
 332         struct pathspec pathspec;
 333         int intent_to_add = 0;
 334         const struct option options[] = {
 335                 OPT__QUIET(&quiet, N_("be quiet, only report errors")),
 336                 OPT_BOOL(0, "no-refresh", &no_refresh,
 337                                 N_("skip refreshing the index after reset")),
 338                 OPT_SET_INT_F(0, "mixed", &reset_type,
 339                               N_("reset HEAD and index"),
 340                               MIXED, PARSE_OPT_NONEG),
 341                 OPT_SET_INT_F(0, "soft", &reset_type,
 342                               N_("reset only HEAD"),
 343                               SOFT, PARSE_OPT_NONEG),
 344                 OPT_SET_INT_F(0, "hard", &reset_type,
 345                               N_("reset HEAD, index and working tree"),
 346                               HARD, PARSE_OPT_NONEG),
 347                 OPT_SET_INT_F(0, "merge", &reset_type,
 348                               N_("reset HEAD, index and working tree"),
 349                               MERGE, PARSE_OPT_NONEG),
 350                 OPT_SET_INT_F(0, "keep", &reset_type,
 351                               N_("reset HEAD but keep local changes"),
 352                               KEEP, PARSE_OPT_NONEG),
 353                 OPT_CALLBACK_F(0, "recurse-submodules", NULL,
 354                                "reset", "control recursive updating of submodules",
 355                                PARSE_OPT_OPTARG,
 356                                option_parse_recurse_submodules_worktree_updater),
 357                 OPT_BOOL('p', "patch", &patch_mode, N_("select hunks interactively")),
 358                 OPT_BOOL('N', "intent-to-add", &intent_to_add,
 359                                 N_("record only the fact that removed paths will be added later")),
 360                 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file),
 361                 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul),
 362                 OPT_END()
 363         };
 364
 365         git_config(git_reset_config, NULL);
 366
 367         argc = parse_options(argc, argv, prefix, options, git_reset_usage,
 368                                                 PARSE_OPT_KEEP_DASHDASH);
 369         parse_args(&pathspec, argv, prefix, patch_mode, &rev);
 370
 371         if (pathspec_from_file) {
 372                 if (patch_mode)
 373                         die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--patch");
 374
 375                 if (pathspec.nr)
 376                         die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
 377
 378                 parse_pathspec_file(&pathspec, 0,
 379                                     PATHSPEC_PREFER_FULL,
 380                                     prefix, pathspec_from_file, pathspec_file_nul);
 381         } else if (pathspec_file_nul) {
 382                 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
 383         }
 384
 385         unborn = !strcmp(rev, "HEAD") && repo_get_oid(the_repository, "HEAD",
 386                                                       &oid);
 387         if (unborn) {
 388                 /* reset on unborn branch: treat as reset to empty tree */
 389                 oidcpy(&oid, the_hash_algo->empty_tree);
 390         } else if (!pathspec.nr && !patch_mode) {
 391                 struct commit *commit;
 392                 if (repo_get_oid_committish(the_repository, rev, &oid))
 393                         die(_("Failed to resolve '%s' as a valid revision."), rev);
 394                 commit = lookup_commit_reference(the_repository, &oid);
 395                 if (!commit)
 396                         die(_("Could not parse object '%s'."), rev);
 397                 oidcpy(&oid, &commit->object.oid);
 398         } else {
 399                 struct tree *tree;
 400                 if (repo_get_oid_treeish(the_repository, rev, &oid))
 401                         die(_("Failed to resolve '%s' as a valid tree."), rev);
 402                 tree = parse_tree_indirect(&oid);
 403                 if (!tree)
 404                         die(_("Could not parse object '%s'."), rev);
 405                 oidcpy(&oid, &tree->object.oid);
 406         }
 407
 408         if (patch_mode) {
 409                 if (reset_type != NONE)
 410                         die(_("options '%s' and '%s' cannot be used together"), "--patch", "--{hard,mixed,soft}");
 411                 trace2_cmd_mode("patch-interactive");
 412                 update_ref_status = !!run_add_p(the_repository, ADD_P_RESET, rev,
 413                                    &pathspec);
 414                 goto cleanup;
 415         }
 416
 417         /* git reset tree [--] paths... can be used to
 418          * load chosen paths from the tree into the index without
 419          * affecting the working tree nor HEAD. */
 420         if (pathspec.nr) {
 421                 if (reset_type == MIXED)
 422                         warning(_("--mixed with paths is deprecated; use 'git reset -- <paths>' instead."));
 423                 else if (reset_type != NONE)
 424                         die(_("Cannot do %s reset with paths."),
 425                                         _(reset_type_names[reset_type]));
 426         }
 427         if (reset_type == NONE)
 428                 reset_type = MIXED; /* by default */
 429
 430         if (pathspec.nr)
 431                 trace2_cmd_mode("path");
 432         else
 433                 trace2_cmd_mode(reset_type_names[reset_type]);
 434
 435         if (reset_type != SOFT && (reset_type != MIXED || get_git_work_tree()))
 436                 setup_work_tree();
 437
 438         if (reset_type == MIXED && is_bare_repository())
 439                 die(_("%s reset is not allowed in a bare repository"),
 440                     _(reset_type_names[reset_type]));
 441
 442         if (intent_to_add && reset_type != MIXED)
 443                 die(_("the option '%s' requires '%s'"), "-N", "--mixed");
 444
 445         prepare_repo_settings(the_repository);
 446         the_repository->settings.command_requires_full_index = 0;
 447
 448         if (repo_read_index(the_repository) < 0)
 449                 die(_("index file corrupt"));
 450
 451         /* Soft reset does not touch the index file nor the working tree
 452          * at all, but requires them in a good order.  Other resets reset
 453          * the index file to the tree object we are switching to. */
 454         if (reset_type == SOFT || reset_type == KEEP)
 455                 die_if_unmerged_cache(reset_type);
 456
 457         if (reset_type != SOFT) {
 458                 struct lock_file lock = LOCK_INIT;
 459                 repo_hold_locked_index(the_repository, &lock,
 460                                        LOCK_DIE_ON_ERROR);
 461                 if (reset_type == MIXED) {
 462                         int flags = quiet ? REFRESH_QUIET : REFRESH_IN_PORCELAIN;
 463                         if (read_from_tree(&pathspec, &oid, intent_to_add)) {
 464                                 update_ref_status = 1;
 465                                 goto cleanup;
 466                         }
 467                         the_index.updated_skipworktree = 1;
 468                         if (!no_refresh && get_git_work_tree()) {
 469                                 uint64_t t_begin, t_delta_in_ms;
 470
 471                                 t_begin = getnanotime();
 472                                 refresh_index(&the_index, flags, NULL, NULL,
 473                                               _("Unstaged changes after reset:"));
 474                                 t_delta_in_ms = (getnanotime() - t_begin) / 1000000;
 475                                 if (!quiet && advice_enabled(ADVICE_RESET_NO_REFRESH_WARNING) && t_delta_in_ms > REFRESH_INDEX_DELAY_WARNING_IN_MS) {
 476                                         advise(_("It took %.2f seconds to refresh the index after reset.  You can use\n"
 477                                                  "'--no-refresh' to avoid this."), t_delta_in_ms / 1000.0);
 478                                 }
 479                         }
 480                 } else {
 481                         struct object_id dummy;
 482                         char *ref = NULL;
 483                         int err;
 484
 485                         repo_dwim_ref(the_repository, rev, strlen(rev),
 486                                       &dummy, &ref, 0);
 487                         if (ref && !starts_with(ref, "refs/"))
 488                                 FREE_AND_NULL(ref);
 489
 490                         err = reset_index(ref, &oid, reset_type, quiet);
 491                         if (reset_type == KEEP && !err)
 492                                 err = reset_index(ref, &oid, MIXED, quiet);
 493                         if (err)
 494                                 die(_("Could not reset index file to revision '%s'."), rev);
 495                         free(ref);
 496                 }
 497
 498                 if (write_locked_index(&the_index, &lock, COMMIT_LOCK))
 499                         die(_("Could not write new index file."));
 500         }
 501
 502         if (!pathspec.nr && !unborn) {
 503                 /* Any resets without paths update HEAD to the head being
 504                  * switched to, saving the previous head in ORIG_HEAD before. */
 505                 update_ref_status = reset_refs(rev, &oid);
 506
 507                 if (reset_type == HARD && !update_ref_status && !quiet)
 508                         print_new_head_line(lookup_commit_reference(the_repository, &oid));
 509         }
 510         if (!pathspec.nr)
 511                 remove_branch_state(the_repository, 0);
 512
 513         discard_index(&the_index);
 514
 515 cleanup:
 516         clear_pathspec(&pathspec);
 517         free(pathspec_from_file);
 518         return update_ref_status;
 519 }