diff --git a/Documentation/git-commit.adoc b/Documentation/git-commit.adoc index 54c207ad45eaa2..ed4c54ae819029 100644 --- a/Documentation/git-commit.adoc +++ b/Documentation/git-commit.adoc @@ -12,7 +12,7 @@ git commit [-a | --interactive | --patch] [-s] [-v] [-u[]] [--amend] [--dry-run] [(-c | -C | --squash) | --fixup [(amend|reword):]] [-F | -m ] [--reset-author] [--allow-empty] [--allow-empty-message] [--no-verify] [-e] [--author=] - [--date=] [--cleanup=] [--[no-]status] + [--committer=] [--date=] [--cleanup=] [--[no-]status] [-i | -o] [--pathspec-from-file= [--pathspec-file-nul]] [(--trailer [(=|:)])...] [-S[]] [--] [...] @@ -178,6 +178,13 @@ See linkgit:git-rebase[1] for details. commit by that author (i.e. `git rev-list --all -i --author=`); the commit author is then copied from the first such commit found. +`--committer=`:: + Override the committer for the commit. Specify an explicit committer using the + standard `C O Mitter ` format. Otherwise __ + is assumed to be a pattern and is used to search for an existing + commit by that committer (i.e. `git rev-list --all -i --committer=`); + the commit committer is then copied from the first such commit found. + `--date=`:: Override the author date used in the commit. diff --git a/builtin/commit.c b/builtin/commit.c index 0243f17d53c97c..3b249dd878a55f 100644 --- a/builtin/commit.c +++ b/builtin/commit.c @@ -49,7 +49,7 @@ static const char * const builtin_commit_usage[] = { " [--dry-run] [(-c | -C | --squash) | --fixup [(amend|reword):]]\n" " [-F | -m ] [--reset-author] [--allow-empty]\n" " [--allow-empty-message] [--no-verify] [-e] [--author=]\n" - " [--date=] [--cleanup=] [--[no-]status]\n" + " [--committer=] [--date=] [--cleanup=] [--[no-]status]\n" " [-i | -o] [--pathspec-from-file= [--pathspec-file-nul]]\n" " [(--trailer [(=|:)])...] [-S[]]\n" " [--] [...]"), @@ -112,6 +112,7 @@ static enum { } commit_style; static const char *force_author; +static const char *force_committer; static char *logfile; static char *template_file; /* @@ -630,46 +631,61 @@ static void set_ident_var(char **buf, char *val) *buf = val; } -static void determine_author_info(struct strbuf *author_ident) +static void determine_identity(struct strbuf *ident_str, int is_author) { char *name, *email, *date; - struct ident_split author; - - name = xstrdup_or_null(getenv("GIT_AUTHOR_NAME")); - email = xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL")); - date = xstrdup_or_null(getenv("GIT_AUTHOR_DATE")); - - if (author_message) { - struct ident_split ident; + struct ident_split ident; + const char *env_name = is_author ? "GIT_AUTHOR_NAME" : "GIT_COMMITTER_NAME"; + const char *env_email = is_author ? "GIT_AUTHOR_EMAIL" : "GIT_COMMITTER_EMAIL"; + const char *env_date = is_author ? "GIT_AUTHOR_DATE" : "GIT_COMMITTER_DATE"; + const char *force_ident = is_author ? force_author : force_committer; + const char *param_name = is_author ? "--author" : "--committer"; + int ident_flag = is_author ? WANT_AUTHOR_IDENT : WANT_COMMITTER_IDENT; + + name = xstrdup_or_null(getenv(env_name)); + email = xstrdup_or_null(getenv(env_email)); + date = xstrdup_or_null(getenv(env_date)); + + if (is_author && author_message) { + struct ident_split msg_ident; size_t len; const char *a; a = find_commit_header(author_message_buffer, "author", &len); if (!a) die(_("commit '%s' lacks author header"), author_message); - if (split_ident_line(&ident, a, len) < 0) + if (split_ident_line(&msg_ident, a, len) < 0) die(_("commit '%s' has malformed author line"), author_message); - set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin)); - set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin)); + set_ident_var(&name, xmemdupz(msg_ident.name_begin, msg_ident.name_end - msg_ident.name_begin)); + set_ident_var(&email, xmemdupz(msg_ident.mail_begin, msg_ident.mail_end - msg_ident.mail_begin)); - if (ident.date_begin) { + if (msg_ident.date_begin) { struct strbuf date_buf = STRBUF_INIT; strbuf_addch(&date_buf, '@'); - strbuf_add(&date_buf, ident.date_begin, ident.date_end - ident.date_begin); + strbuf_add(&date_buf, msg_ident.date_begin, msg_ident.date_end - msg_ident.date_begin); strbuf_addch(&date_buf, ' '); - strbuf_add(&date_buf, ident.tz_begin, ident.tz_end - ident.tz_begin); + strbuf_add(&date_buf, msg_ident.tz_begin, msg_ident.tz_end - msg_ident.tz_begin); set_ident_var(&date, strbuf_detach(&date_buf, NULL)); } } - if (force_author) { - struct ident_split ident; + if (force_ident) { + struct ident_split force_ident_split; + + if (split_ident_line(&force_ident_split, force_ident, strlen(force_ident)) < 0) + die(_("malformed %s parameter"), param_name); + set_ident_var(&name, xmemdupz(force_ident_split.name_begin, force_ident_split.name_end - force_ident_split.name_begin)); + set_ident_var(&email, xmemdupz(force_ident_split.mail_begin, force_ident_split.mail_end - force_ident_split.mail_begin)); - if (split_ident_line(&ident, force_author, strlen(force_author)) < 0) - die(_("malformed --author parameter")); - set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin)); - set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin)); + if (!is_author && force_ident_split.date_begin) { + struct strbuf date_buf = STRBUF_INIT; + strbuf_addch(&date_buf, '@'); + strbuf_add(&date_buf, force_ident_split.date_begin, force_ident_split.date_end - force_ident_split.date_begin); + strbuf_addch(&date_buf, ' '); + strbuf_add(&date_buf, force_ident_split.tz_begin, force_ident_split.tz_end - force_ident_split.tz_begin); + set_ident_var(&date, strbuf_detach(&date_buf, NULL)); + } } if (force_date) { @@ -679,17 +695,35 @@ static void determine_author_info(struct strbuf *author_ident) set_ident_var(&date, strbuf_detach(&date_buf, NULL)); } - strbuf_addstr(author_ident, fmt_ident(name, email, WANT_AUTHOR_IDENT, date, + strbuf_addstr(ident_str, fmt_ident(name, email, ident_flag, date, IDENT_STRICT)); - assert_split_ident(&author, author_ident); - export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0); - export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0); - export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@'); + assert_split_ident(&ident, ident_str); + + if (is_author) { + export_one("GIT_AUTHOR_NAME", ident.name_begin, ident.name_end, 0); + export_one("GIT_AUTHOR_EMAIL", ident.mail_begin, ident.mail_end, 0); + export_one("GIT_AUTHOR_DATE", ident.date_begin, ident.tz_end, '@'); + } else { + export_one("GIT_COMMITTER_NAME", ident.name_begin, ident.name_end, 0); + export_one("GIT_COMMITTER_EMAIL", ident.mail_begin, ident.mail_end, 0); + export_one("GIT_COMMITTER_DATE", ident.date_begin, ident.tz_end, '@'); + } + free(name); free(email); free(date); } +static void determine_author_info(struct strbuf *author_ident) +{ + determine_identity(author_ident, 1); +} + +static void determine_committer_info(struct strbuf *committer_ident) +{ + determine_identity(committer_ident, 0); +} + static int author_date_is_interesting(void) { return author_message || force_date; @@ -1137,16 +1171,18 @@ static int prepare_to_commit(const char *index_file, const char *prefix, return 1; } -static const char *find_author_by_nickname(const char *name) +static const char *find_identity_by_nickname(const char *name, int is_author) { struct rev_info revs; struct commit *commit; struct strbuf buf = STRBUF_INIT; const char *av[20]; int ac = 0; + const char *field = is_author ? "author" : "committer"; + const char *format = is_author ? "%aN <%aE>" : "%cN <%cE>"; repo_init_revisions(the_repository, &revs, NULL); - strbuf_addf(&buf, "--author=%s", name); + strbuf_addf(&buf, "--%s=%s", field, name); av[++ac] = "--all"; av[++ac] = "-i"; av[++ac] = buf.buf; @@ -1164,11 +1200,22 @@ static const char *find_author_by_nickname(const char *name) ctx.date_mode.type = DATE_NORMAL; strbuf_release(&buf); repo_format_commit_message(the_repository, commit, - "%aN <%aE>", &buf, &ctx); + format, &buf, &ctx); release_revisions(&revs); return strbuf_detach(&buf, NULL); } - die(_("--author '%s' is not 'Name ' and matches no existing author"), name); + die(_("--%s '%s' is not 'Name ' and matches no existing %s"), + field, name, field); +} + +static const char *find_author_by_nickname(const char *name) +{ + return find_identity_by_nickname(name, 1); +} + +static const char *find_committer_by_nickname(const char *name) +{ + return find_identity_by_nickname(name, 0); } static void handle_ignored_arg(struct wt_status *s) @@ -1321,6 +1368,9 @@ static int parse_and_validate_options(int argc, const char *argv[], if (force_author && renew_authorship) die(_("options '%s' and '%s' cannot be used together"), "--reset-author", "--author"); + if (force_committer && !strchr(force_committer, '>')) + force_committer = find_committer_by_nickname(force_committer); + if (logfile || have_option_m || use_message) use_editor = 0; @@ -1709,6 +1759,7 @@ int cmd_commit(int argc, OPT_FILENAME('F', "file", &logfile, N_("read message from file")), OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")), OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")), + OPT_STRING(0, "committer", &force_committer, N_("committer"), N_("override committer for commit")), OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m), OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")), OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")), @@ -1785,6 +1836,7 @@ int cmd_commit(int argc, struct strbuf sb = STRBUF_INIT; struct strbuf author_ident = STRBUF_INIT; + struct strbuf committer_ident = STRBUF_INIT; const char *index_file, *reflog_msg; struct object_id oid; struct commit_list *parents = NULL; @@ -1930,8 +1982,12 @@ int cmd_commit(int argc, append_merge_tag_headers(parents, &tail); } + if (force_committer) + determine_committer_info(&committer_ident); + if (commit_tree_extended(sb.buf, sb.len, &the_repository->index->cache_tree->oid, - parents, &oid, author_ident.buf, NULL, + parents, &oid, author_ident.buf, + force_committer ? committer_ident.buf : NULL, sign_commit, extra)) { rollback_index_files(); die(_("failed to write commit object")); @@ -1980,6 +2036,7 @@ int cmd_commit(int argc, free_commit_extra_headers(extra); free_commit_list(parents); strbuf_release(&author_ident); + strbuf_release(&committer_ident); strbuf_release(&err); strbuf_release(&sb); free(logfile); diff --git a/t/t7509-commit-authorship.sh b/t/t7509-commit-authorship.sh index 8e373b566b091d..7e163e02d1081d 100755 --- a/t/t7509-commit-authorship.sh +++ b/t/t7509-commit-authorship.sh @@ -12,13 +12,20 @@ author_header () { sed -n -e '/^$/q' -e '/^author /p' } +committer_header () { + git cat-file commit "$1" | + sed -n -e '/^$/q' -e '/^committer /p' +} + message_body () { git cat-file commit "$1" | sed -e '1,/^$/d' } test_expect_success '-C option copies authorship and message' ' - test_commit --author Frigate\ \ \ + test_env GIT_COMMITTER_NAME="Frigate" \ + GIT_COMMITTER_EMAIL="flying@over.world" \ + test_commit --author Frigate\ \ \ "Initial Commit" foo Initial Initial && echo "Test 1" >>foo && test_tick && @@ -171,4 +178,79 @@ test_expect_success '--reset-author with CHERRY_PICK_HEAD' ' test_cmp expect actual ' +test_expect_success '--committer option overrides committer' ' + git checkout Initial && + echo "Test --committer" >>foo && + test_tick && + git commit -a -m "test committer" --committer="Custom Committer " && + committer_header HEAD >actual && + grep "Custom Committer " actual +' + +test_expect_success '--committer with pattern search' ' + echo "Test committer pattern" >>foo && + test_tick && + git commit -a -m "test committer pattern" --committer="Frigate" && + committer_header HEAD >actual && + grep "Frigate " actual +' + +test_expect_success '--committer malformed parameter' ' + echo "Test malformed" >>foo && + test_tick && + test_must_fail git commit -a -m "test malformed" --committer="malformed committer" +' + +test_expect_success '--committer with --amend option' ' + git checkout -f Initial && + echo "Test committer with amend" >>foo && + test_tick && + git commit -a -m "initial commit for amend test" && + echo "Modified for amend" >>foo && + test_tick && + git commit -a --amend --no-edit \ + --author="Test Author " \ + --committer="Test Committer " && + author_header HEAD >actual_author && + grep "Test Author " actual_author && + committer_header HEAD >actual_committer && + grep "Test Committer " actual_committer +' + +test_expect_success 'GIT_COMMITTER_* environment variables' ' + git checkout -f Initial && + echo "Test env vars" >>foo && + test_tick && + test_env GIT_COMMITTER_NAME="Env Committer" \ + GIT_COMMITTER_EMAIL="env@test.example" \ + git commit -a -m "test committer env vars" && + committer_header HEAD >actual && + grep "Env Committer " actual +' + +test_expect_success '--committer overrides GIT_COMMITTER_* environment variables' ' + echo "Test override" >>foo && + test_tick && + test_env GIT_COMMITTER_NAME="Env Committer" \ + GIT_COMMITTER_EMAIL="env@test.example" \ + git commit -a -m "test override" \ + --committer="Override Committer " && + committer_header HEAD >actual && + grep "Override Committer " actual +' + +test_expect_success '--date with --committer changes both author and committer dates' ' + git checkout -f Initial && + echo "Test date override" >>foo && + test_tick && + git commit -a -m "test date" \ + --author="Date Author " \ + --committer="Date Committer " \ + --date="2024-06-15 10:30:00 +0800" && + git log -1 --format="%ai" >author_date && + git log -1 --format="%ci" >committer_date && + grep "2024-06-15 10:30:00 +0800" author_date && + grep "2024-06-15 10:30:00 +0800" committer_date +' + test_done