mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

commit-tree: utilize parse-options api

Browse Source 
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 <brandon1024.br@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Brandon Richardson
2019-03-07 11:44:09 -04:00
committed by Junio C Hamano
parent 8104ec994e
commit cbdeab98e8
3 changed files with 104 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

158
builtin/commit-tree.c
View File

@ -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 <sha1>)...] [-S[<keyid>]] [-m <message>] [-F <file>] <sha1>";
static const char * const commit_tree_usage[] = {
N_("git commit-tree [(-p <parent>)...] [-S[<keyid>]] [(-m <message>)...] "
"[(-F <file>)...] <tree>"),
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);
usage_with_options(commit_tree_usage, options);
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;
}
argc = parse_options(argc, argv, prefix, options, commit_tree_usage, 0);
if (!strcmp(arg, "--gpg-sign")) {
sign_commit = "";
continue;
}
if (argc != 1)
die(_("must give exactly one tree"));
if (skip_prefix(arg, "-S", &sign_commit) ||
skip_prefix(arg, "--gpg-sign=", &sign_commit))
continue;
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,