builtin / notes.con commit Merge branch 'master' of git://github.com/git-l10n/git-po (1f5a6ca)
   1/*
   2 * Builtin "git notes"
   3 *
   4 * Copyright (c) 2010 Johan Herland <johan@herland.net>
   5 *
   6 * Based on git-notes.sh by Johannes Schindelin,
   7 * and builtin/tag.c by Kristian Høgsberg and Carlos Rica.
   8 */
   9
  10#include "cache.h"
  11#include "config.h"
  12#include "builtin.h"
  13#include "notes.h"
  14#include "object-store.h"
  15#include "repository.h"
  16#include "blob.h"
  17#include "pretty.h"
  18#include "refs.h"
  19#include "exec-cmd.h"
  20#include "run-command.h"
  21#include "parse-options.h"
  22#include "string-list.h"
  23#include "notes-merge.h"
  24#include "notes-utils.h"
  25#include "worktree.h"
  26
  27static const char * const git_notes_usage[] = {
  28        N_("git notes [--ref <notes-ref>] [list [<object>]]"),
  29        N_("git notes [--ref <notes-ref>] add [-f] [--allow-empty] [-m <msg> | -F <file> | (-c | -C) <object>] [<object>]"),
  30        N_("git notes [--ref <notes-ref>] copy [-f] <from-object> <to-object>"),
  31        N_("git notes [--ref <notes-ref>] append [--allow-empty] [-m <msg> | -F <file> | (-c | -C) <object>] [<object>]"),
  32        N_("git notes [--ref <notes-ref>] edit [--allow-empty] [<object>]"),
  33        N_("git notes [--ref <notes-ref>] show [<object>]"),
  34        N_("git notes [--ref <notes-ref>] merge [-v | -q] [-s <strategy>] <notes-ref>"),
  35        N_("git notes merge --commit [-v | -q]"),
  36        N_("git notes merge --abort [-v | -q]"),
  37        N_("git notes [--ref <notes-ref>] remove [<object>...]"),
  38        N_("git notes [--ref <notes-ref>] prune [-n] [-v]"),
  39        N_("git notes [--ref <notes-ref>] get-ref"),
  40        NULL
  41};
  42
  43static const char * const git_notes_list_usage[] = {
  44        N_("git notes [list [<object>]]"),
  45        NULL
  46};
  47
  48static const char * const git_notes_add_usage[] = {
  49        N_("git notes add [<options>] [<object>]"),
  50        NULL
  51};
  52
  53static const char * const git_notes_copy_usage[] = {
  54        N_("git notes copy [<options>] <from-object> <to-object>"),
  55        N_("git notes copy --stdin [<from-object> <to-object>]..."),
  56        NULL
  57};
  58
  59static const char * const git_notes_append_usage[] = {
  60        N_("git notes append [<options>] [<object>]"),
  61        NULL
  62};
  63
  64static const char * const git_notes_edit_usage[] = {
  65        N_("git notes edit [<object>]"),
  66        NULL
  67};
  68
  69static const char * const git_notes_show_usage[] = {
  70        N_("git notes show [<object>]"),
  71        NULL
  72};
  73
  74static const char * const git_notes_merge_usage[] = {
  75        N_("git notes merge [<options>] <notes-ref>"),
  76        N_("git notes merge --commit [<options>]"),
  77        N_("git notes merge --abort [<options>]"),
  78        NULL
  79};
  80
  81static const char * const git_notes_remove_usage[] = {
  82        N_("git notes remove [<object>]"),
  83        NULL
  84};
  85
  86static const char * const git_notes_prune_usage[] = {
  87        N_("git notes prune [<options>]"),
  88        NULL
  89};
  90
  91static const char * const git_notes_get_ref_usage[] = {
  92        N_("git notes get-ref"),
  93        NULL
  94};
  95
  96static const char note_template[] =
  97        N_("Write/edit the notes for the following object:");
  98
  99struct note_data {
 100        int given;
 101        int use_editor;
 102        char *edit_path;
 103        struct strbuf buf;
 104};
 105
 106static void free_note_data(struct note_data *d)
 107{
 108        if (d->edit_path) {
 109                unlink_or_warn(d->edit_path);
 110                free(d->edit_path);
 111        }
 112        strbuf_release(&d->buf);
 113}
 114
 115static int list_each_note(const struct object_id *object_oid,
 116                const struct object_id *note_oid, char *note_path,
 117                void *cb_data)
 118{
 119        printf("%s %s\n", oid_to_hex(note_oid), oid_to_hex(object_oid));
 120        return 0;
 121}
 122
 123static void copy_obj_to_fd(int fd, const struct object_id *oid)
 124{
 125        unsigned long size;
 126        enum object_type type;
 127        char *buf = read_object_file(oid, &type, &size);
 128        if (buf) {
 129                if (size)
 130                        write_or_die(fd, buf, size);
 131                free(buf);
 132        }
 133}
 134
 135static void write_commented_object(int fd, const struct object_id *object)
 136{
 137        const char *show_args[5] =
 138                {"show", "--stat", "--no-notes", oid_to_hex(object), NULL};
 139        struct child_process show = CHILD_PROCESS_INIT;
 140        struct strbuf buf = STRBUF_INIT;
 141        struct strbuf cbuf = STRBUF_INIT;
 142
 143        /* Invoke "git show --stat --no-notes $object" */
 144        show.argv = show_args;
 145        show.no_stdin = 1;
 146        show.out = -1;
 147        show.err = 0;
 148        show.git_cmd = 1;
 149        if (start_command(&show))
 150                die(_("unable to start 'show' for object '%s'"),
 151                    oid_to_hex(object));
 152
 153        if (strbuf_read(&buf, show.out, 0) < 0)
 154                die_errno(_("could not read 'show' output"));
 155        strbuf_add_commented_lines(&cbuf, buf.buf, buf.len);
 156        write_or_die(fd, cbuf.buf, cbuf.len);
 157
 158        strbuf_release(&cbuf);
 159        strbuf_release(&buf);
 160
 161        if (finish_command(&show))
 162                die(_("failed to finish 'show' for object '%s'"),
 163                    oid_to_hex(object));
 164}
 165
 166static void prepare_note_data(const struct object_id *object, struct note_data *d,
 167                const struct object_id *old_note)
 168{
 169        if (d->use_editor || !d->given) {
 170                int fd;
 171                struct strbuf buf = STRBUF_INIT;
 172
 173                /* write the template message before editing: */
 174                d->edit_path = git_pathdup("NOTES_EDITMSG");
 175                fd = open(d->edit_path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
 176                if (fd < 0)
 177                        die_errno(_("could not create file '%s'"), d->edit_path);
 178
 179                if (d->given)
 180                        write_or_die(fd, d->buf.buf, d->buf.len);
 181                else if (old_note)
 182                        copy_obj_to_fd(fd, old_note);
 183
 184                strbuf_addch(&buf, '\n');
 185                strbuf_add_commented_lines(&buf, "\n", strlen("\n"));
 186                strbuf_add_commented_lines(&buf, _(note_template), strlen(_(note_template)));
 187                strbuf_addch(&buf, '\n');
 188                write_or_die(fd, buf.buf, buf.len);
 189
 190                write_commented_object(fd, object);
 191
 192                close(fd);
 193                strbuf_release(&buf);
 194                strbuf_reset(&d->buf);
 195
 196                if (launch_editor(d->edit_path, &d->buf, NULL)) {
 197                        die(_("please supply the note contents using either -m or -F option"));
 198                }
 199                strbuf_stripspace(&d->buf, 1);
 200        }
 201}
 202
 203static void write_note_data(struct note_data *d, struct object_id *oid)
 204{
 205        if (write_object_file(d->buf.buf, d->buf.len, blob_type, oid)) {
 206                error(_("unable to write note object"));
 207                if (d->edit_path)
 208                        error(_("the note contents have been left in %s"),
 209                                d->edit_path);
 210                exit(128);
 211        }
 212}
 213
 214static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
 215{
 216        struct note_data *d = opt->value;
 217
 218        BUG_ON_OPT_NEG(unset);
 219
 220        strbuf_grow(&d->buf, strlen(arg) + 2);
 221        if (d->buf.len)
 222                strbuf_addch(&d->buf, '\n');
 223        strbuf_addstr(&d->buf, arg);
 224        strbuf_stripspace(&d->buf, 0);
 225
 226        d->given = 1;
 227        return 0;
 228}
 229
 230static int parse_file_arg(const struct option *opt, const char *arg, int unset)
 231{
 232        struct note_data *d = opt->value;
 233
 234        BUG_ON_OPT_NEG(unset);
 235
 236        if (d->buf.len)
 237                strbuf_addch(&d->buf, '\n');
 238        if (!strcmp(arg, "-")) {
 239                if (strbuf_read(&d->buf, 0, 1024) < 0)
 240                        die_errno(_("cannot read '%s'"), arg);
 241        } else if (strbuf_read_file(&d->buf, arg, 1024) < 0)
 242                die_errno(_("could not open or read '%s'"), arg);
 243        strbuf_stripspace(&d->buf, 0);
 244
 245        d->given = 1;
 246        return 0;
 247}
 248
 249static int parse_reuse_arg(const struct option *opt, const char *arg, int unset)
 250{
 251        struct note_data *d = opt->value;
 252        char *buf;
 253        struct object_id object;
 254        enum object_type type;
 255        unsigned long len;
 256
 257        BUG_ON_OPT_NEG(unset);
 258
 259        if (d->buf.len)
 260                strbuf_addch(&d->buf, '\n');
 261
 262        if (get_oid(arg, &object))
 263                die(_("failed to resolve '%s' as a valid ref."), arg);
 264        if (!(buf = read_object_file(&object, &type, &len)))
 265                die(_("failed to read object '%s'."), arg);
 266        if (type != OBJ_BLOB) {
 267                free(buf);
 268                die(_("cannot read note data from non-blob object '%s'."), arg);
 269        }
 270        strbuf_add(&d->buf, buf, len);
 271        free(buf);
 272
 273        d->given = 1;
 274        return 0;
 275}
 276
 277static int parse_reedit_arg(const struct option *opt, const char *arg, int unset)
 278{
 279        struct note_data *d = opt->value;
 280        BUG_ON_OPT_NEG(unset);
 281        d->use_editor = 1;
 282        return parse_reuse_arg(opt, arg, unset);
 283}
 284
 285static int notes_copy_from_stdin(int force, const char *rewrite_cmd)
 286{
 287        struct strbuf buf = STRBUF_INIT;
 288        struct notes_rewrite_cfg *c = NULL;
 289        struct notes_tree *t = NULL;
 290        int ret = 0;
 291        const char *msg = "Notes added by 'git notes copy'";
 292
 293        if (rewrite_cmd) {
 294                c = init_copy_notes_for_rewrite(rewrite_cmd);
 295                if (!c)
 296                        return 0;
 297        } else {
 298                init_notes(NULL, NULL, NULL, NOTES_INIT_WRITABLE);
 299                t = &default_notes_tree;
 300        }
 301
 302        while (strbuf_getline_lf(&buf, stdin) != EOF) {
 303                struct object_id from_obj, to_obj;
 304                struct strbuf **split;
 305                int err;
 306
 307                split = strbuf_split(&buf, ' ');
 308                if (!split[0] || !split[1])
 309                        die(_("malformed input line: '%s'."), buf.buf);
 310                strbuf_rtrim(split[0]);
 311                strbuf_rtrim(split[1]);
 312                if (get_oid(split[0]->buf, &from_obj))
 313                        die(_("failed to resolve '%s' as a valid ref."), split[0]->buf);
 314                if (get_oid(split[1]->buf, &to_obj))
 315                        die(_("failed to resolve '%s' as a valid ref."), split[1]->buf);
 316
 317                if (rewrite_cmd)
 318                        err = copy_note_for_rewrite(c, &from_obj, &to_obj);
 319                else
 320                        err = copy_note(t, &from_obj, &to_obj, force,
 321                                        combine_notes_overwrite);
 322
 323                if (err) {
 324                        error(_("failed to copy notes from '%s' to '%s'"),
 325                              split[0]->buf, split[1]->buf);
 326                        ret = 1;
 327                }
 328
 329                strbuf_list_free(split);
 330        }
 331
 332        if (!rewrite_cmd) {
 333                commit_notes(t, msg);
 334                free_notes(t);
 335        } else {
 336                finish_copy_notes_for_rewrite(c, msg);
 337        }
 338        strbuf_release(&buf);
 339        return ret;
 340}
 341
 342static struct notes_tree *init_notes_check(const char *subcommand,
 343                                           int flags)
 344{
 345        struct notes_tree *t;
 346        const char *ref;
 347        init_notes(NULL, NULL, NULL, flags);
 348        t = &default_notes_tree;
 349
 350        ref = (flags & NOTES_INIT_WRITABLE) ? t->update_ref : t->ref;
 351        if (!starts_with(ref, "refs/notes/"))
 352                /*
 353                 * TRANSLATORS: the first %s will be replaced by a git
 354                 * notes command: 'add', 'merge', 'remove', etc.
 355                 */
 356                die(_("refusing to %s notes in %s (outside of refs/notes/)"),
 357                    subcommand, ref);
 358        return t;
 359}
 360
 361static int list(int argc, const char **argv, const char *prefix)
 362{
 363        struct notes_tree *t;
 364        struct object_id object;
 365        const struct object_id *note;
 366        int retval = -1;
 367        struct option options[] = {
 368                OPT_END()
 369        };
 370
 371        if (argc)
 372                argc = parse_options(argc, argv, prefix, options,
 373                                     git_notes_list_usage, 0);
 374
 375        if (1 < argc) {
 376                error(_("too many parameters"));
 377                usage_with_options(git_notes_list_usage, options);
 378        }
 379
 380        t = init_notes_check("list", 0);
 381        if (argc) {
 382                if (get_oid(argv[0], &object))
 383                        die(_("failed to resolve '%s' as a valid ref."), argv[0]);
 384                note = get_note(t, &object);
 385                if (note) {
 386                        puts(oid_to_hex(note));
 387                        retval = 0;
 388                } else
 389                        retval = error(_("no note found for object %s."),
 390                                       oid_to_hex(&object));
 391        } else
 392                retval = for_each_note(t, 0, list_each_note, NULL);
 393
 394        free_notes(t);
 395        return retval;
 396}
 397
 398static int append_edit(int argc, const char **argv, const char *prefix);
 399
 400static int add(int argc, const char **argv, const char *prefix)
 401{
 402        int force = 0, allow_empty = 0;
 403        const char *object_ref;
 404        struct notes_tree *t;
 405        struct object_id object, new_note;
 406        const struct object_id *note;
 407        struct note_data d = { 0, 0, NULL, STRBUF_INIT };
 408        struct option options[] = {
 409                { OPTION_CALLBACK, 'm', "message", &d, N_("message"),
 410                        N_("note contents as a string"), PARSE_OPT_NONEG,
 411                        parse_msg_arg},
 412                { OPTION_CALLBACK, 'F', "file", &d, N_("file"),
 413                        N_("note contents in a file"), PARSE_OPT_NONEG,
 414                        parse_file_arg},
 415                { OPTION_CALLBACK, 'c', "reedit-message", &d, N_("object"),
 416                        N_("reuse and edit specified note object"), PARSE_OPT_NONEG,
 417                        parse_reedit_arg},
 418                { OPTION_CALLBACK, 'C', "reuse-message", &d, N_("object"),
 419                        N_("reuse specified note object"), PARSE_OPT_NONEG,
 420                        parse_reuse_arg},
 421                OPT_BOOL(0, "allow-empty", &allow_empty,
 422                        N_("allow storing empty note")),
 423                OPT__FORCE(&force, N_("replace existing notes"), PARSE_OPT_NOCOMPLETE),
 424                OPT_END()
 425        };
 426
 427        argc = parse_options(argc, argv, prefix, options, git_notes_add_usage,
 428                             PARSE_OPT_KEEP_ARGV0);
 429
 430        if (2 < argc) {
 431                error(_("too many parameters"));
 432                usage_with_options(git_notes_add_usage, options);
 433        }
 434
 435        object_ref = argc > 1 ? argv[1] : "HEAD";
 436
 437        if (get_oid(object_ref, &object))
 438                die(_("failed to resolve '%s' as a valid ref."), object_ref);
 439
 440        t = init_notes_check("add", NOTES_INIT_WRITABLE);
 441        note = get_note(t, &object);
 442
 443        if (note) {
 444                if (!force) {
 445                        free_notes(t);
 446                        if (d.given) {
 447                                free_note_data(&d);
 448                                return error(_("Cannot add notes. "
 449                                        "Found existing notes for object %s. "
 450                                        "Use '-f' to overwrite existing notes"),
 451                                        oid_to_hex(&object));
 452                        }
 453                        /*
 454                         * Redirect to "edit" subcommand.
 455                         *
 456                         * We only end up here if none of -m/-F/-c/-C or -f are
 457                         * given. The original args are therefore still in
 458                         * argv[0-1].
 459                         */
 460                        argv[0] = "edit";
 461                        return append_edit(argc, argv, prefix);
 462                }
 463                fprintf(stderr, _("Overwriting existing notes for object %s\n"),
 464                        oid_to_hex(&object));
 465        }
 466
 467        prepare_note_data(&object, &d, note);
 468        if (d.buf.len || allow_empty) {
 469                write_note_data(&d, &new_note);
 470                if (add_note(t, &object, &new_note, combine_notes_overwrite))
 471                        BUG("combine_notes_overwrite failed");
 472                commit_notes(t, "Notes added by 'git notes add'");
 473        } else {
 474                fprintf(stderr, _("Removing note for object %s\n"),
 475                        oid_to_hex(&object));
 476                remove_note(t, object.hash);
 477                commit_notes(t, "Notes removed by 'git notes add'");
 478        }
 479
 480        free_note_data(&d);
 481        free_notes(t);
 482        return 0;
 483}
 484
 485static int copy(int argc, const char **argv, const char *prefix)
 486{
 487        int retval = 0, force = 0, from_stdin = 0;
 488        const struct object_id *from_note, *note;
 489        const char *object_ref;
 490        struct object_id object, from_obj;
 491        struct notes_tree *t;
 492        const char *rewrite_cmd = NULL;
 493        struct option options[] = {
 494                OPT__FORCE(&force, N_("replace existing notes"), PARSE_OPT_NOCOMPLETE),
 495                OPT_BOOL(0, "stdin", &from_stdin, N_("read objects from stdin")),
 496                OPT_STRING(0, "for-rewrite", &rewrite_cmd, N_("command"),
 497                           N_("load rewriting config for <command> (implies "
 498                              "--stdin)")),
 499                OPT_END()
 500        };
 501
 502        argc = parse_options(argc, argv, prefix, options, git_notes_copy_usage,
 503                             0);
 504
 505        if (from_stdin || rewrite_cmd) {
 506                if (argc) {
 507                        error(_("too many parameters"));
 508                        usage_with_options(git_notes_copy_usage, options);
 509                } else {
 510                        return notes_copy_from_stdin(force, rewrite_cmd);
 511                }
 512        }
 513
 514        if (argc < 2) {
 515                error(_("too few parameters"));
 516                usage_with_options(git_notes_copy_usage, options);
 517        }
 518        if (2 < argc) {
 519                error(_("too many parameters"));
 520                usage_with_options(git_notes_copy_usage, options);
 521        }
 522
 523        if (get_oid(argv[0], &from_obj))
 524                die(_("failed to resolve '%s' as a valid ref."), argv[0]);
 525
 526        object_ref = 1 < argc ? argv[1] : "HEAD";
 527
 528        if (get_oid(object_ref, &object))
 529                die(_("failed to resolve '%s' as a valid ref."), object_ref);
 530
 531        t = init_notes_check("copy", NOTES_INIT_WRITABLE);
 532        note = get_note(t, &object);
 533
 534        if (note) {
 535                if (!force) {
 536                        retval = error(_("Cannot copy notes. Found existing "
 537                                       "notes for object %s. Use '-f' to "
 538                                       "overwrite existing notes"),
 539                                       oid_to_hex(&object));
 540                        goto out;
 541                }
 542                fprintf(stderr, _("Overwriting existing notes for object %s\n"),
 543                        oid_to_hex(&object));
 544        }
 545
 546        from_note = get_note(t, &from_obj);
 547        if (!from_note) {
 548                retval = error(_("missing notes on source object %s. Cannot "
 549                               "copy."), oid_to_hex(&from_obj));
 550                goto out;
 551        }
 552
 553        if (add_note(t, &object, from_note, combine_notes_overwrite))
 554                BUG("combine_notes_overwrite failed");
 555        commit_notes(t, "Notes added by 'git notes copy'");
 556out:
 557        free_notes(t);
 558        return retval;
 559}
 560
 561static int append_edit(int argc, const char **argv, const char *prefix)
 562{
 563        int allow_empty = 0;
 564        const char *object_ref;
 565        struct notes_tree *t;
 566        struct object_id object, new_note;
 567        const struct object_id *note;
 568        char *logmsg;
 569        const char * const *usage;
 570        struct note_data d = { 0, 0, NULL, STRBUF_INIT };
 571        struct option options[] = {
 572                { OPTION_CALLBACK, 'm', "message", &d, N_("message"),
 573                        N_("note contents as a string"), PARSE_OPT_NONEG,
 574                        parse_msg_arg},
 575                { OPTION_CALLBACK, 'F', "file", &d, N_("file"),
 576                        N_("note contents in a file"), PARSE_OPT_NONEG,
 577                        parse_file_arg},
 578                { OPTION_CALLBACK, 'c', "reedit-message", &d, N_("object"),
 579                        N_("reuse and edit specified note object"), PARSE_OPT_NONEG,
 580                        parse_reedit_arg},
 581                { OPTION_CALLBACK, 'C', "reuse-message", &d, N_("object"),
 582                        N_("reuse specified note object"), PARSE_OPT_NONEG,
 583                        parse_reuse_arg},
 584                OPT_BOOL(0, "allow-empty", &allow_empty,
 585                        N_("allow storing empty note")),
 586                OPT_END()
 587        };
 588        int edit = !strcmp(argv[0], "edit");
 589
 590        usage = edit ? git_notes_edit_usage : git_notes_append_usage;
 591        argc = parse_options(argc, argv, prefix, options, usage,
 592                             PARSE_OPT_KEEP_ARGV0);
 593
 594        if (2 < argc) {
 595                error(_("too many parameters"));
 596                usage_with_options(usage, options);
 597        }
 598
 599        if (d.given && edit)
 600                fprintf(stderr, _("The -m/-F/-c/-C options have been deprecated "
 601                        "for the 'edit' subcommand.\n"
 602                        "Please use 'git notes add -f -m/-F/-c/-C' instead.\n"));
 603
 604        object_ref = 1 < argc ? argv[1] : "HEAD";
 605
 606        if (get_oid(object_ref, &object))
 607                die(_("failed to resolve '%s' as a valid ref."), object_ref);
 608
 609        t = init_notes_check(argv[0], NOTES_INIT_WRITABLE);
 610        note = get_note(t, &object);
 611
 612        prepare_note_data(&object, &d, edit && note ? note : NULL);
 613
 614        if (note && !edit) {
 615                /* Append buf to previous note contents */
 616                unsigned long size;
 617                enum object_type type;
 618                char *prev_buf = read_object_file(note, &type, &size);
 619
 620                strbuf_grow(&d.buf, size + 1);
 621                if (d.buf.len && prev_buf && size)
 622                        strbuf_insert(&d.buf, 0, "\n", 1);
 623                if (prev_buf && size)
 624                        strbuf_insert(&d.buf, 0, prev_buf, size);
 625                free(prev_buf);
 626        }
 627
 628        if (d.buf.len || allow_empty) {
 629                write_note_data(&d, &new_note);
 630                if (add_note(t, &object, &new_note, combine_notes_overwrite))
 631                        BUG("combine_notes_overwrite failed");
 632                logmsg = xstrfmt("Notes added by 'git notes %s'", argv[0]);
 633        } else {
 634                fprintf(stderr, _("Removing note for object %s\n"),
 635                        oid_to_hex(&object));
 636                remove_note(t, object.hash);
 637                logmsg = xstrfmt("Notes removed by 'git notes %s'", argv[0]);
 638        }
 639        commit_notes(t, logmsg);
 640
 641        free(logmsg);
 642        free_note_data(&d);
 643        free_notes(t);
 644        return 0;
 645}
 646
 647static int show(int argc, const char **argv, const char *prefix)
 648{
 649        const char *object_ref;
 650        struct notes_tree *t;
 651        struct object_id object;
 652        const struct object_id *note;
 653        int retval;
 654        struct option options[] = {
 655                OPT_END()
 656        };
 657
 658        argc = parse_options(argc, argv, prefix, options, git_notes_show_usage,
 659                             0);
 660
 661        if (1 < argc) {
 662                error(_("too many parameters"));
 663                usage_with_options(git_notes_show_usage, options);
 664        }
 665
 666        object_ref = argc ? argv[0] : "HEAD";
 667
 668        if (get_oid(object_ref, &object))
 669                die(_("failed to resolve '%s' as a valid ref."), object_ref);
 670
 671        t = init_notes_check("show", 0);
 672        note = get_note(t, &object);
 673
 674        if (!note)
 675                retval = error(_("no note found for object %s."),
 676                               oid_to_hex(&object));
 677        else {
 678                const char *show_args[3] = {"show", oid_to_hex(note), NULL};
 679                retval = execv_git_cmd(show_args);
 680        }
 681        free_notes(t);
 682        return retval;
 683}
 684
 685static int merge_abort(struct notes_merge_options *o)
 686{
 687        int ret = 0;
 688
 689        /*
 690         * Remove .git/NOTES_MERGE_PARTIAL and .git/NOTES_MERGE_REF, and call
 691         * notes_merge_abort() to remove .git/NOTES_MERGE_WORKTREE.
 692         */
 693
 694        if (delete_ref(NULL, "NOTES_MERGE_PARTIAL", NULL, 0))
 695                ret += error(_("failed to delete ref NOTES_MERGE_PARTIAL"));
 696        if (delete_ref(NULL, "NOTES_MERGE_REF", NULL, REF_NO_DEREF))
 697                ret += error(_("failed to delete ref NOTES_MERGE_REF"));
 698        if (notes_merge_abort(o))
 699                ret += error(_("failed to remove 'git notes merge' worktree"));
 700        return ret;
 701}
 702
 703static int merge_commit(struct notes_merge_options *o)
 704{
 705        struct strbuf msg = STRBUF_INIT;
 706        struct object_id oid, parent_oid;
 707        struct notes_tree *t;
 708        struct commit *partial;
 709        struct pretty_print_context pretty_ctx;
 710        void *local_ref_to_free;
 711        int ret;
 712
 713        /*
 714         * Read partial merge result from .git/NOTES_MERGE_PARTIAL,
 715         * and target notes ref from .git/NOTES_MERGE_REF.
 716         */
 717
 718        if (get_oid("NOTES_MERGE_PARTIAL", &oid))
 719                die(_("failed to read ref NOTES_MERGE_PARTIAL"));
 720        else if (!(partial = lookup_commit_reference(the_repository, &oid)))
 721                die(_("could not find commit from NOTES_MERGE_PARTIAL."));
 722        else if (parse_commit(partial))
 723                die(_("could not parse commit from NOTES_MERGE_PARTIAL."));
 724
 725        if (partial->parents)
 726                oidcpy(&parent_oid, &partial->parents->item->object.oid);
 727        else
 728                oidclr(&parent_oid);
 729
 730        t = xcalloc(1, sizeof(struct notes_tree));
 731        init_notes(t, "NOTES_MERGE_PARTIAL", combine_notes_overwrite, 0);
 732
 733        o->local_ref = local_ref_to_free =
 734                resolve_refdup("NOTES_MERGE_REF", 0, &oid, NULL);
 735        if (!o->local_ref)
 736                die(_("failed to resolve NOTES_MERGE_REF"));
 737
 738        if (notes_merge_commit(o, t, partial, &oid))
 739                die(_("failed to finalize notes merge"));
 740
 741        /* Reuse existing commit message in reflog message */
 742        memset(&pretty_ctx, 0, sizeof(pretty_ctx));
 743        format_commit_message(partial, "%s", &msg, &pretty_ctx);
 744        strbuf_trim(&msg);
 745        strbuf_insert(&msg, 0, "notes: ", 7);
 746        update_ref(msg.buf, o->local_ref, &oid,
 747                   is_null_oid(&parent_oid) ? NULL : &parent_oid,
 748                   0, UPDATE_REFS_DIE_ON_ERR);
 749
 750        free_notes(t);
 751        strbuf_release(&msg);
 752        ret = merge_abort(o);
 753        free(local_ref_to_free);
 754        return ret;
 755}
 756
 757static int git_config_get_notes_strategy(const char *key,
 758                                         enum notes_merge_strategy *strategy)
 759{
 760        char *value;
 761
 762        if (git_config_get_string(key, &value))
 763                return 1;
 764        if (parse_notes_merge_strategy(value, strategy))
 765                git_die_config(key, _("unknown notes merge strategy %s"), value);
 766
 767        free(value);
 768        return 0;
 769}
 770
 771static int merge(int argc, const char **argv, const char *prefix)
 772{
 773        struct strbuf remote_ref = STRBUF_INIT, msg = STRBUF_INIT;
 774        struct object_id result_oid;
 775        struct notes_tree *t;
 776        struct notes_merge_options o;
 777        int do_merge = 0, do_commit = 0, do_abort = 0;
 778        int verbosity = 0, result;
 779        const char *strategy = NULL;
 780        struct option options[] = {
 781                OPT_GROUP(N_("General options")),
 782                OPT__VERBOSITY(&verbosity),
 783                OPT_GROUP(N_("Merge options")),
 784                OPT_STRING('s', "strategy", &strategy, N_("strategy"),
 785                           N_("resolve notes conflicts using the given strategy "
 786                              "(manual/ours/theirs/union/cat_sort_uniq)")),
 787                OPT_GROUP(N_("Committing unmerged notes")),
 788                OPT_SET_INT_F(0, "commit", &do_commit,
 789                              N_("finalize notes merge by committing unmerged notes"),
 790                              1, PARSE_OPT_NONEG),
 791                OPT_GROUP(N_("Aborting notes merge resolution")),
 792                OPT_SET_INT_F(0, "abort", &do_abort,
 793                              N_("abort notes merge"),
 794                              1, PARSE_OPT_NONEG),
 795                OPT_END()
 796        };
 797
 798        argc = parse_options(argc, argv, prefix, options,
 799                             git_notes_merge_usage, 0);
 800
 801        if (strategy || do_commit + do_abort == 0)
 802                do_merge = 1;
 803        if (do_merge + do_commit + do_abort != 1) {
 804                error(_("cannot mix --commit, --abort or -s/--strategy"));
 805                usage_with_options(git_notes_merge_usage, options);
 806        }
 807
 808        if (do_merge && argc != 1) {
 809                error(_("must specify a notes ref to merge"));
 810                usage_with_options(git_notes_merge_usage, options);
 811        } else if (!do_merge && argc) {
 812                error(_("too many parameters"));
 813                usage_with_options(git_notes_merge_usage, options);
 814        }
 815
 816        init_notes_merge_options(&o);
 817        o.verbosity = verbosity + NOTES_MERGE_VERBOSITY_DEFAULT;
 818
 819        if (do_abort)
 820                return merge_abort(&o);
 821        if (do_commit)
 822                return merge_commit(&o);
 823
 824        o.local_ref = default_notes_ref();
 825        strbuf_addstr(&remote_ref, argv[0]);
 826        expand_loose_notes_ref(&remote_ref);
 827        o.remote_ref = remote_ref.buf;
 828
 829        t = init_notes_check("merge", NOTES_INIT_WRITABLE);
 830
 831        if (strategy) {
 832                if (parse_notes_merge_strategy(strategy, &o.strategy)) {
 833                        error(_("unknown -s/--strategy: %s"), strategy);
 834                        usage_with_options(git_notes_merge_usage, options);
 835                }
 836        } else {
 837                struct strbuf merge_key = STRBUF_INIT;
 838                const char *short_ref = NULL;
 839
 840                if (!skip_prefix(o.local_ref, "refs/notes/", &short_ref))
 841                        BUG("local ref %s is outside of refs/notes/",
 842                            o.local_ref);
 843
 844                strbuf_addf(&merge_key, "notes.%s.mergeStrategy", short_ref);
 845
 846                if (git_config_get_notes_strategy(merge_key.buf, &o.strategy))
 847                        git_config_get_notes_strategy("notes.mergeStrategy", &o.strategy);
 848
 849                strbuf_release(&merge_key);
 850        }
 851
 852        strbuf_addf(&msg, "notes: Merged notes from %s into %s",
 853                    remote_ref.buf, default_notes_ref());
 854        strbuf_add(&(o.commit_msg), msg.buf + 7, msg.len - 7); /* skip "notes: " */
 855
 856        result = notes_merge(&o, t, &result_oid);
 857
 858        if (result >= 0) /* Merge resulted (trivially) in result_oid */
 859                /* Update default notes ref with new commit */
 860                update_ref(msg.buf, default_notes_ref(), &result_oid, NULL, 0,
 861                           UPDATE_REFS_DIE_ON_ERR);
 862        else { /* Merge has unresolved conflicts */
 863                const struct worktree *wt;
 864                /* Update .git/NOTES_MERGE_PARTIAL with partial merge result */
 865                update_ref(msg.buf, "NOTES_MERGE_PARTIAL", &result_oid, NULL,
 866                           0, UPDATE_REFS_DIE_ON_ERR);
 867                /* Store ref-to-be-updated into .git/NOTES_MERGE_REF */
 868                wt = find_shared_symref("NOTES_MERGE_REF", default_notes_ref());
 869                if (wt)
 870                        die(_("a notes merge into %s is already in-progress at %s"),
 871                            default_notes_ref(), wt->path);
 872                if (create_symref("NOTES_MERGE_REF", default_notes_ref(), NULL))
 873                        die(_("failed to store link to current notes ref (%s)"),
 874                            default_notes_ref());
 875                fprintf(stderr, _("Automatic notes merge failed. Fix conflicts in %s "
 876                                  "and commit the result with 'git notes merge --commit', "
 877                                  "or abort the merge with 'git notes merge --abort'.\n"),
 878                        git_path(NOTES_MERGE_WORKTREE));
 879        }
 880
 881        free_notes(t);
 882        strbuf_release(&remote_ref);
 883        strbuf_release(&msg);
 884        return result < 0; /* return non-zero on conflicts */
 885}
 886
 887#define IGNORE_MISSING 1
 888
 889static int remove_one_note(struct notes_tree *t, const char *name, unsigned flag)
 890{
 891        int status;
 892        struct object_id oid;
 893        if (get_oid(name, &oid))
 894                return error(_("Failed to resolve '%s' as a valid ref."), name);
 895        status = remove_note(t, oid.hash);
 896        if (status)
 897                fprintf(stderr, _("Object %s has no note\n"), name);
 898        else
 899                fprintf(stderr, _("Removing note for object %s\n"), name);
 900        return (flag & IGNORE_MISSING) ? 0 : status;
 901}
 902
 903static int remove_cmd(int argc, const char **argv, const char *prefix)
 904{
 905        unsigned flag = 0;
 906        int from_stdin = 0;
 907        struct option options[] = {
 908                OPT_BIT(0, "ignore-missing", &flag,
 909                        N_("attempt to remove non-existent note is not an error"),
 910                        IGNORE_MISSING),
 911                OPT_BOOL(0, "stdin", &from_stdin,
 912                            N_("read object names from the standard input")),
 913                OPT_END()
 914        };
 915        struct notes_tree *t;
 916        int retval = 0;
 917
 918        argc = parse_options(argc, argv, prefix, options,
 919                             git_notes_remove_usage, 0);
 920
 921        t = init_notes_check("remove", NOTES_INIT_WRITABLE);
 922
 923        if (!argc && !from_stdin) {
 924                retval = remove_one_note(t, "HEAD", flag);
 925        } else {
 926                while (*argv) {
 927                        retval |= remove_one_note(t, *argv, flag);
 928                        argv++;
 929                }
 930        }
 931        if (from_stdin) {
 932                struct strbuf sb = STRBUF_INIT;
 933                while (strbuf_getwholeline(&sb, stdin, '\n') != EOF) {
 934                        strbuf_rtrim(&sb);
 935                        retval |= remove_one_note(t, sb.buf, flag);
 936                }
 937                strbuf_release(&sb);
 938        }
 939        if (!retval)
 940                commit_notes(t, "Notes removed by 'git notes remove'");
 941        free_notes(t);
 942        return retval;
 943}
 944
 945static int prune(int argc, const char **argv, const char *prefix)
 946{
 947        struct notes_tree *t;
 948        int show_only = 0, verbose = 0;
 949        struct option options[] = {
 950                OPT__DRY_RUN(&show_only, N_("do not remove, show only")),
 951                OPT__VERBOSE(&verbose, N_("report pruned notes")),
 952                OPT_END()
 953        };
 954
 955        argc = parse_options(argc, argv, prefix, options, git_notes_prune_usage,
 956                             0);
 957
 958        if (argc) {
 959                error(_("too many parameters"));
 960                usage_with_options(git_notes_prune_usage, options);
 961        }
 962
 963        t = init_notes_check("prune", NOTES_INIT_WRITABLE);
 964
 965        prune_notes(t, (verbose ? NOTES_PRUNE_VERBOSE : 0) |
 966                (show_only ? NOTES_PRUNE_VERBOSE|NOTES_PRUNE_DRYRUN : 0) );
 967        if (!show_only)
 968                commit_notes(t, "Notes removed by 'git notes prune'");
 969        free_notes(t);
 970        return 0;
 971}
 972
 973static int get_ref(int argc, const char **argv, const char *prefix)
 974{
 975        struct option options[] = { OPT_END() };
 976        argc = parse_options(argc, argv, prefix, options,
 977                             git_notes_get_ref_usage, 0);
 978
 979        if (argc) {
 980                error(_("too many parameters"));
 981                usage_with_options(git_notes_get_ref_usage, options);
 982        }
 983
 984        puts(default_notes_ref());
 985        return 0;
 986}
 987
 988int cmd_notes(int argc, const char **argv, const char *prefix)
 989{
 990        int result;
 991        const char *override_notes_ref = NULL;
 992        struct option options[] = {
 993                OPT_STRING(0, "ref", &override_notes_ref, N_("notes-ref"),
 994                           N_("use notes from <notes-ref>")),
 995                OPT_END()
 996        };
 997
 998        git_config(git_default_config, NULL);
 999        argc = parse_options(argc, argv, prefix, options, git_notes_usage,
1000                             PARSE_OPT_STOP_AT_NON_OPTION);
1001
1002        if (override_notes_ref) {
1003                struct strbuf sb = STRBUF_INIT;
1004                strbuf_addstr(&sb, override_notes_ref);
1005                expand_notes_ref(&sb);
1006                setenv("GIT_NOTES_REF", sb.buf, 1);
1007                strbuf_release(&sb);
1008        }
1009
1010        if (argc < 1 || !strcmp(argv[0], "list"))
1011                result = list(argc, argv, prefix);
1012        else if (!strcmp(argv[0], "add"))
1013                result = add(argc, argv, prefix);
1014        else if (!strcmp(argv[0], "copy"))
1015                result = copy(argc, argv, prefix);
1016        else if (!strcmp(argv[0], "append") || !strcmp(argv[0], "edit"))
1017                result = append_edit(argc, argv, prefix);
1018        else if (!strcmp(argv[0], "show"))
1019                result = show(argc, argv, prefix);
1020        else if (!strcmp(argv[0], "merge"))
1021                result = merge(argc, argv, prefix);
1022        else if (!strcmp(argv[0], "remove"))
1023                result = remove_cmd(argc, argv, prefix);
1024        else if (!strcmp(argv[0], "prune"))
1025                result = prune(argc, argv, prefix);
1026        else if (!strcmp(argv[0], "get-ref"))
1027                result = get_ref(argc, argv, prefix);
1028        else {
1029                result = error(_("unknown subcommand: %s"), argv[0]);
1030                usage_with_options(git_notes_usage, options);
1031        }
1032
1033        return result ? 1 : 0;
1034}