From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS31976 209.132.180.0/23 X-Spam-Status: No, score=-4.3 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by dcvr.yhbt.net (Postfix) with ESMTP id A31FE20248 for ; Fri, 1 Mar 2019 17:14:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2389249AbfCARO4 (ORCPT ); Fri, 1 Mar 2019 12:14:56 -0500 Received: from mail-it1-f193.google.com ([209.85.166.193]:38404 "EHLO mail-it1-f193.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728531AbfCAROz (ORCPT ); Fri, 1 Mar 2019 12:14:55 -0500 Received: by mail-it1-f193.google.com with SMTP id l66so22483648itg.3 for ; Fri, 01 Mar 2019 09:14:54 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=fOyzKsQ++E/X3hV/lkawzSjj9UJtM+kGJtz1xZ2pq4M=; b=QbVi6wxlJO7/hSEr9/hbaSwKf2OAjVB9ayLPDzEsDdumHRmFBJzXUnDEwyuEKjuf8p BDO5C0eEyvLTrtLvAu+HfVZ07C2f+aMkZhcaknB+60V7q2NN32c0wuv+ylZHWbwT7kRE rdd6lwFS/x26A7dr4mK5zJc1dqXmAXCLTk7I8jr/ehKqnS7RpHiTwCJqXcpD6+mHDnmn Wh22wD9AYLm48dQfZJax5LzOsscpqA9j4mxPFEZmGgtgjNzk5sm8Qtvog7jjtP2hiEU/ 7qynPrJaikf4Stl5Nvt3a9Nj0pCN2Ff3uj6OuaeMiQOAAs6C7YDQ+UWR9FgvlnbUe1mj RVrg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=fOyzKsQ++E/X3hV/lkawzSjj9UJtM+kGJtz1xZ2pq4M=; b=TJF1mWpSz/tEdJvdSiU29NBlAuWOOeYDuTH90T+DgFl1MSjutyUmUewagbdtqJ48or Yu6RSoVpauWnkQRVXWgSh29Thy8AhMC+3dyeMtb3Nl1mBHLJKacRqHn8X+SYhJrf5hsl Q3p5YF5JRzpNZVETvycSiBIltw9O9w5VVINRYdBmUSyJ+/8HMx0g6DF6h+WwOlEIOKKV /gxj7O3ZIOOg0b3TKSLxqmOLM6YUqWLrLJ2h8+W8Aab11m95rozLe5gL5YN//Vi2VBg4 UiOdTzYjk3L7pg6rvcV9pwUjd5fO3816uKkBBqcWb3VPgJ2gSwYKQIOZNeraW7cNpjmX RG2Q== X-Gm-Message-State: APjAAAVG18zh/5r566YKZlXecDasrMkLZfHZ2Ou7/1cbMkwm9XfIckF1 ABB+Si+soi/23H4JnNXiswhzt6F0+ck= X-Google-Smtp-Source: APXvYqxeGH9k43r8+AfqY70OYOIktTjwXq0KsrS4HjVsXiC1fbhQSGG4/NpJa54+hO8sr3fK/IiY3A== X-Received: by 2002:a05:660c:5cb:: with SMTP id x11mr3172986itk.76.1551460493987; Fri, 01 Mar 2019 09:14:53 -0800 (PST) Received: from localhost.localdomain ([68.168.116.19]) by smtp.gmail.com with ESMTPSA id b8sm7248846ios.31.2019.03.01.09.14.50 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 01 Mar 2019 09:14:53 -0800 (PST) From: Brandon Richardson To: git@vger.kernel.org Cc: rybak.a.v@gmail.com, pclouds@gmail.com, peff@peff.net, Brandon Richardson Subject: [PATCH v2] commit-tree: utilize parse-options api Date: Fri, 1 Mar 2019 13:13:04 -0400 Message-Id: <20190301171304.2267-1-brandon1024.br@gmail.com> X-Mailer: git-send-email 2.21.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Rather than parse options manually, which is both difficult to read and error prone, parse options supplied to commit-tree using the parse-options api. It was discovered that the --no-gpg-sign option was documented but not implemented in commit 70ddbd7767 (commit-tree: add missing --gpg-sign flag, 2019-01-19), and the existing implementation would attempt to translate the option as a tree oid. It was also suggested earlier in commit 55ca3f99ae (commit-tree: add and document --no-gpg-sign, 2013-12-13) that commit-tree should be migrated to utilize the parse-options api, which could help prevent mistakes like this in the future. Hence this change. Signed-off-by: Brandon Richardson --- Notes: GitHub Pull Request: https://github.com/brandon1024/git/pull/2 Travis CI Results: https://travis-ci.com/brandon1024/git/builds/102755598 Documentation/git-commit-tree.txt | 8 +- builtin/commit-tree.c | 159 ++++++++++++++++-------------- parse-options.h | 9 ++ 3 files changed, 102 insertions(+), 74 deletions(-) diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt index 002dae625e..f4e20b62a0 100644 --- a/Documentation/git-commit-tree.txt +++ b/Documentation/git-commit-tree.txt @@ -23,6 +23,9 @@ Creates a new commit object based on the provided tree object and emits the new commit object id on stdout. The log message is read from the standard input, unless `-m` or `-F` options are given. +When mixing `-m` and `-F` options, the commit log message will be +composed in the order in which the options are given. + A commit object may have any number of parents. With exactly one parent, it is an ordinary commit. Having more than one parent makes the commit a merge between several lines of history. Initial (root) @@ -41,7 +44,7 @@ state was. OPTIONS ------- :: - An existing tree object + An existing tree object. -p :: Each `-p` indicates the id of a parent commit object. @@ -52,7 +55,8 @@ OPTIONS -F :: Read the commit log message from the given file. Use `-` to read - from the standard input. + from the standard input. This can be given more than once and the + content of each file becomes its own paragraph. -S[]:: --gpg-sign[=]:: diff --git a/builtin/commit-tree.c b/builtin/commit-tree.c index 12cc403bd7..9a80e83f96 100644 --- a/builtin/commit-tree.c +++ b/builtin/commit-tree.c @@ -12,8 +12,14 @@ #include "builtin.h" #include "utf8.h" #include "gpg-interface.h" +#include "parse-options.h" +#include "string-list.h" -static const char commit_tree_usage[] = "git commit-tree [(-p )...] [-S[]] [-m ] [-F ] "; +static const char * const commit_tree_usage[] = { + N_("git commit-tree [(-p )...] [-S[]] [(-m )...] " + "[(-F )...] "), + NULL +}; static const char *sign_commit; @@ -23,7 +29,7 @@ static void new_parent(struct commit *parent, struct commit_list **parents_p) struct commit_list *parents; for (parents = *parents_p; parents; parents = parents->next) { if (parents->item == parent) { - error("duplicate parent %s ignored", oid_to_hex(oid)); + error(_("duplicate parent %s ignored"), oid_to_hex(oid)); return; } parents_p = &parents->next; @@ -39,91 +45,100 @@ static int commit_tree_config(const char *var, const char *value, void *cb) return git_default_config(var, value, cb); } +static int parse_parent_arg_callback(const struct option *opt, + const char *arg, int unset) +{ + struct object_id oid; + struct commit_list **parents = opt->value; + + BUG_ON_OPT_NEG_NOARG(unset, arg); + + if (get_oid_commit(arg, &oid)) + die(_("not a valid object name %s"), arg); + + assert_oid_type(&oid, OBJ_COMMIT); + new_parent(lookup_commit(the_repository, &oid), parents); + return 0; +} + +static int parse_message_arg_callback(const struct option *opt, + const char *arg, int unset) +{ + struct strbuf *buf = opt->value; + + BUG_ON_OPT_NEG_NOARG(unset, arg); + + if (buf->len) + strbuf_addch(buf, '\n'); + strbuf_addstr(buf, arg); + strbuf_complete_line(buf); + + return 0; +} + +static int parse_file_arg_callback(const struct option *opt, + const char *arg, int unset) +{ + int fd; + struct strbuf *buf = opt->value; + + BUG_ON_OPT_NEG(unset); + + if (buf->len) + strbuf_addch(buf, '\n'); + if (!strcmp(arg, "-")) + fd = 0; + else { + fd = open(arg, O_RDONLY); + if (fd < 0) + die_errno(_("git commit-tree: failed to open '%s'"), arg); + } + if (strbuf_read(buf, fd, 0) < 0) + die_errno(_("git commit-tree: failed to read '%s'"), arg); + if (fd && close(fd)) + die_errno(_("git commit-tree: failed to close '%s'"), arg); + + return 0; +} + int cmd_commit_tree(int argc, const char **argv, const char *prefix) { - int i, got_tree = 0; + static struct strbuf buffer = STRBUF_INIT; struct commit_list *parents = NULL; struct object_id tree_oid; struct object_id commit_oid; - struct strbuf buffer = STRBUF_INIT; + + struct option options[] = { + { OPTION_CALLBACK, 'p', NULL, &parents, N_("parent"), + N_("id of a parent commit object"), PARSE_OPT_NONEG, + parse_parent_arg_callback }, + { OPTION_CALLBACK, 'm', NULL, &buffer, N_("message"), + N_("commit message"), PARSE_OPT_NONEG, + parse_message_arg_callback }, + { OPTION_CALLBACK, 'F', NULL, &buffer, N_("file"), + N_("read commit log message from file"), PARSE_OPT_NONEG, + parse_file_arg_callback }, + { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"), + N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" }, + OPT_END() + }; git_config(commit_tree_config, NULL); if (argc < 2 || !strcmp(argv[1], "-h")) - usage(commit_tree_usage); - - for (i = 1; i < argc; i++) { - const char *arg = argv[i]; - if (!strcmp(arg, "-p")) { - struct object_id oid; - if (argc <= ++i) - usage(commit_tree_usage); - if (get_oid_commit(argv[i], &oid)) - die("Not a valid object name %s", argv[i]); - assert_oid_type(&oid, OBJ_COMMIT); - new_parent(lookup_commit(the_repository, &oid), - &parents); - continue; - } + usage_with_options(commit_tree_usage, options); - if (!strcmp(arg, "--gpg-sign")) { - sign_commit = ""; - continue; - } + argc = parse_options(argc, argv, prefix, options, commit_tree_usage, 0); - if (skip_prefix(arg, "-S", &sign_commit) || - skip_prefix(arg, "--gpg-sign=", &sign_commit)) - continue; + if (argc != 1) + die(_("must give exactly one tree")); - if (!strcmp(arg, "--no-gpg-sign")) { - sign_commit = NULL; - continue; - } - - if (!strcmp(arg, "-m")) { - if (argc <= ++i) - usage(commit_tree_usage); - if (buffer.len) - strbuf_addch(&buffer, '\n'); - strbuf_addstr(&buffer, argv[i]); - strbuf_complete_line(&buffer); - continue; - } - - if (!strcmp(arg, "-F")) { - int fd; - - if (argc <= ++i) - usage(commit_tree_usage); - if (buffer.len) - strbuf_addch(&buffer, '\n'); - if (!strcmp(argv[i], "-")) - fd = 0; - else { - fd = open(argv[i], O_RDONLY); - if (fd < 0) - die_errno("git commit-tree: failed to open '%s'", - argv[i]); - } - if (strbuf_read(&buffer, fd, 0) < 0) - die_errno("git commit-tree: failed to read '%s'", - argv[i]); - if (fd && close(fd)) - die_errno("git commit-tree: failed to close '%s'", - argv[i]); - continue; - } - - if (get_oid_tree(arg, &tree_oid)) - die("Not a valid object name %s", arg); - if (got_tree) - die("Cannot give more than one trees"); - got_tree = 1; - } + if (get_oid_tree(argv[0], &tree_oid)) + die(_("not a valid object name %s"), argv[0]); if (!buffer.len) { if (strbuf_read(&buffer, 0, 0) < 0) - die_errno("git commit-tree: failed to read"); + die_errno(_("git commit-tree: failed to read")); } if (commit_tree(buffer.buf, buffer.len, &tree_oid, parents, &commit_oid, diff --git a/parse-options.h b/parse-options.h index 14fe32428e..a6ab338be3 100644 --- a/parse-options.h +++ b/parse-options.h @@ -202,6 +202,15 @@ const char *optname(const struct option *opt, int flags); BUG("option callback does not expect an argument"); \ } while (0) +/* + * Use this assertion for callbacks that expect to be called with NONEG, + * and require an argument be supplied. + */ +#define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \ + if((!unset) && (!arg)) \ + BUG("option callback does not expect negation and requires an argument"); \ +} while(0) + /*----- incremental advanced APIs -----*/ enum { -- 2.21.0