builtin / reset.con commit reset [--mixed]: only write index file once (bc41bf4)
   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#include "builtin.h"
  11#include "tag.h"
  12#include "object.h"
  13#include "commit.h"
  14#include "run-command.h"
  15#include "refs.h"
  16#include "diff.h"
  17#include "diffcore.h"
  18#include "tree.h"
  19#include "branch.h"
  20#include "parse-options.h"
  21#include "unpack-trees.h"
  22#include "cache-tree.h"
  23
  24static const char * const git_reset_usage[] = {
  25        N_("git reset [--mixed | --soft | --hard | --merge | --keep] [-q] [<commit>]"),
  26        N_("git reset [-q] <commit> [--] <paths>..."),
  27        N_("git reset --patch [<commit>] [--] [<paths>...]"),
  28        NULL
  29};
  30
  31enum reset_type { MIXED, SOFT, HARD, MERGE, KEEP, NONE };
  32static const char *reset_type_names[] = {
  33        N_("mixed"), N_("soft"), N_("hard"), N_("merge"), N_("keep"), NULL
  34};
  35
  36static inline int is_merge(void)
  37{
  38        return !access(git_path("MERGE_HEAD"), F_OK);
  39}
  40
  41static int reset_index(const unsigned char *sha1, int reset_type, int quiet)
  42{
  43        int nr = 1;
  44        struct tree_desc desc[2];
  45        struct tree *tree;
  46        struct unpack_trees_options opts;
  47
  48        memset(&opts, 0, sizeof(opts));
  49        opts.head_idx = 1;
  50        opts.src_index = &the_index;
  51        opts.dst_index = &the_index;
  52        opts.fn = oneway_merge;
  53        opts.merge = 1;
  54        if (!quiet)
  55                opts.verbose_update = 1;
  56        switch (reset_type) {
  57        case KEEP:
  58        case MERGE:
  59                opts.update = 1;
  60                break;
  61        case HARD:
  62                opts.update = 1;
  63                /* fallthrough */
  64        default:
  65                opts.reset = 1;
  66        }
  67
  68        read_cache_unmerged();
  69
  70        if (reset_type == KEEP) {
  71                unsigned char head_sha1[20];
  72                if (get_sha1("HEAD", head_sha1))
  73                        return error(_("You do not have a valid HEAD."));
  74                if (!fill_tree_descriptor(desc, head_sha1))
  75                        return error(_("Failed to find tree of HEAD."));
  76                nr++;
  77                opts.fn = twoway_merge;
  78        }
  79
  80        if (!fill_tree_descriptor(desc + nr - 1, sha1))
  81                return error(_("Failed to find tree of %s."), sha1_to_hex(sha1));
  82        if (unpack_trees(nr, desc, &opts))
  83                return -1;
  84
  85        if (reset_type == MIXED || reset_type == HARD) {
  86                tree = parse_tree_indirect(sha1);
  87                prime_cache_tree(&active_cache_tree, tree);
  88        }
  89
  90        return 0;
  91}
  92
  93static void print_new_head_line(struct commit *commit)
  94{
  95        const char *hex, *body;
  96
  97        hex = find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV);
  98        printf(_("HEAD is now at %s"), hex);
  99        body = strstr(commit->buffer, "\n\n");
 100        if (body) {
 101                const char *eol;
 102                size_t len;
 103                body += 2;
 104                eol = strchr(body, '\n');
 105                len = eol ? eol - body : strlen(body);
 106                printf(" %.*s\n", (int) len, body);
 107        }
 108        else
 109                printf("\n");
 110}
 111
 112static void update_index_refresh(int flags)
 113{
 114        refresh_index(&the_index, (flags), NULL, NULL,
 115                      _("Unstaged changes after reset:"));
 116}
 117
 118static void update_index_from_diff(struct diff_queue_struct *q,
 119                struct diff_options *opt, void *data)
 120{
 121        int i;
 122
 123        for (i = 0; i < q->nr; i++) {
 124                struct diff_filespec *one = q->queue[i]->one;
 125                if (one->mode && !is_null_sha1(one->sha1)) {
 126                        struct cache_entry *ce;
 127                        ce = make_cache_entry(one->mode, one->sha1, one->path,
 128                                0, 0);
 129                        if (!ce)
 130                                die(_("make_cache_entry failed for path '%s'"),
 131                                    one->path);
 132                        add_cache_entry(ce, ADD_CACHE_OK_TO_ADD |
 133                                ADD_CACHE_OK_TO_REPLACE);
 134                } else
 135                        remove_file_from_cache(one->path);
 136        }
 137}
 138
 139static int read_from_tree(const char **pathspec, unsigned char *tree_sha1)
 140{
 141        struct diff_options opt;
 142
 143        memset(&opt, 0, sizeof(opt));
 144        diff_tree_setup_paths(pathspec, &opt);
 145        opt.output_format = DIFF_FORMAT_CALLBACK;
 146        opt.format_callback = update_index_from_diff;
 147
 148        read_cache();
 149        if (do_diff_cache(tree_sha1, &opt))
 150                return 1;
 151        diffcore_std(&opt);
 152        diff_flush(&opt);
 153        diff_tree_release_paths(&opt);
 154
 155        return 0;
 156}
 157
 158static void set_reflog_message(struct strbuf *sb, const char *action,
 159                               const char *rev)
 160{
 161        const char *rla = getenv("GIT_REFLOG_ACTION");
 162
 163        strbuf_reset(sb);
 164        if (rla)
 165                strbuf_addf(sb, "%s: %s", rla, action);
 166        else if (rev)
 167                strbuf_addf(sb, "reset: moving to %s", rev);
 168        else
 169                strbuf_addf(sb, "reset: %s", action);
 170}
 171
 172static void die_if_unmerged_cache(int reset_type)
 173{
 174        if (is_merge() || read_cache() < 0 || unmerged_cache())
 175                die(_("Cannot do a %s reset in the middle of a merge."),
 176                    _(reset_type_names[reset_type]));
 177
 178}
 179
 180static const char **parse_args(const char **argv, const char *prefix, const char **rev_ret)
 181{
 182        const char *rev = "HEAD";
 183        unsigned char unused[20];
 184        /*
 185         * Possible arguments are:
 186         *
 187         * git reset [-opts] <rev> <paths>...
 188         * git reset [-opts] <rev> -- <paths>...
 189         * git reset [-opts] -- <paths>...
 190         * git reset [-opts] <paths>...
 191         *
 192         * At this point, argv points immediately after [-opts].
 193         */
 194
 195        if (argv[0]) {
 196                if (!strcmp(argv[0], "--")) {
 197                        argv++; /* reset to HEAD, possibly with paths */
 198                } else if (argv[1] && !strcmp(argv[1], "--")) {
 199                        rev = argv[0];
 200                        argv += 2;
 201                }
 202                /*
 203                 * Otherwise, argv[0] could be either <rev> or <paths> and
 204                 * has to be unambiguous.
 205                 */
 206                else if (!get_sha1_committish(argv[0], unused)) {
 207                        /*
 208                         * Ok, argv[0] looks like a rev; it should not
 209                         * be a filename.
 210                         */
 211                        verify_non_filename(prefix, argv[0]);
 212                        rev = *argv++;
 213                } else {
 214                        /* Otherwise we treat this as a filename */
 215                        verify_filename(prefix, argv[0], 1);
 216                }
 217        }
 218        *rev_ret = rev;
 219        return argv[0] ? get_pathspec(prefix, argv) : NULL;
 220}
 221
 222static int update_refs(const char *rev, const unsigned char *sha1)
 223{
 224        int update_ref_status;
 225        struct strbuf msg = STRBUF_INIT;
 226        unsigned char *orig = NULL, sha1_orig[20],
 227                *old_orig = NULL, sha1_old_orig[20];
 228
 229        if (!get_sha1("ORIG_HEAD", sha1_old_orig))
 230                old_orig = sha1_old_orig;
 231        if (!get_sha1("HEAD", sha1_orig)) {
 232                orig = sha1_orig;
 233                set_reflog_message(&msg, "updating ORIG_HEAD", NULL);
 234                update_ref(msg.buf, "ORIG_HEAD", orig, old_orig, 0, MSG_ON_ERR);
 235        } else if (old_orig)
 236                delete_ref("ORIG_HEAD", old_orig, 0);
 237        set_reflog_message(&msg, "updating HEAD", rev);
 238        update_ref_status = update_ref(msg.buf, "HEAD", sha1, orig, 0, MSG_ON_ERR);
 239        strbuf_release(&msg);
 240        return update_ref_status;
 241}
 242
 243int cmd_reset(int argc, const char **argv, const char *prefix)
 244{
 245        int reset_type = NONE, update_ref_status = 0, quiet = 0;
 246        int patch_mode = 0;
 247        const char *rev;
 248        unsigned char sha1[20];
 249        const char **pathspec = NULL;
 250        struct commit *commit;
 251        const struct option options[] = {
 252                OPT__QUIET(&quiet, N_("be quiet, only report errors")),
 253                OPT_SET_INT(0, "mixed", &reset_type,
 254                                                N_("reset HEAD and index"), MIXED),
 255                OPT_SET_INT(0, "soft", &reset_type, N_("reset only HEAD"), SOFT),
 256                OPT_SET_INT(0, "hard", &reset_type,
 257                                N_("reset HEAD, index and working tree"), HARD),
 258                OPT_SET_INT(0, "merge", &reset_type,
 259                                N_("reset HEAD, index and working tree"), MERGE),
 260                OPT_SET_INT(0, "keep", &reset_type,
 261                                N_("reset HEAD but keep local changes"), KEEP),
 262                OPT_BOOLEAN('p', "patch", &patch_mode, N_("select hunks interactively")),
 263                OPT_END()
 264        };
 265
 266        git_config(git_default_config, NULL);
 267
 268        argc = parse_options(argc, argv, prefix, options, git_reset_usage,
 269                                                PARSE_OPT_KEEP_DASHDASH);
 270        pathspec = parse_args(argv, prefix, &rev);
 271
 272        if (get_sha1_committish(rev, sha1))
 273                die(_("Failed to resolve '%s' as a valid ref."), rev);
 274
 275        /*
 276         * NOTE: As "git reset $treeish -- $path" should be usable on
 277         * any tree-ish, this is not strictly correct. We are not
 278         * moving the HEAD to any commit; we are merely resetting the
 279         * entries in the index to that of a treeish.
 280         */
 281        commit = lookup_commit_reference(sha1);
 282        if (!commit)
 283                die(_("Could not parse object '%s'."), rev);
 284        hashcpy(sha1, commit->object.sha1);
 285
 286        if (patch_mode) {
 287                if (reset_type != NONE)
 288                        die(_("--patch is incompatible with --{hard,mixed,soft}"));
 289                return run_add_interactive(rev, "--patch=reset", pathspec);
 290        }
 291
 292        /* git reset tree [--] paths... can be used to
 293         * load chosen paths from the tree into the index without
 294         * affecting the working tree nor HEAD. */
 295        if (pathspec) {
 296                if (reset_type == MIXED)
 297                        warning(_("--mixed with paths is deprecated; use 'git reset -- <paths>' instead."));
 298                else if (reset_type != NONE)
 299                        die(_("Cannot do %s reset with paths."),
 300                                        _(reset_type_names[reset_type]));
 301        }
 302        if (reset_type == NONE)
 303                reset_type = MIXED; /* by default */
 304
 305        if (reset_type != SOFT && reset_type != MIXED)
 306                setup_work_tree();
 307
 308        if (reset_type == MIXED && is_bare_repository())
 309                die(_("%s reset is not allowed in a bare repository"),
 310                    _(reset_type_names[reset_type]));
 311
 312        if (pathspec) {
 313                struct lock_file *lock = xcalloc(1, sizeof(struct lock_file));
 314                int index_fd = hold_locked_index(lock, 1);
 315                if (read_from_tree(pathspec, sha1))
 316                        return 1;
 317                update_index_refresh(
 318                        quiet ? REFRESH_QUIET : REFRESH_IN_PORCELAIN);
 319                if (write_cache(index_fd, active_cache, active_nr) ||
 320                    commit_locked_index(lock))
 321                        return error("Could not write new index file.");
 322                return 0;
 323        }
 324
 325        /* Soft reset does not touch the index file nor the working tree
 326         * at all, but requires them in a good order.  Other resets reset
 327         * the index file to the tree object we are switching to. */
 328        if (reset_type == SOFT || reset_type == KEEP)
 329                die_if_unmerged_cache(reset_type);
 330
 331        if (reset_type != SOFT) {
 332                struct lock_file *lock = xcalloc(1, sizeof(struct lock_file));
 333                int newfd = hold_locked_index(lock, 1);
 334                int err = reset_index(sha1, reset_type, quiet);
 335                if (reset_type == KEEP && !err)
 336                        err = reset_index(sha1, MIXED, quiet);
 337                if (err)
 338                        die(_("Could not reset index file to revision '%s'."), rev);
 339
 340                if (reset_type == MIXED) /* Report what has not been updated. */
 341                        update_index_refresh(
 342                                quiet ? REFRESH_QUIET : REFRESH_IN_PORCELAIN);
 343
 344                if (write_cache(newfd, active_cache, active_nr) ||
 345                    commit_locked_index(lock))
 346                        die(_("Could not write new index file."));
 347        }
 348
 349        /* Any resets update HEAD to the head being switched to,
 350         * saving the previous head in ORIG_HEAD before. */
 351        update_ref_status = update_refs(rev, sha1);
 352
 353        if (reset_type == HARD && !update_ref_status && !quiet)
 354                print_new_head_line(commit);
 355
 356        remove_branch_state();
 357
 358        return update_ref_status;
 359}