builtin-revert.con commit Merge git://git.kernel.org/pub/scm/gitk/gitk (35d2f73)
   1#include "cache.h"
   2#include "builtin.h"
   3#include "object.h"
   4#include "commit.h"
   5#include "tag.h"
   6#include "wt-status.h"
   7#include "run-command.h"
   8#include "exec_cmd.h"
   9#include "utf8.h"
  10#include "parse-options.h"
  11#include "cache-tree.h"
  12#include "diff.h"
  13#include "revision.h"
  14#include "rerere.h"
  15#include "merge-recursive.h"
  16
  17/*
  18 * This implements the builtins revert and cherry-pick.
  19 *
  20 * Copyright (c) 2007 Johannes E. Schindelin
  21 *
  22 * Based on git-revert.sh, which is
  23 *
  24 * Copyright (c) 2005 Linus Torvalds
  25 * Copyright (c) 2005 Junio C Hamano
  26 */
  27
  28static const char * const revert_usage[] = {
  29        "git revert [options] <commit-ish>",
  30        NULL
  31};
  32
  33static const char * const cherry_pick_usage[] = {
  34        "git cherry-pick [options] <commit-ish>",
  35        NULL
  36};
  37
  38static int edit, no_replay, no_commit, mainline, signoff;
  39static enum { REVERT, CHERRY_PICK } action;
  40static struct commit *commit;
  41
  42static const char *me;
  43
  44#define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
  45
  46static void parse_args(int argc, const char **argv)
  47{
  48        const char * const * usage_str =
  49                action == REVERT ?  revert_usage : cherry_pick_usage;
  50        unsigned char sha1[20];
  51        const char *arg;
  52        int noop;
  53        struct option options[] = {
  54                OPT_BOOLEAN('n', "no-commit", &no_commit, "don't automatically commit"),
  55                OPT_BOOLEAN('e', "edit", &edit, "edit the commit message"),
  56                OPT_BOOLEAN('x', NULL, &no_replay, "append commit name when cherry-picking"),
  57                OPT_BOOLEAN('r', NULL, &noop, "no-op (backward compatibility)"),
  58                OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
  59                OPT_INTEGER('m', "mainline", &mainline, "parent number"),
  60                OPT_END(),
  61        };
  62
  63        if (parse_options(argc, argv, options, usage_str, 0) != 1)
  64                usage_with_options(usage_str, options);
  65        arg = argv[0];
  66
  67        if (get_sha1(arg, sha1))
  68                die ("Cannot find '%s'", arg);
  69        commit = (struct commit *)parse_object(sha1);
  70        if (!commit)
  71                die ("Could not find %s", sha1_to_hex(sha1));
  72        if (commit->object.type == OBJ_TAG) {
  73                commit = (struct commit *)
  74                        deref_tag((struct object *)commit, arg, strlen(arg));
  75        }
  76        if (commit->object.type != OBJ_COMMIT)
  77                die ("'%s' does not point to a commit", arg);
  78}
  79
  80static char *get_oneline(const char *message)
  81{
  82        char *result;
  83        const char *p = message, *abbrev, *eol;
  84        int abbrev_len, oneline_len;
  85
  86        if (!p)
  87                die ("Could not read commit message of %s",
  88                                sha1_to_hex(commit->object.sha1));
  89        while (*p && (*p != '\n' || p[1] != '\n'))
  90                p++;
  91
  92        if (*p) {
  93                p += 2;
  94                for (eol = p + 1; *eol && *eol != '\n'; eol++)
  95                        ; /* do nothing */
  96        } else
  97                eol = p;
  98        abbrev = find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV);
  99        abbrev_len = strlen(abbrev);
 100        oneline_len = eol - p;
 101        result = xmalloc(abbrev_len + 5 + oneline_len);
 102        memcpy(result, abbrev, abbrev_len);
 103        memcpy(result + abbrev_len, "... ", 4);
 104        memcpy(result + abbrev_len + 4, p, oneline_len);
 105        result[abbrev_len + 4 + oneline_len] = '\0';
 106        return result;
 107}
 108
 109static char *get_encoding(const char *message)
 110{
 111        const char *p = message, *eol;
 112
 113        if (!p)
 114                die ("Could not read commit message of %s",
 115                                sha1_to_hex(commit->object.sha1));
 116        while (*p && *p != '\n') {
 117                for (eol = p + 1; *eol && *eol != '\n'; eol++)
 118                        ; /* do nothing */
 119                if (!prefixcmp(p, "encoding ")) {
 120                        char *result = xmalloc(eol - 8 - p);
 121                        strlcpy(result, p + 9, eol - 8 - p);
 122                        return result;
 123                }
 124                p = eol;
 125                if (*p == '\n')
 126                        p++;
 127        }
 128        return NULL;
 129}
 130
 131static struct lock_file msg_file;
 132static int msg_fd;
 133
 134static void add_to_msg(const char *string)
 135{
 136        int len = strlen(string);
 137        if (write_in_full(msg_fd, string, len) < 0)
 138                die ("Could not write to MERGE_MSG");
 139}
 140
 141static void add_message_to_msg(const char *message)
 142{
 143        const char *p = message;
 144        while (*p && (*p != '\n' || p[1] != '\n'))
 145                p++;
 146
 147        if (!*p)
 148                add_to_msg(sha1_to_hex(commit->object.sha1));
 149
 150        p += 2;
 151        add_to_msg(p);
 152        return;
 153}
 154
 155static void set_author_ident_env(const char *message)
 156{
 157        const char *p = message;
 158        if (!p)
 159                die ("Could not read commit message of %s",
 160                                sha1_to_hex(commit->object.sha1));
 161        while (*p && *p != '\n') {
 162                const char *eol;
 163
 164                for (eol = p; *eol && *eol != '\n'; eol++)
 165                        ; /* do nothing */
 166                if (!prefixcmp(p, "author ")) {
 167                        char *line, *pend, *email, *timestamp;
 168
 169                        p += 7;
 170                        line = xmemdupz(p, eol - p);
 171                        email = strchr(line, '<');
 172                        if (!email)
 173                                die ("Could not extract author email from %s",
 174                                        sha1_to_hex(commit->object.sha1));
 175                        if (email == line)
 176                                pend = line;
 177                        else
 178                                for (pend = email; pend != line + 1 &&
 179                                                isspace(pend[-1]); pend--);
 180                                        ; /* do nothing */
 181                        *pend = '\0';
 182                        email++;
 183                        timestamp = strchr(email, '>');
 184                        if (!timestamp)
 185                                die ("Could not extract author time from %s",
 186                                        sha1_to_hex(commit->object.sha1));
 187                        *timestamp = '\0';
 188                        for (timestamp++; *timestamp && isspace(*timestamp);
 189                                        timestamp++)
 190                                ; /* do nothing */
 191                        setenv("GIT_AUTHOR_NAME", line, 1);
 192                        setenv("GIT_AUTHOR_EMAIL", email, 1);
 193                        setenv("GIT_AUTHOR_DATE", timestamp, 1);
 194                        free(line);
 195                        return;
 196                }
 197                p = eol;
 198                if (*p == '\n')
 199                        p++;
 200        }
 201        die ("No author information found in %s",
 202                        sha1_to_hex(commit->object.sha1));
 203}
 204
 205static char *help_msg(const unsigned char *sha1)
 206{
 207        static char helpbuf[1024];
 208        char *msg = getenv("GIT_CHERRY_PICK_HELP");
 209
 210        if (msg)
 211                return msg;
 212
 213        strcpy(helpbuf, "  After resolving the conflicts,\n"
 214               "mark the corrected paths with 'git add <paths>' "
 215               "or 'git rm <paths>' and commit the result.");
 216
 217        if (action == CHERRY_PICK) {
 218                sprintf(helpbuf + strlen(helpbuf),
 219                        "\nWhen commiting, use the option "
 220                        "'-c %s' to retain authorship and message.",
 221                        find_unique_abbrev(sha1, DEFAULT_ABBREV));
 222        }
 223        return helpbuf;
 224}
 225
 226static int index_is_dirty(void)
 227{
 228        struct rev_info rev;
 229        init_revisions(&rev, NULL);
 230        setup_revisions(0, NULL, &rev, "HEAD");
 231        DIFF_OPT_SET(&rev.diffopt, QUIET);
 232        DIFF_OPT_SET(&rev.diffopt, EXIT_WITH_STATUS);
 233        run_diff_index(&rev, 1);
 234        return !!DIFF_OPT_TST(&rev.diffopt, HAS_CHANGES);
 235}
 236
 237static struct tree *empty_tree(void)
 238{
 239        struct tree *tree = xcalloc(1, sizeof(struct tree));
 240
 241        tree->object.parsed = 1;
 242        tree->object.type = OBJ_TREE;
 243        pretend_sha1_file(NULL, 0, OBJ_TREE, tree->object.sha1);
 244        return tree;
 245}
 246
 247static int revert_or_cherry_pick(int argc, const char **argv)
 248{
 249        unsigned char head[20];
 250        struct commit *base, *next, *parent;
 251        int i, index_fd, clean;
 252        char *oneline, *reencoded_message = NULL;
 253        const char *message, *encoding;
 254        const char *defmsg = xstrdup(git_path("MERGE_MSG"));
 255        struct merge_options o;
 256        struct tree *result, *next_tree, *base_tree, *head_tree;
 257        static struct lock_file index_lock;
 258
 259        git_config(git_default_config, NULL);
 260        me = action == REVERT ? "revert" : "cherry-pick";
 261        setenv(GIT_REFLOG_ACTION, me, 0);
 262        parse_args(argc, argv);
 263
 264        /* this is copied from the shell script, but it's never triggered... */
 265        if (action == REVERT && !no_replay)
 266                die("revert is incompatible with replay");
 267
 268        if (read_cache() < 0)
 269                die("git %s: failed to read the index", me);
 270        if (no_commit) {
 271                /*
 272                 * We do not intend to commit immediately.  We just want to
 273                 * merge the differences in, so let's compute the tree
 274                 * that represents the "current" state for merge-recursive
 275                 * to work on.
 276                 */
 277                if (write_cache_as_tree(head, 0, NULL))
 278                        die ("Your index file is unmerged.");
 279        } else {
 280                if (get_sha1("HEAD", head))
 281                        die ("You do not have a valid HEAD");
 282                if (index_is_dirty())
 283                        die ("Dirty index: cannot %s", me);
 284        }
 285        discard_cache();
 286
 287        index_fd = hold_locked_index(&index_lock, 1);
 288
 289        if (!commit->parents) {
 290                if (action == REVERT)
 291                        die ("Cannot revert a root commit");
 292                parent = NULL;
 293        }
 294        else if (commit->parents->next) {
 295                /* Reverting or cherry-picking a merge commit */
 296                int cnt;
 297                struct commit_list *p;
 298
 299                if (!mainline)
 300                        die("Commit %s is a merge but no -m option was given.",
 301                            sha1_to_hex(commit->object.sha1));
 302
 303                for (cnt = 1, p = commit->parents;
 304                     cnt != mainline && p;
 305                     cnt++)
 306                        p = p->next;
 307                if (cnt != mainline || !p)
 308                        die("Commit %s does not have parent %d",
 309                            sha1_to_hex(commit->object.sha1), mainline);
 310                parent = p->item;
 311        } else if (0 < mainline)
 312                die("Mainline was specified but commit %s is not a merge.",
 313                    sha1_to_hex(commit->object.sha1));
 314        else
 315                parent = commit->parents->item;
 316
 317        if (!(message = commit->buffer))
 318                die ("Cannot get commit message for %s",
 319                                sha1_to_hex(commit->object.sha1));
 320
 321        if (parent && parse_commit(parent) < 0)
 322                die("%s: cannot parse parent commit %s",
 323                    me, sha1_to_hex(parent->object.sha1));
 324
 325        /*
 326         * "commit" is an existing commit.  We would want to apply
 327         * the difference it introduces since its first parent "prev"
 328         * on top of the current HEAD if we are cherry-pick.  Or the
 329         * reverse of it if we are revert.
 330         */
 331
 332        msg_fd = hold_lock_file_for_update(&msg_file, defmsg, 1);
 333
 334        encoding = get_encoding(message);
 335        if (!encoding)
 336                encoding = "utf-8";
 337        if (!git_commit_encoding)
 338                git_commit_encoding = "utf-8";
 339        if ((reencoded_message = reencode_string(message,
 340                                        git_commit_encoding, encoding)))
 341                message = reencoded_message;
 342
 343        oneline = get_oneline(message);
 344
 345        if (action == REVERT) {
 346                char *oneline_body = strchr(oneline, ' ');
 347
 348                base = commit;
 349                next = parent;
 350                add_to_msg("Revert \"");
 351                add_to_msg(oneline_body + 1);
 352                add_to_msg("\"\n\nThis reverts commit ");
 353                add_to_msg(sha1_to_hex(commit->object.sha1));
 354                add_to_msg(".\n");
 355        } else {
 356                base = parent;
 357                next = commit;
 358                set_author_ident_env(message);
 359                add_message_to_msg(message);
 360                if (no_replay) {
 361                        add_to_msg("(cherry picked from commit ");
 362                        add_to_msg(sha1_to_hex(commit->object.sha1));
 363                        add_to_msg(")\n");
 364                }
 365        }
 366
 367        read_cache();
 368        init_merge_options(&o);
 369        o.branch1 = "HEAD";
 370        o.branch2 = oneline;
 371
 372        head_tree = parse_tree_indirect(head);
 373        next_tree = next ? next->tree : empty_tree();
 374        base_tree = base ? base->tree : empty_tree();
 375
 376        clean = merge_trees(&o,
 377                            head_tree,
 378                            next_tree, base_tree, &result);
 379
 380        if (active_cache_changed &&
 381            (write_cache(index_fd, active_cache, active_nr) ||
 382             commit_locked_index(&index_lock)))
 383                die("%s: Unable to write new index file", me);
 384
 385        if (!clean) {
 386                add_to_msg("\nConflicts:\n\n");
 387                for (i = 0; i < active_nr;) {
 388                        struct cache_entry *ce = active_cache[i++];
 389                        if (ce_stage(ce)) {
 390                                add_to_msg("\t");
 391                                add_to_msg(ce->name);
 392                                add_to_msg("\n");
 393                                while (i < active_nr && !strcmp(ce->name,
 394                                                active_cache[i]->name))
 395                                        i++;
 396                        }
 397                }
 398                if (commit_lock_file(&msg_file) < 0)
 399                        die ("Error wrapping up %s", defmsg);
 400                fprintf(stderr, "Automatic %s failed.%s\n",
 401                        me, help_msg(commit->object.sha1));
 402                rerere();
 403                exit(1);
 404        }
 405        if (commit_lock_file(&msg_file) < 0)
 406                die ("Error wrapping up %s", defmsg);
 407        fprintf(stderr, "Finished one %s.\n", me);
 408
 409        /*
 410         *
 411         * If we are cherry-pick, and if the merge did not result in
 412         * hand-editing, we will hit this commit and inherit the original
 413         * author date and name.
 414         * If we are revert, or if our cherry-pick results in a hand merge,
 415         * we had better say that the current user is responsible for that.
 416         */
 417
 418        if (!no_commit) {
 419                /* 6 is max possible length of our args array including NULL */
 420                const char *args[6];
 421                int i = 0;
 422                args[i++] = "commit";
 423                args[i++] = "-n";
 424                if (signoff)
 425                        args[i++] = "-s";
 426                if (!edit) {
 427                        args[i++] = "-F";
 428                        args[i++] = defmsg;
 429                }
 430                args[i] = NULL;
 431                return execv_git_cmd(args);
 432        }
 433        free(reencoded_message);
 434
 435        return 0;
 436}
 437
 438int cmd_revert(int argc, const char **argv, const char *prefix)
 439{
 440        if (isatty(0))
 441                edit = 1;
 442        no_replay = 1;
 443        action = REVERT;
 444        return revert_or_cherry_pick(argc, argv);
 445}
 446
 447int cmd_cherry_pick(int argc, const char **argv, const char *prefix)
 448{
 449        no_replay = 0;
 450        action = CHERRY_PICK;
 451        return revert_or_cherry_pick(argc, argv);
 452}