builtin / revert.con commit cherry-pick/revert: Use advise() for hints (314eeb6)
   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 *p, *abbrev, *eol;
 106        char *q;
 107        int abbrev_len, oneline_len;
 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        /* Find beginning and end of commit subject. */
 129        p = out->message;
 130        while (*p && (*p != '\n' || p[1] != '\n'))
 131                p++;
 132        if (*p) {
 133                p += 2;
 134                for (eol = p + 1; *eol && *eol != '\n'; eol++)
 135                        ; /* do nothing */
 136        } else
 137                eol = p;
 138        oneline_len = eol - p;
 139
 140        out->parent_label = xmalloc(strlen("parent of ") + abbrev_len +
 141                              strlen("... ") + oneline_len + 1);
 142        q = out->parent_label;
 143        q = mempcpy(q, "parent of ", strlen("parent of "));
 144        out->label = q;
 145        q = mempcpy(q, abbrev, abbrev_len);
 146        q = mempcpy(q, "... ", strlen("... "));
 147        out->subject = q;
 148        q = mempcpy(q, p, oneline_len);
 149        *q = '\0';
 150        return 0;
 151}
 152
 153static void free_message(struct commit_message *msg)
 154{
 155        free(msg->parent_label);
 156        free(msg->reencoded_message);
 157}
 158
 159static char *get_encoding(const char *message)
 160{
 161        const char *p = message, *eol;
 162
 163        if (!p)
 164                die ("Could not read commit message of %s",
 165                                sha1_to_hex(commit->object.sha1));
 166        while (*p && *p != '\n') {
 167                for (eol = p + 1; *eol && *eol != '\n'; eol++)
 168                        ; /* do nothing */
 169                if (!prefixcmp(p, "encoding ")) {
 170                        char *result = xmalloc(eol - 8 - p);
 171                        strlcpy(result, p + 9, eol - 8 - p);
 172                        return result;
 173                }
 174                p = eol;
 175                if (*p == '\n')
 176                        p++;
 177        }
 178        return NULL;
 179}
 180
 181static void add_message_to_msg(struct strbuf *msgbuf, const char *message)
 182{
 183        const char *p = message;
 184        while (*p && (*p != '\n' || p[1] != '\n'))
 185                p++;
 186
 187        if (!*p)
 188                strbuf_addstr(msgbuf, sha1_to_hex(commit->object.sha1));
 189
 190        p += 2;
 191        strbuf_addstr(msgbuf, p);
 192}
 193
 194static void set_author_ident_env(const char *message)
 195{
 196        const char *p = message;
 197        if (!p)
 198                die ("Could not read commit message of %s",
 199                                sha1_to_hex(commit->object.sha1));
 200        while (*p && *p != '\n') {
 201                const char *eol;
 202
 203                for (eol = p; *eol && *eol != '\n'; eol++)
 204                        ; /* do nothing */
 205                if (!prefixcmp(p, "author ")) {
 206                        char *line, *pend, *email, *timestamp;
 207
 208                        p += 7;
 209                        line = xmemdupz(p, eol - p);
 210                        email = strchr(line, '<');
 211                        if (!email)
 212                                die ("Could not extract author email from %s",
 213                                        sha1_to_hex(commit->object.sha1));
 214                        if (email == line)
 215                                pend = line;
 216                        else
 217                                for (pend = email; pend != line + 1 &&
 218                                                isspace(pend[-1]); pend--);
 219                                        ; /* do nothing */
 220                        *pend = '\0';
 221                        email++;
 222                        timestamp = strchr(email, '>');
 223                        if (!timestamp)
 224                                die ("Could not extract author time from %s",
 225                                        sha1_to_hex(commit->object.sha1));
 226                        *timestamp = '\0';
 227                        for (timestamp++; *timestamp && isspace(*timestamp);
 228                                        timestamp++)
 229                                ; /* do nothing */
 230                        setenv("GIT_AUTHOR_NAME", line, 1);
 231                        setenv("GIT_AUTHOR_EMAIL", email, 1);
 232                        setenv("GIT_AUTHOR_DATE", timestamp, 1);
 233                        free(line);
 234                        return;
 235                }
 236                p = eol;
 237                if (*p == '\n')
 238                        p++;
 239        }
 240        die ("No author information found in %s",
 241                        sha1_to_hex(commit->object.sha1));
 242}
 243
 244static void advise(const char *advice, ...)
 245{
 246        va_list params;
 247
 248        va_start(params, advice);
 249        vreportf("hint: ", advice, params);
 250        va_end(params);
 251}
 252
 253static void print_advice(void)
 254{
 255        char *msg = getenv("GIT_CHERRY_PICK_HELP");
 256
 257        if (msg) {
 258                fprintf(stderr, "%s\n", msg);
 259                return;
 260        }
 261
 262        advise("after resolving the conflicts, mark the corrected paths");
 263        advise("with 'git add <paths>' or 'git rm <paths>'");
 264
 265        if (action == CHERRY_PICK)
 266                advise("and commit the result with 'git commit -c %s'",
 267                       find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV));
 268}
 269
 270static void write_message(struct strbuf *msgbuf, const char *filename)
 271{
 272        static struct lock_file msg_file;
 273
 274        int msg_fd = hold_lock_file_for_update(&msg_file, filename,
 275                                               LOCK_DIE_ON_ERROR);
 276        if (write_in_full(msg_fd, msgbuf->buf, msgbuf->len) < 0)
 277                die_errno("Could not write to %s.", filename);
 278        strbuf_release(msgbuf);
 279        if (commit_lock_file(&msg_file) < 0)
 280                die("Error wrapping up %s", filename);
 281}
 282
 283static struct tree *empty_tree(void)
 284{
 285        struct tree *tree = xcalloc(1, sizeof(struct tree));
 286
 287        tree->object.parsed = 1;
 288        tree->object.type = OBJ_TREE;
 289        pretend_sha1_file(NULL, 0, OBJ_TREE, tree->object.sha1);
 290        return tree;
 291}
 292
 293static NORETURN void die_dirty_index(const char *me)
 294{
 295        if (read_cache_unmerged()) {
 296                die_resolve_conflict(me);
 297        } else {
 298                if (advice_commit_before_merge)
 299                        die("Your local changes would be overwritten by %s.\n"
 300                            "Please, commit your changes or stash them to proceed.", me);
 301                else
 302                        die("Your local changes would be overwritten by %s.\n", me);
 303        }
 304}
 305
 306static int fast_forward_to(const unsigned char *to, const unsigned char *from)
 307{
 308        struct ref_lock *ref_lock;
 309
 310        read_cache();
 311        if (checkout_fast_forward(from, to))
 312                exit(1); /* the callee should have complained already */
 313        ref_lock = lock_any_ref_for_update("HEAD", from, 0);
 314        return write_ref_sha1(ref_lock, to, "cherry-pick");
 315}
 316
 317static int do_recursive_merge(struct commit *base, struct commit *next,
 318                              const char *base_label, const char *next_label,
 319                              unsigned char *head, struct strbuf *msgbuf)
 320{
 321        struct merge_options o;
 322        struct tree *result, *next_tree, *base_tree, *head_tree;
 323        int clean, index_fd;
 324        static struct lock_file index_lock;
 325
 326        index_fd = hold_locked_index(&index_lock, 1);
 327
 328        read_cache();
 329        init_merge_options(&o);
 330        o.ancestor = base ? base_label : "(empty tree)";
 331        o.branch1 = "HEAD";
 332        o.branch2 = next ? next_label : "(empty tree)";
 333
 334        head_tree = parse_tree_indirect(head);
 335        next_tree = next ? next->tree : empty_tree();
 336        base_tree = base ? base->tree : empty_tree();
 337
 338        clean = merge_trees(&o,
 339                            head_tree,
 340                            next_tree, base_tree, &result);
 341
 342        if (active_cache_changed &&
 343            (write_cache(index_fd, active_cache, active_nr) ||
 344             commit_locked_index(&index_lock)))
 345                die("%s: Unable to write new index file", me);
 346        rollback_lock_file(&index_lock);
 347
 348        if (!clean) {
 349                int i;
 350                strbuf_addstr(msgbuf, "\nConflicts:\n\n");
 351                for (i = 0; i < active_nr;) {
 352                        struct cache_entry *ce = active_cache[i++];
 353                        if (ce_stage(ce)) {
 354                                strbuf_addch(msgbuf, '\t');
 355                                strbuf_addstr(msgbuf, ce->name);
 356                                strbuf_addch(msgbuf, '\n');
 357                                while (i < active_nr && !strcmp(ce->name,
 358                                                active_cache[i]->name))
 359                                        i++;
 360                        }
 361                }
 362        }
 363
 364        return !clean;
 365}
 366
 367/*
 368 * If we are cherry-pick, and if the merge did not result in
 369 * hand-editing, we will hit this commit and inherit the original
 370 * author date and name.
 371 * If we are revert, or if our cherry-pick results in a hand merge,
 372 * we had better say that the current user is responsible for that.
 373 */
 374static int run_git_commit(const char *defmsg)
 375{
 376        /* 6 is max possible length of our args array including NULL */
 377        const char *args[6];
 378        int i = 0;
 379
 380        args[i++] = "commit";
 381        args[i++] = "-n";
 382        if (signoff)
 383                args[i++] = "-s";
 384        if (!edit) {
 385                args[i++] = "-F";
 386                args[i++] = defmsg;
 387        }
 388        args[i] = NULL;
 389
 390        return run_command_v_opt(args, RUN_GIT_CMD);
 391}
 392
 393static int do_pick_commit(void)
 394{
 395        unsigned char head[20];
 396        struct commit *base, *next, *parent;
 397        const char *base_label, *next_label;
 398        struct commit_message msg = { NULL, NULL, NULL, NULL, NULL };
 399        char *defmsg = NULL;
 400        struct strbuf msgbuf = STRBUF_INIT;
 401        int res;
 402
 403        if (no_commit) {
 404                /*
 405                 * We do not intend to commit immediately.  We just want to
 406                 * merge the differences in, so let's compute the tree
 407                 * that represents the "current" state for merge-recursive
 408                 * to work on.
 409                 */
 410                if (write_cache_as_tree(head, 0, NULL))
 411                        die ("Your index file is unmerged.");
 412        } else {
 413                if (get_sha1("HEAD", head))
 414                        die ("You do not have a valid HEAD");
 415                if (index_differs_from("HEAD", 0))
 416                        die_dirty_index(me);
 417        }
 418        discard_cache();
 419
 420        if (!commit->parents) {
 421                if (action == REVERT)
 422                        die ("Cannot revert a root commit");
 423                parent = NULL;
 424        }
 425        else if (commit->parents->next) {
 426                /* Reverting or cherry-picking a merge commit */
 427                int cnt;
 428                struct commit_list *p;
 429
 430                if (!mainline)
 431                        die("Commit %s is a merge but no -m option was given.",
 432                            sha1_to_hex(commit->object.sha1));
 433
 434                for (cnt = 1, p = commit->parents;
 435                     cnt != mainline && p;
 436                     cnt++)
 437                        p = p->next;
 438                if (cnt != mainline || !p)
 439                        die("Commit %s does not have parent %d",
 440                            sha1_to_hex(commit->object.sha1), mainline);
 441                parent = p->item;
 442        } else if (0 < mainline)
 443                die("Mainline was specified but commit %s is not a merge.",
 444                    sha1_to_hex(commit->object.sha1));
 445        else
 446                parent = commit->parents->item;
 447
 448        if (allow_ff && !hashcmp(parent->object.sha1, head))
 449                return fast_forward_to(commit->object.sha1, head);
 450
 451        if (parent && parse_commit(parent) < 0)
 452                die("%s: cannot parse parent commit %s",
 453                    me, sha1_to_hex(parent->object.sha1));
 454
 455        if (get_message(commit->buffer, &msg) != 0)
 456                die("Cannot get commit message for %s",
 457                                sha1_to_hex(commit->object.sha1));
 458
 459        /*
 460         * "commit" is an existing commit.  We would want to apply
 461         * the difference it introduces since its first parent "prev"
 462         * on top of the current HEAD if we are cherry-pick.  Or the
 463         * reverse of it if we are revert.
 464         */
 465
 466        defmsg = git_pathdup("MERGE_MSG");
 467
 468        if (action == REVERT) {
 469                base = commit;
 470                base_label = msg.label;
 471                next = parent;
 472                next_label = msg.parent_label;
 473                strbuf_addstr(&msgbuf, "Revert \"");
 474                strbuf_addstr(&msgbuf, msg.subject);
 475                strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
 476                strbuf_addstr(&msgbuf, sha1_to_hex(commit->object.sha1));
 477
 478                if (commit->parents->next) {
 479                        strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
 480                        strbuf_addstr(&msgbuf, sha1_to_hex(parent->object.sha1));
 481                }
 482                strbuf_addstr(&msgbuf, ".\n");
 483        } else {
 484                base = parent;
 485                base_label = msg.parent_label;
 486                next = commit;
 487                next_label = msg.label;
 488                set_author_ident_env(msg.message);
 489                add_message_to_msg(&msgbuf, msg.message);
 490                if (no_replay) {
 491                        strbuf_addstr(&msgbuf, "(cherry picked from commit ");
 492                        strbuf_addstr(&msgbuf, sha1_to_hex(commit->object.sha1));
 493                        strbuf_addstr(&msgbuf, ")\n");
 494                }
 495        }
 496
 497        if (!strategy || !strcmp(strategy, "recursive") || action == REVERT) {
 498                res = do_recursive_merge(base, next, base_label, next_label,
 499                                         head, &msgbuf);
 500                write_message(&msgbuf, defmsg);
 501        } else {
 502                struct commit_list *common = NULL;
 503                struct commit_list *remotes = NULL;
 504
 505                write_message(&msgbuf, defmsg);
 506
 507                commit_list_insert(base, &common);
 508                commit_list_insert(next, &remotes);
 509                res = try_merge_command(strategy, common,
 510                                        sha1_to_hex(head), remotes);
 511                free_commit_list(common);
 512                free_commit_list(remotes);
 513        }
 514
 515        if (res) {
 516                error("could not %s %s... %s",
 517                      action == REVERT ? "revert" : "apply",
 518                      find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV),
 519                      msg.subject);
 520                print_advice();
 521                rerere(allow_rerere_auto);
 522        } else {
 523                if (!no_commit)
 524                        res = run_git_commit(defmsg);
 525        }
 526
 527        free_message(&msg);
 528        free(defmsg);
 529
 530        return res;
 531}
 532
 533static void prepare_revs(struct rev_info *revs)
 534{
 535        int argc;
 536
 537        init_revisions(revs, NULL);
 538        revs->no_walk = 1;
 539        if (action != REVERT)
 540                revs->reverse = 1;
 541
 542        argc = setup_revisions(commit_argc, commit_argv, revs, NULL);
 543        if (argc > 1)
 544                usage(*revert_or_cherry_pick_usage());
 545
 546        if (prepare_revision_walk(revs))
 547                die("revision walk setup failed");
 548
 549        if (!revs->commits)
 550                die("empty commit set passed");
 551}
 552
 553static int revert_or_cherry_pick(int argc, const char **argv)
 554{
 555        struct rev_info revs;
 556
 557        git_config(git_default_config, NULL);
 558        me = action == REVERT ? "revert" : "cherry-pick";
 559        setenv(GIT_REFLOG_ACTION, me, 0);
 560        parse_args(argc, argv);
 561
 562        if (allow_ff) {
 563                if (signoff)
 564                        die("cherry-pick --ff cannot be used with --signoff");
 565                if (no_commit)
 566                        die("cherry-pick --ff cannot be used with --no-commit");
 567                if (no_replay)
 568                        die("cherry-pick --ff cannot be used with -x");
 569                if (edit)
 570                        die("cherry-pick --ff cannot be used with --edit");
 571        }
 572
 573        if (read_cache() < 0)
 574                die("git %s: failed to read the index", me);
 575
 576        prepare_revs(&revs);
 577
 578        while ((commit = get_revision(&revs))) {
 579                int res = do_pick_commit();
 580                if (res)
 581                        return res;
 582        }
 583
 584        return 0;
 585}
 586
 587int cmd_revert(int argc, const char **argv, const char *prefix)
 588{
 589        if (isatty(0))
 590                edit = 1;
 591        action = REVERT;
 592        return revert_or_cherry_pick(argc, argv);
 593}
 594
 595int cmd_cherry_pick(int argc, const char **argv, const char *prefix)
 596{
 597        action = CHERRY_PICK;
 598        return revert_or_cherry_pick(argc, argv);
 599}