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