From patchwork Tue Mar 5 15:49:51 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Brandon Richardson X-Patchwork-Id: 10839615 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 2C9031390 for ; Tue, 5 Mar 2019 15:50:15 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 1723E2C76D for ; Tue, 5 Mar 2019 15:50:15 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 156E52C7BC; Tue, 5 Mar 2019 15:50:15 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 3DC9A2C7CA for ; Tue, 5 Mar 2019 15:50:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728424AbfCEPuM (ORCPT ); Tue, 5 Mar 2019 10:50:12 -0500 Received: from mail-it1-f193.google.com ([209.85.166.193]:35280 "EHLO mail-it1-f193.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727424AbfCEPuM (ORCPT ); Tue, 5 Mar 2019 10:50:12 -0500 Received: by mail-it1-f193.google.com with SMTP id 188so5219302itb.0 for ; Tue, 05 Mar 2019 07:50:11 -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=l86Yr46F9DHwhjeN51QqB19JWvThPedOmce0et6S/WA=; b=BVtIUnk+t3cQDqtjIktY/V43Co6bNYL7ZcXxEkIZfX39aGMRo78oBD5ubfA3dyDcV1 +5HN1O654QQs7twRPS3CL52hg4BhvMYcyADobtvtkhjmvH4syo60xyjxcFrxAkllplLY 34HBfeAXMbzYss8rE9UvLuQ4J3aG5tqYLafpavtC30wMCTQKtV+3WrR7zCB9hZcmPbU2 SxPCepr6Gpkt3wxb4mVUPtlNpE7s+GYihIXKMO3Orqf+JXDSLs0SdZZ+m2AwCmKMkqSC qB9uxf7Dsk7KxW7MDGlQdQUlMJFBDnYkMspIk9Gaz2xyVZAbIedNJ/Q9Ib5uhwdqBMRM iXtA== 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=l86Yr46F9DHwhjeN51QqB19JWvThPedOmce0et6S/WA=; b=DY8WVzLSOp3p0Y4a9RfecFPfv78KZXuJwpNUOy5s5P5ZI7NWuDJ4Adt4xLPR78+81j fexSsYpjmPbcUxAuph6mxj8hSLySyMEsuQ9Qi7rzaMczIdxKNTVVlYBrrBSPV3+qRFA8 I8Rb8H/FSHxebb3ZF7EiQoOrMVQM8v8AFAVAKE3P9wFO35ZXTmWn8TvrOn08oiD4AAwc iJ8Ks6fIJ3ZKx7uTi58lkw7HySdaaKQ36DLY1g9TInD8lTiPyY9DXbpJRgTkLiOMPNd5 5wSCi3ATYEm6BYdUqU+71Z6ndcWE+8Q+MmVEmc2FJbwhp1kOCah3+K1T4/88WKlrKeFr cwig== X-Gm-Message-State: APjAAAVARqfd0CuUXDAtgPMmaD29oVOprxVuKrBzJUuKdTwxXO9MYpoH jZ/IES5JgfSMhs1SSDF1Uvsy6qe85u8YnQ== X-Google-Smtp-Source: APXvYqxkgrSXiW4DtXP9gwF1B/NDkef/cEqitG6R0pWqOt51MX2WGabhc+4DbUCfzTxEzU3Ccy5LmA== X-Received: by 2002:a02:cd8f:: with SMTP id l15mr1280841jap.4.1551801010767; Tue, 05 Mar 2019 07:50:10 -0800 (PST) Received: from localhost.localdomain ([104.254.95.198]) by smtp.gmail.com with ESMTPSA id s19sm3701694ioj.65.2019.03.05.07.50.08 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 05 Mar 2019 07:50:09 -0800 (PST) From: Brandon Richardson To: git@vger.kernel.org Cc: rybak.a.v@gmail.com, pclouds@gmail.com, peff@peff.net, sunshine@sunshineco.com, Brandon Richardson Subject: [PATCH v4] commit-tree: utilize parse-options api Date: Tue, 5 Mar 2019 10:49:51 -0500 Message-Id: <20190305154951.4407-1-brandon1024.br@gmail.com> X-Mailer: git-send-email 2.21.0 MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP 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. Also update the documentation to better describe that mixing `-m` and `-F` options will correctly compose commit log messages in the order in which the options are given. In the process, mark various strings for translation. Signed-off-by: Brandon Richardson --- Notes: GitHub Pull Request: https://github.com/brandon1024/git/pull/4 Travis CI Build: https://travis-ci.com/brandon1024/git/builds/103055317 Documentation/git-commit-tree.txt | 8 +- builtin/commit-tree.c | 158 ++++++++++++++++-------------- parse-options.h | 11 +++ 3 files changed, 103 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..b866d83951 100644 --- a/builtin/commit-tree.c +++ b/builtin/commit-tree.c @@ -12,8 +12,13 @@ #include "builtin.h" #include "utf8.h" #include "gpg-interface.h" +#include "parse-options.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 +28,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 +44,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_NOARG(unset, arg); + + 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..3a442eee26 100644 --- a/parse-options.h +++ b/parse-options.h @@ -202,6 +202,17 @@ const char *optname(const struct option *opt, int flags); BUG("option callback does not expect an argument"); \ } while (0) +/* + * Similar to the assertions above, but checks that "arg" is always non-NULL. + * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both + * assertions in a single line. + */ +#define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \ + BUG_ON_OPT_NEG(unset); \ + if(!(arg)) \ + BUG("option callback expects an argument"); \ +} while(0) + /*----- incremental advanced APIs -----*/ enum {