builtin / revert.con commit Documentation: remove stray backslash in show-branch discussion (a521845)
   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#include "refs.h"
  17
  18/*
  19 * This implements the builtins revert and cherry-pick.
  20 *
  21 * Copyright (c) 2007 Johannes E. Schindelin
  22 *
  23 * Based on git-revert.sh, which is
  24 *
  25 * Copyright (c) 2005 Linus Torvalds
  26 * Copyright (c) 2005 Junio C Hamano
  27 */
  28
  29static const char * const revert_usage[] = {
  30        "git revert [options] <commit-ish>",
  31        NULL
  32};
  33
  34static const char * const cherry_pick_usage[] = {
  35        "git cherry-pick [options] <commit-ish>",
  36        NULL
  37};
  38
  39static int edit, no_replay, no_commit, mainline, signoff, allow_ff;
  40static enum { REVERT, CHERRY_PICK } action;
  41static struct commit *commit;
  42static int commit_argc;
  43static const char **commit_argv;
  44static int allow_rerere_auto;
  45
  46static const char *me;
  47static const char *strategy;
  48
  49#define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
  50
  51static char *get_encoding(const char *message);
  52
  53static const char * const *revert_or_cherry_pick_usage(void)
  54{
  55        return action == REVERT ? revert_usage : cherry_pick_usage;
  56}
  57
  58static void parse_args(int argc, const char **argv)
  59{
  60        const char * const * usage_str = revert_or_cherry_pick_usage();
  61        int noop;
  62        struct option options[] = {
  63                OPT_BOOLEAN('n', "no-commit", &no_commit, "don't automatically commit"),
  64                OPT_BOOLEAN('e', "edit", &edit, "edit the commit message"),
  65                OPT_BOOLEAN('r', NULL, &noop, "no-op (backward compatibility)"),
  66                OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
  67                OPT_INTEGER('m', "mainline", &mainline, "parent number"),
  68                OPT_RERERE_AUTOUPDATE(&allow_rerere_auto),
  69                OPT_STRING(0, "strategy", &strategy, "strategy", "merge strategy"),
  70                OPT_END(),
  71                OPT_END(),
  72                OPT_END(),
  73        };
  74
  75        if (action == CHERRY_PICK) {
  76                struct option cp_extra[] = {
  77                        OPT_BOOLEAN('x', NULL, &no_replay, "append commit name"),
  78                        OPT_BOOLEAN(0, "ff", &allow_ff, "allow fast-forward"),
  79                        OPT_END(),
  80                };
  81                if (parse_options_concat(options, ARRAY_SIZE(options), cp_extra))
  82                        die("program error");
  83        }
  84
  85        commit_argc = parse_options(argc, argv, NULL, options, usage_str,
  86                                    PARSE_OPT_KEEP_ARGV0 |
  87                                    PARSE_OPT_KEEP_UNKNOWN);
  88        if (commit_argc < 2)
  89                usage_with_options(usage_str, options);
  90
  91        commit_argv = argv;
  92}
  93
  94struct commit_message {
  95        char *parent_label;
  96        const char *label;
  97        const char *subject;
  98        char *reencoded_message;
  99        const char *message;
 100};
 101
 102static int get_message(const char *raw_message, struct commit_message *out)
 103{
 104        const char *encoding;
 105        const char *abbrev, *subject;
 106        int abbrev_len, subject_len;
 107        char *q;
 108
 109        if (!raw_message)
 110                return -1;
 111        encoding = get_encoding(raw_message);
 112        if (!encoding)
 113                encoding = "UTF-8";
 114        if (!git_commit_encoding)
 115                git_commit_encoding = "UTF-8";
 116
 117        out->reencoded_message = NULL;
 118        out->message = raw_message;
 119        if (strcmp(encoding, git_commit_encoding))
 120                out->reencoded_message = reencode_string(raw_message,
 121                                        git_commit_encoding, encoding);
 122        if (out->reencoded_message)
 123                out->message = out->reencoded_message;
 124
 125        abbrev = find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV);
 126        abbrev_len = strlen(abbrev);
 127
 128        subject_len = find_commit_subject(out->message, &subject);
 129
 130        out->parent_label = xmalloc(strlen("parent of ") + abbrev_len +
 131                              strlen("... ") + subject_len + 1);
 132        q = out->parent_label;
 133        q = mempcpy(q, "parent of ", strlen("parent of "));
 134        out->label = q;
 135        q = mempcpy(q, abbrev, abbrev_len);
 136        q = mempcpy(q, "... ", strlen("... "));
 137        out->subject = q;
 138        q = mempcpy(q, subject, subject_len);
 139        *q = '\0';
 140        return 0;
 141}
 142
 143static void free_message(struct commit_message *msg)
 144{
 145        free(msg->parent_label);
 146        free(msg->reencoded_message);
 147}
 148
 149static char *get_encoding(const char *message)
 150{
 151        const char *p = message, *eol;
 152
 153        if (!p)
 154                die ("Could not read commit message of %s",
 155                                sha1_to_hex(commit->object.sha1));
 156        while (*p && *p != '\n') {
 157                for (eol = p + 1; *eol && *eol != '\n'; eol++)
 158                        ; /* do nothing */
 159                if (!prefixcmp(p, "encoding ")) {
 160                        char *result = xmalloc(eol - 8 - p);
 161                        strlcpy(result, p + 9, eol - 8 - p);
 162                        return result;
 163                }
 164                p = eol;
 165                if (*p == '\n')
 166                        p++;
 167        }
 168        return NULL;
 169}
 170
 171static void add_message_to_msg(struct strbuf *msgbuf, const char *message)
 172{
 173        const char *p = message;
 174        while (*p && (*p != '\n' || p[1] != '\n'))
 175                p++;
 176
 177        if (!*p)
 178                strbuf_addstr(msgbuf, sha1_to_hex(commit->object.sha1));
 179
 180        p += 2;
 181        strbuf_addstr(msgbuf, p);
 182}
 183
 184static void set_author_ident_env(const char *message)
 185{
 186        const char *p = message;
 187        if (!p)
 188                die ("Could not read commit message of %s",
 189                                sha1_to_hex(commit->object.sha1));
 190        while (*p && *p != '\n') {
 191                const char *eol;
 192
 193                for (eol = p; *eol && *eol != '\n'; eol++)
 194                        ; /* do nothing */
 195                if (!prefixcmp(p, "author ")) {
 196                        char *line, *pend, *email, *timestamp;
 197
 198                        p += 7;
 199                        line = xmemdupz(p, eol - p);
 200                        email = strchr(line, '<');
 201                        if (!email)
 202                                die ("Could not extract author email from %s",
 203                                        sha1_to_hex(commit->object.sha1));
 204                        if (email == line)
 205                                pend = line;
 206                        else
 207                                for (pend = email; pend != line + 1 &&
 208                                                isspace(pend[-1]); pend--);
 209                                        ; /* do nothing */
 210                        *pend = '\0';
 211                        email++;
 212                        timestamp = strchr(email, '>');
 213                        if (!timestamp)
 214                                die ("Could not extract author time from %s",
 215                                        sha1_to_hex(commit->object.sha1));
 216                        *timestamp = '\0';
 217                        for (timestamp++; *timestamp && isspace(*timestamp);
 218                                        timestamp++)
 219                                ; /* do nothing */
 220                        setenv("GIT_AUTHOR_NAME", line, 1);
 221                        setenv("GIT_AUTHOR_EMAIL", email, 1);
 222                        setenv("GIT_AUTHOR_DATE", timestamp, 1);
 223                        free(line);
 224                        return;
 225                }
 226                p = eol;
 227                if (*p == '\n')
 228                        p++;
 229        }
 230        die ("No author information found in %s",
 231                        sha1_to_hex(commit->object.sha1));
 232}
 233
 234static char *help_msg(void)
 235{
 236        struct strbuf helpbuf = STRBUF_INIT;
 237        char *msg = getenv("GIT_CHERRY_PICK_HELP");
 238
 239        if (msg)
 240                return msg;
 241
 242        strbuf_addstr(&helpbuf, "  After resolving the conflicts,\n"
 243                "mark the corrected paths with 'git add <paths>' or 'git rm <paths>'\n"
 244                "and commit the result");
 245
 246        if (action == CHERRY_PICK) {
 247                strbuf_addf(&helpbuf, " with: \n"
 248                        "\n"
 249                        "        git commit -c %s\n",
 250                            sha1_to_hex(commit->object.sha1));
 251        }
 252        else
 253                strbuf_addch(&helpbuf, '.');
 254        return strbuf_detach(&helpbuf, NULL);
 255}
 256
 257static void write_message(struct strbuf *msgbuf, const char *filename)
 258{
 259        static struct lock_file msg_file;
 260
 261        int msg_fd = hold_lock_file_for_update(&msg_file, filename,
 262                                               LOCK_DIE_ON_ERROR);
 263        if (write_in_full(msg_fd, msgbuf->buf, msgbuf->len) < 0)
 264                die_errno("Could not write to %s.", filename);
 265        strbuf_release(msgbuf);
 266        if (commit_lock_file(&msg_file) < 0)
 267                die("Error wrapping up %s", filename);
 268}
 269
 270static struct tree *empty_tree(void)
 271{
 272        struct tree *tree = xcalloc(1, sizeof(struct tree));
 273
 274        tree->object.parsed = 1;
 275        tree->object.type = OBJ_TREE;
 276        pretend_sha1_file(NULL, 0, OBJ_TREE, tree->object.sha1);
 277        return tree;
 278}
 279
 280static NORETURN void die_dirty_index(const char *me)
 281{
 282        if (read_cache_unmerged()) {
 283                die_resolve_conflict(me);
 284        } else {
 285                if (advice_commit_before_merge)
 286                        die("Your local changes would be overwritten by %s.\n"
 287                            "Please, commit your changes or stash them to proceed.", me);
 288                else
 289                        die("Your local changes would be overwritten by %s.\n", me);
 290        }
 291}
 292
 293static int fast_forward_to(const unsigned char *to, const unsigned char *from)
 294{
 295        struct ref_lock *ref_lock;
 296
 297        read_cache();
 298        if (checkout_fast_forward(from, to))
 299                exit(1); /* the callee should have complained already */
 300        ref_lock = lock_any_ref_for_update("HEAD", from, 0);
 301        return write_ref_sha1(ref_lock, to, "cherry-pick");
 302}
 303
 304static void do_recursive_merge(struct commit *base, struct commit *next,
 305                               const char *base_label, const char *next_label,
 306                               unsigned char *head, struct strbuf *msgbuf,
 307                               char *defmsg)
 308{
 309        struct merge_options o;
 310        struct tree *result, *next_tree, *base_tree, *head_tree;
 311        int clean, index_fd;
 312        static struct lock_file index_lock;
 313
 314        index_fd = hold_locked_index(&index_lock, 1);
 315
 316        read_cache();
 317        init_merge_options(&o);
 318        o.ancestor = base ? base_label : "(empty tree)";
 319        o.branch1 = "HEAD";
 320        o.branch2 = next ? next_label : "(empty tree)";
 321
 322        head_tree = parse_tree_indirect(head);
 323        next_tree = next ? next->tree : empty_tree();
 324        base_tree = base ? base->tree : empty_tree();
 325
 326        clean = merge_trees(&o,
 327                            head_tree,
 328                            next_tree, base_tree, &result);
 329
 330        if (active_cache_changed &&
 331            (write_cache(index_fd, active_cache, active_nr) ||
 332             commit_locked_index(&index_lock)))
 333                die("%s: Unable to write new index file", me);
 334        rollback_lock_file(&index_lock);
 335
 336        if (!clean) {
 337                int i;
 338                strbuf_addstr(msgbuf, "\nConflicts:\n\n");
 339                for (i = 0; i < active_nr;) {
 340                        struct cache_entry *ce = active_cache[i++];
 341                        if (ce_stage(ce)) {
 342                                strbuf_addch(msgbuf, '\t');
 343                                strbuf_addstr(msgbuf, ce->name);
 344                                strbuf_addch(msgbuf, '\n');
 345                                while (i < active_nr && !strcmp(ce->name,
 346                                                active_cache[i]->name))
 347                                        i++;
 348                        }
 349                }
 350                write_message(msgbuf, defmsg);
 351                fprintf(stderr, "Automatic %s failed.%s\n",
 352                        me, help_msg());
 353                rerere(allow_rerere_auto);
 354                exit(1);
 355        }
 356        write_message(msgbuf, defmsg);
 357        fprintf(stderr, "Finished one %s.\n", me);
 358}
 359
 360static int do_pick_commit(void)
 361{
 362        unsigned char head[20];
 363        struct commit *base, *next, *parent;
 364        const char *base_label, *next_label;
 365        struct commit_message msg = { NULL, NULL, NULL, NULL, NULL };
 366        char *defmsg = NULL;
 367        struct strbuf msgbuf = STRBUF_INIT;
 368
 369        if (no_commit) {
 370                /*
 371                 * We do not intend to commit immediately.  We just want to
 372                 * merge the differences in, so let's compute the tree
 373                 * that represents the "current" state for merge-recursive
 374                 * to work on.
 375                 */
 376                if (write_cache_as_tree(head, 0, NULL))
 377                        die ("Your index file is unmerged.");
 378        } else {
 379                if (get_sha1("HEAD", head))
 380                        die ("You do not have a valid HEAD");
 381                if (index_differs_from("HEAD", 0))
 382                        die_dirty_index(me);
 383        }
 384        discard_cache();
 385
 386        if (!commit->parents) {
 387                if (action == REVERT)
 388                        die ("Cannot revert a root commit");
 389                parent = NULL;
 390        }
 391        else if (commit->parents->next) {
 392                /* Reverting or cherry-picking a merge commit */
 393                int cnt;
 394                struct commit_list *p;
 395
 396                if (!mainline)
 397                        die("Commit %s is a merge but no -m option was given.",
 398                            sha1_to_hex(commit->object.sha1));
 399
 400                for (cnt = 1, p = commit->parents;
 401                     cnt != mainline && p;
 402                     cnt++)
 403                        p = p->next;
 404                if (cnt != mainline || !p)
 405                        die("Commit %s does not have parent %d",
 406                            sha1_to_hex(commit->object.sha1), mainline);
 407                parent = p->item;
 408        } else if (0 < mainline)
 409                die("Mainline was specified but commit %s is not a merge.",
 410                    sha1_to_hex(commit->object.sha1));
 411        else
 412                parent = commit->parents->item;
 413
 414        if (allow_ff && !hashcmp(parent->object.sha1, head))
 415                return fast_forward_to(commit->object.sha1, head);
 416
 417        if (parent && parse_commit(parent) < 0)
 418                die("%s: cannot parse parent commit %s",
 419                    me, sha1_to_hex(parent->object.sha1));
 420
 421        if (get_message(commit->buffer, &msg) != 0)
 422                die("Cannot get commit message for %s",
 423                                sha1_to_hex(commit->object.sha1));
 424
 425        /*
 426         * "commit" is an existing commit.  We would want to apply
 427         * the difference it introduces since its first parent "prev"
 428         * on top of the current HEAD if we are cherry-pick.  Or the
 429         * reverse of it if we are revert.
 430         */
 431
 432        defmsg = git_pathdup("MERGE_MSG");
 433
 434        if (action == REVERT) {
 435                base = commit;
 436                base_label = msg.label;
 437                next = parent;
 438                next_label = msg.parent_label;
 439                strbuf_addstr(&msgbuf, "Revert \"");
 440                strbuf_addstr(&msgbuf, msg.subject);
 441                strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
 442                strbuf_addstr(&msgbuf, sha1_to_hex(commit->object.sha1));
 443
 444                if (commit->parents->next) {
 445                        strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
 446                        strbuf_addstr(&msgbuf, sha1_to_hex(parent->object.sha1));
 447                }
 448                strbuf_addstr(&msgbuf, ".\n");
 449        } else {
 450                base = parent;
 451                base_label = msg.parent_label;
 452                next = commit;
 453                next_label = msg.label;
 454                set_author_ident_env(msg.message);
 455                add_message_to_msg(&msgbuf, msg.message);
 456                if (no_replay) {
 457                        strbuf_addstr(&msgbuf, "(cherry picked from commit ");
 458                        strbuf_addstr(&msgbuf, sha1_to_hex(commit->object.sha1));
 459                        strbuf_addstr(&msgbuf, ")\n");
 460                }
 461        }
 462
 463        if (!strategy || !strcmp(strategy, "recursive") || action == REVERT)
 464                do_recursive_merge(base, next, base_label, next_label,
 465                                   head, &msgbuf, defmsg);
 466        else {
 467                int res;
 468                struct commit_list *common = NULL;
 469                struct commit_list *remotes = NULL;
 470                write_message(&msgbuf, defmsg);
 471                commit_list_insert(base, &common);
 472                commit_list_insert(next, &remotes);
 473                res = try_merge_command(strategy, common,
 474                                        sha1_to_hex(head), remotes);
 475                free_commit_list(common);
 476                free_commit_list(remotes);
 477                if (res) {
 478                        fprintf(stderr, "Automatic %s with strategy %s failed.%s\n",
 479                                me, strategy, help_msg());
 480                        rerere(allow_rerere_auto);
 481                        exit(1);
 482                }
 483        }
 484
 485        free_message(&msg);
 486
 487        /*
 488         *
 489         * If we are cherry-pick, and if the merge did not result in
 490         * hand-editing, we will hit this commit and inherit the original
 491         * author date and name.
 492         * If we are revert, or if our cherry-pick results in a hand merge,
 493         * we had better say that the current user is responsible for that.
 494         */
 495
 496        if (!no_commit) {
 497                /* 6 is max possible length of our args array including NULL */
 498                const char *args[6];
 499                int res;
 500                int i = 0;
 501
 502                args[i++] = "commit";
 503                args[i++] = "-n";
 504                if (signoff)
 505                        args[i++] = "-s";
 506                if (!edit) {
 507                        args[i++] = "-F";
 508                        args[i++] = defmsg;
 509                }
 510                args[i] = NULL;
 511                res = run_command_v_opt(args, RUN_GIT_CMD);
 512                free(defmsg);
 513
 514                return res;
 515        }
 516
 517        free(defmsg);
 518
 519        return 0;
 520}
 521
 522static void prepare_revs(struct rev_info *revs)
 523{
 524        int argc;
 525
 526        init_revisions(revs, NULL);
 527        revs->no_walk = 1;
 528        if (action != REVERT)
 529                revs->reverse = 1;
 530
 531        argc = setup_revisions(commit_argc, commit_argv, revs, NULL);
 532        if (argc > 1)
 533                usage(*revert_or_cherry_pick_usage());
 534
 535        if (prepare_revision_walk(revs))
 536                die("revision walk setup failed");
 537
 538        if (!revs->commits)
 539                die("empty commit set passed");
 540}
 541
 542static int revert_or_cherry_pick(int argc, const char **argv)
 543{
 544        struct rev_info revs;
 545
 546        git_config(git_default_config, NULL);
 547        me = action == REVERT ? "revert" : "cherry-pick";
 548        setenv(GIT_REFLOG_ACTION, me, 0);
 549        parse_args(argc, argv);
 550
 551        if (allow_ff) {
 552                if (signoff)
 553                        die("cherry-pick --ff cannot be used with --signoff");
 554                if (no_commit)
 555                        die("cherry-pick --ff cannot be used with --no-commit");
 556                if (no_replay)
 557                        die("cherry-pick --ff cannot be used with -x");
 558                if (edit)
 559                        die("cherry-pick --ff cannot be used with --edit");
 560        }
 561
 562        if (read_cache() < 0)
 563                die("git %s: failed to read the index", me);
 564
 565        prepare_revs(&revs);
 566
 567        while ((commit = get_revision(&revs))) {
 568                int res = do_pick_commit();
 569                if (res)
 570                        return res;
 571        }
 572
 573        return 0;
 574}
 575
 576int cmd_revert(int argc, const char **argv, const char *prefix)
 577{
 578        if (isatty(0))
 579                edit = 1;
 580        action = REVERT;
 581        return revert_or_cherry_pick(argc, argv);
 582}
 583
 584int cmd_cherry_pick(int argc, const char **argv, const char *prefix)
 585{
 586        action = CHERRY_PICK;
 587        return revert_or_cherry_pick(argc, argv);
 588}