Merge branch 'jt/format-patch-rfc'
authorJunio C Hamano <gitster@pobox.com>
Mon, 26 Sep 2016 23:09:17 +0000 (16:09 -0700)
committerJunio C Hamano <gitster@pobox.com>
Mon, 26 Sep 2016 23:09:17 +0000 (16:09 -0700)
In some projects, it is common to use "[RFC PATCH]" as the subject
prefix for a patch meant for discussion rather than application. A
new option "--rfc" was a short-hand for "--subject-prefix=RFC PATCH"
to help the participants of such projects.

* jt/format-patch-rfc:
format-patch: add "--rfc" for the common case of [RFC PATCH]

1  2 
builtin/log.c
t/t4014-format-patch.sh
diff --combined builtin/log.c
index b8cdf2b9d9cbd30950810eaa5dd5091dc23eb3c6,c657900d95ae47a483c8d192108a1d078daeb462..55d20cc2d88ab03d96f0476b222be3b2f6832ed9
@@@ -464,9 -464,9 +464,9 @@@ static void show_tagger(char *buf, int 
        strbuf_release(&out);
  }
  
 -static int show_blob_object(const unsigned char *sha1, struct rev_info *rev, const char *obj_name)
 +static int show_blob_object(const struct object_id *oid, struct rev_info *rev, const char *obj_name)
  {
 -      unsigned char sha1c[20];
 +      struct object_id oidc;
        struct object_context obj_context;
        char *buf;
        unsigned long size;
        fflush(rev->diffopt.file);
        if (!DIFF_OPT_TOUCHED(&rev->diffopt, ALLOW_TEXTCONV) ||
            !DIFF_OPT_TST(&rev->diffopt, ALLOW_TEXTCONV))
 -              return stream_blob_to_fd(1, sha1, NULL, 0);
 +              return stream_blob_to_fd(1, oid, NULL, 0);
  
 -      if (get_sha1_with_context(obj_name, 0, sha1c, &obj_context))
 +      if (get_sha1_with_context(obj_name, 0, oidc.hash, &obj_context))
                die(_("Not a valid object name %s"), obj_name);
        if (!obj_context.path[0] ||
 -          !textconv_object(obj_context.path, obj_context.mode, sha1c, 1, &buf, &size))
 -              return stream_blob_to_fd(1, sha1, NULL, 0);
 +          !textconv_object(obj_context.path, obj_context.mode, &oidc, 1, &buf, &size))
 +              return stream_blob_to_fd(1, oid, NULL, 0);
  
        if (!buf)
                die(_("git show %s: bad file"), obj_name);
        return 0;
  }
  
 -static int show_tag_object(const unsigned char *sha1, struct rev_info *rev)
 +static int show_tag_object(const struct object_id *oid, struct rev_info *rev)
  {
        unsigned long size;
        enum object_type type;
 -      char *buf = read_sha1_file(sha1, &type, &size);
 +      char *buf = read_sha1_file(oid->hash, &type, &size);
        int offset = 0;
  
        if (!buf)
 -              return error(_("Could not read object %s"), sha1_to_hex(sha1));
 +              return error(_("Could not read object %s"), oid_to_hex(oid));
  
        assert(type == OBJ_TAG);
        while (offset < size && buf[offset] != '\n') {
@@@ -574,7 -574,7 +574,7 @@@ int cmd_show(int argc, const char **arg
                const char *name = objects[i].name;
                switch (o->type) {
                case OBJ_BLOB:
 -                      ret = show_blob_object(o->oid.hash, &rev, name);
 +                      ret = show_blob_object(&o->oid, &rev, name);
                        break;
                case OBJ_TAG: {
                        struct tag *t = (struct tag *)o;
                                        diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
                                        t->tag,
                                        diff_get_color_opt(&rev.diffopt, DIFF_RESET));
 -                      ret = show_tag_object(o->oid.hash, &rev);
 +                      ret = show_tag_object(&o->oid, &rev);
                        rev.shown_one = 1;
                        if (ret)
                                break;
@@@ -1042,6 -1042,7 +1042,6 @@@ static void make_cover_letter(struct re
        diff_flush(&opts);
  
        fprintf(rev->diffopt.file, "\n");
 -      print_signature(rev->diffopt.file);
  }
  
  static const char *clean_message_id(const char *msg_id)
@@@ -1111,6 -1112,11 +1111,11 @@@ static int subject_prefix_callback(cons
        return 0;
  }
  
+ static int rfc_callback(const struct option *opt, const char *arg, int unset)
+ {
+       return subject_prefix_callback(opt, "RFC PATCH", unset);
+ }
  static int numbered_cmdline_opt = 0;
  
  static int numbered_callback(const struct option *opt, const char *arg,
@@@ -1247,11 -1253,11 +1252,11 @@@ static struct commit *get_base_commit(c
                if (upstream) {
                        struct commit_list *base_list;
                        struct commit *commit;
 -                      unsigned char sha1[20];
 +                      struct object_id oid;
  
 -                      if (get_sha1(upstream, sha1))
 +                      if (get_oid(upstream, &oid))
                                die(_("Failed to resolve '%s' as a valid ref."), upstream);
 -                      commit = lookup_commit_or_die(sha1, "upstream base");
 +                      commit = lookup_commit_or_die(oid.hash, "upstream base");
                        base_list = get_merge_bases_many(commit, total, list);
                        /* There should be one and only one merge base. */
                        if (!base_list || base_list->next)
@@@ -1338,15 -1344,15 +1343,15 @@@ static void prepare_bases(struct base_t
         * and stuff them in bases structure.
         */
        while ((commit = get_revision(&revs)) != NULL) {
 -              unsigned char sha1[20];
 +              struct object_id oid;
                struct object_id *patch_id;
                if (commit->util)
                        continue;
 -              if (commit_patch_id(commit, &diffopt, sha1, 0))
 +              if (commit_patch_id(commit, &diffopt, oid.hash, 0))
                        die(_("cannot get patch id"));
                ALLOC_GROW(bases->patch_id, bases->nr_patch_id + 1, bases->alloc_patch_id);
                patch_id = bases->patch_id + bases->nr_patch_id;
 -              hashcpy(patch_id->hash, sha1);
 +              oidcpy(patch_id, &oid);
                bases->nr_patch_id++;
        }
  }
@@@ -1360,7 -1366,7 +1365,7 @@@ static void print_bases(struct base_tre
                return;
  
        /* Show the base commit */
 -      fprintf(file, "base-commit: %s\n", oid_to_hex(&bases->base_commit));
 +      fprintf(file, "\nbase-commit: %s\n", oid_to_hex(&bases->base_commit));
  
        /* Show the prerequisite patches */
        for (i = bases->nr_patch_id - 1; i >= 0; i--)
@@@ -1418,6 -1424,9 +1423,9 @@@ int cmd_format_patch(int argc, const ch
                            N_("start numbering patches at <n> instead of 1")),
                OPT_INTEGER('v', "reroll-count", &reroll_count,
                            N_("mark the series as Nth re-roll")),
+               { OPTION_CALLBACK, 0, "rfc", &rev, NULL,
+                           N_("Use [RFC PATCH] instead of [PATCH]"),
+                           PARSE_OPT_NOARG | PARSE_OPT_NONEG, rfc_callback },
                { OPTION_CALLBACK, 0, "subject-prefix", &rev, N_("prefix"),
                            N_("Use [<prefix>] instead of [PATCH]"),
                            PARSE_OPT_NONEG, subject_prefix_callback },
        if (numbered && keep_subject)
                die (_("-n and -k are mutually exclusive."));
        if (keep_subject && subject_prefix)
-               die (_("--subject-prefix and -k are mutually exclusive."));
+               die (_("--subject-prefix/--rfc and -k are mutually exclusive."));
        rev.preserve_subject = keep_subject;
  
        argc = setup_revisions(argc, argv, &rev, &s_r_opt);
                        check_head = 1;
  
                if (check_head) {
 -                      unsigned char sha1[20];
 +                      struct object_id oid;
                        const char *ref, *v;
                        ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
 -                                               sha1, NULL);
 +                                               oid.hash, NULL);
                        if (ref && skip_prefix(ref, "refs/heads/", &v))
                                branch_name = xstrdup(v);
                        else
                /* nothing to do */
                return 0;
        total = nr;
 -      if (!keep_subject && auto_number && total > 1)
 -              numbered = 1;
 -      if (numbered)
 -              rev.total = total + start_number - 1;
        if (cover_letter == -1) {
                if (config_cover_letter == COVER_AUTO)
                        cover_letter = (total > 1);
                else
                        cover_letter = (config_cover_letter == COVER_ON);
        }
 +      if (!keep_subject && auto_number && (total > 1 || cover_letter))
 +              numbered = 1;
 +      if (numbered)
 +              rev.total = total + start_number - 1;
  
        if (!signature) {
                ; /* --no-signature inhibits all signatures */
                make_cover_letter(&rev, use_stdout,
                                  origin, nr, list, branch_name, quiet);
                print_bases(&bases, rev.diffopt.file);
 +              print_signature(rev.diffopt.file);
                total++;
                start_number--;
        }
                if (!use_stdout)
                        rev.shown_one = 0;
                if (shown) {
 +                      print_bases(&bases, rev.diffopt.file);
                        if (rev.mime_boundary)
                                fprintf(rev.diffopt.file, "\n--%s%s--\n\n\n",
                                       mime_boundary_leader,
                                       rev.mime_boundary);
                        else
                                print_signature(rev.diffopt.file);
 -                      print_bases(&bases, rev.diffopt.file);
                }
                if (!use_stdout)
                        fclose(rev.diffopt.file);
  
  static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
  {
 -      unsigned char sha1[20];
 -      if (get_sha1(arg, sha1) == 0) {
 -              struct commit *commit = lookup_commit_reference(sha1);
 +      struct object_id oid;
 +      if (get_oid(arg, &oid) == 0) {
 +              struct commit *commit = lookup_commit_reference(oid.hash);
                if (commit) {
                        commit->object.flags |= flags;
                        add_pending_object(revs, &commit->object, arg);
diff --combined t/t4014-format-patch.sh
index 8d90a6e500362afe75fb724e07848e904753e7fb,ed4d3c2e59a63bd25478f7654bab20bcb35fd29c..ba4902df2b605f89ec2abcac50abefc2f23fc9bf
@@@ -754,22 -754,9 +754,22 @@@ test_expect_success 'format-patch --ign
        git format-patch --ignore-if-in-upstream HEAD
  '
  
 +git_version="$(git --version | sed "s/.* //")"
 +
 +signature() {
 +      printf "%s\n%s\n\n" "-- " "${1:-$git_version}"
 +}
 +
 +test_expect_success 'format-patch default signature' '
 +      git format-patch --stdout -1 | tail -n 3 >output &&
 +      signature >expect &&
 +      test_cmp expect output
 +'
 +
  test_expect_success 'format-patch --signature' '
 -      git format-patch --stdout --signature="my sig" -1 >output &&
 -      grep "my sig" output
 +      git format-patch --stdout --signature="my sig" -1 | tail -n 3 >output &&
 +      signature "my sig" >expect &&
 +      test_cmp expect output
  '
  
  test_expect_success 'format-patch with format.signature config' '
@@@ -1086,6 -1073,15 +1086,15 @@@ test_expect_success 'empty subject pref
        test_cmp expect actual
  '
  
+ test_expect_success '--rfc' '
+       cat >expect <<-\EOF &&
+       Subject: [RFC PATCH 1/1] header with . in it
+       EOF
+       git format-patch -n -1 --stdout --rfc >patch &&
+       grep ^Subject: patch >actual &&
+       test_cmp expect actual
+ '
  test_expect_success '--from=ident notices bogus ident' '
        test_must_fail git format-patch -1 --stdout --from=foo >patch
  '
@@@ -1515,12 -1511,12 +1524,12 @@@ test_expect_success 'format-patch -o ov
  
  test_expect_success 'format-patch --base' '
        git checkout side &&
 -      git format-patch --stdout --base=HEAD~3 -1 >patch &&
 -      grep "^base-commit:" patch >actual &&
 -      grep "^prerequisite-patch-id:" patch >>actual &&
 -      echo "base-commit: $(git rev-parse HEAD~3)" >expected &&
 +      git format-patch --stdout --base=HEAD~3 -1 | tail -n 7 >actual &&
 +      echo >expected &&
 +      echo "base-commit: $(git rev-parse HEAD~3)" >>expected &&
        echo "prerequisite-patch-id: $(git show --patch HEAD~2 | git patch-id --stable | awk "{print \$1}")" >>expected &&
        echo "prerequisite-patch-id: $(git show --patch HEAD~1 | git patch-id --stable | awk "{print \$1}")" >>expected &&
 +      signature >> expected &&
        test_cmp expected actual
  '
  
@@@ -1618,14 -1614,6 +1627,14 @@@ test_expect_success 'format-patch --bas
        test_cmp expected actual
  '
  
 +test_expect_success 'format-patch --base with --attach' '
 +      git format-patch --attach=mimemime --stdout --base=HEAD~ -1 >patch &&
 +      sed -n -e "/^base-commit:/s/.*/1/p" -e "/^---*mimemime--$/s/.*/2/p" \
 +              patch >actual &&
 +      test_write_lines 1 2 >expect &&
 +      test_cmp expect actual
 +'
 +
  test_expect_success 'format-patch --pretty=mboxrd' '
        sp=" " &&
        cat >msg <<-INPUT_END &&