From: Jeff King <peff@peff.net>
To: git@vger.kernel.org
Cc: "Eric Sunshine" <sunshine@sunshineco.com>,
"Martin Ågren" <martin.agren@gmail.com>
Subject: [PATCH v2 4/8] shortlog: match commit trailers with --group
Date: Sun, 27 Sep 2020 04:40:04 -0400 [thread overview]
Message-ID: <20200927084004.GD2465761@coredump.intra.peff.net> (raw)
In-Reply-To: <20200927083933.GA2222823@coredump.intra.peff.net>
If a project uses commit trailers, this patch lets you use
shortlog to see who is performing each action. For example,
running:
git shortlog -ns --group=trailer:reviewed-by
in git.git shows who has reviewed. You can even use a custom
format to see things like who has helped whom:
git shortlog --format="...helped %an (%ad)" \
--group=trailer:helped-by
Signed-off-by: Jeff King <peff@peff.net>
---
Documentation/git-shortlog.txt | 13 ++++++++++
builtin/shortlog.c | 44 +++++++++++++++++++++++++++++++++-
shortlog.h | 2 ++
t/t4201-shortlog.sh | 14 +++++++++++
4 files changed, 72 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index 6496d313c1..edd6cda58a 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -53,6 +53,19 @@ OPTIONS
+
- `author`, commits are grouped by author
- `committer`, commits are grouped by committer (the same as `-c`)
+ - `trailer:<field>`, the `<field>` is interpreted as a case-insensitive
+ commit message trailer (see linkgit:git-interpret-trailers[1]). For
+ example, if your project uses `Reviewed-by` trailers, you might want
+ to see who has been reviewing with
+ `git shortlog -ns --group=trailer:reviewed-by`.
++
+Note that commits that do not include the trailer will not be counted.
+Likewise, commits with multiple trailers (e.g., multiple signoffs) may
+be counted more than once.
++
+The contents of each trailer value are taken literally and completely.
+No mailmap is applied, and the `-e` option has no effect (if the trailer
+contains a username and email, they are both always shown).
-c::
--committer::
diff --git a/builtin/shortlog.c b/builtin/shortlog.c
index 880ce19304..e1d9ee909f 100644
--- a/builtin/shortlog.c
+++ b/builtin/shortlog.c
@@ -9,6 +9,7 @@
#include "mailmap.h"
#include "shortlog.h"
#include "parse-options.h"
+#include "trailer.h"
static char const * const shortlog_usage[] = {
N_("git shortlog [<options>] [<revision-range>] [[--] <path>...]"),
@@ -136,6 +137,8 @@ static void read_from_stdin(struct shortlog *log)
case SHORTLOG_GROUP_COMMITTER:
match = committer_match;
break;
+ case SHORTLOG_GROUP_TRAILER:
+ die(_("using --group=trailer with stdin is not supported"));
default:
BUG("unhandled shortlog group");
}
@@ -163,6 +166,37 @@ static void read_from_stdin(struct shortlog *log)
strbuf_release(&oneline);
}
+static void insert_records_from_trailers(struct shortlog *log,
+ struct commit *commit,
+ struct pretty_print_context *ctx,
+ const char *oneline)
+{
+ struct trailer_iterator iter;
+ const char *commit_buffer, *body;
+
+ /*
+ * Using format_commit_message("%B") would be simpler here, but
+ * this saves us copying the message.
+ */
+ commit_buffer = logmsg_reencode(commit, NULL, ctx->output_encoding);
+ body = strstr(commit_buffer, "\n\n");
+ if (!body)
+ return;
+
+ trailer_iterator_init(&iter, body);
+ while (trailer_iterator_advance(&iter)) {
+ const char *value = iter.val.buf;
+
+ if (strcasecmp(iter.key.buf, log->trailer))
+ continue;
+
+ insert_one_record(log, value, oneline);
+ }
+ trailer_iterator_release(&iter);
+
+ unuse_commit_buffer(commit, commit_buffer);
+}
+
void shortlog_add_commit(struct shortlog *log, struct commit *commit)
{
struct strbuf ident = STRBUF_INIT;
@@ -197,6 +231,9 @@ void shortlog_add_commit(struct shortlog *log, struct commit *commit)
&ident, &ctx);
insert_one_record(log, ident.buf, oneline_str);
break;
+ case SHORTLOG_GROUP_TRAILER:
+ insert_records_from_trailers(log, commit, &ctx, oneline_str);
+ break;
}
strbuf_release(&ident);
@@ -263,12 +300,17 @@ static int parse_wrap_args(const struct option *opt, const char *arg, int unset)
static int parse_group_option(const struct option *opt, const char *arg, int unset)
{
struct shortlog *log = opt->value;
+ const char *field;
if (unset || !strcasecmp(arg, "author"))
log->group = SHORTLOG_GROUP_AUTHOR;
else if (!strcasecmp(arg, "committer"))
log->group = SHORTLOG_GROUP_COMMITTER;
- else
+ else if (skip_prefix(arg, "trailer:", &field)) {
+ log->group = SHORTLOG_GROUP_TRAILER;
+ free(log->trailer);
+ log->trailer = xstrdup(field);
+ } else
return error(_("unknown group type: %s"), arg);
return 0;
diff --git a/shortlog.h b/shortlog.h
index 876a52158d..89c2dbc5e6 100644
--- a/shortlog.h
+++ b/shortlog.h
@@ -19,7 +19,9 @@ struct shortlog {
enum {
SHORTLOG_GROUP_AUTHOR = 0,
SHORTLOG_GROUP_COMMITTER,
+ SHORTLOG_GROUP_TRAILER,
} group;
+ char *trailer;
char *common_repo_prefix;
int email;
diff --git a/t/t4201-shortlog.sh b/t/t4201-shortlog.sh
index 65e4468746..e97d891a71 100755
--- a/t/t4201-shortlog.sh
+++ b/t/t4201-shortlog.sh
@@ -220,4 +220,18 @@ test_expect_success '--group=committer is the same as --committer' '
test_cmp expect actual
'
+test_expect_success 'shortlog --group=trailer:signed-off-by' '
+ git commit --allow-empty -m foo -s &&
+ GIT_COMMITTER_NAME="SOB One" \
+ GIT_COMMITTER_EMAIL=sob@example.com \
+ git commit --allow-empty -m foo -s &&
+ git commit --allow-empty --amend --no-edit -s &&
+ cat >expect <<-\EOF &&
+ 2 C O Mitter <committer@example.com>
+ 1 SOB One <sob@example.com>
+ EOF
+ git shortlog -ns --group=trailer:signed-off-by HEAD >actual &&
+ test_cmp expect actual
+'
+
test_done
--
2.28.0.1127.ga65787d918
next prev parent reply other threads:[~2020-09-27 8:40 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-25 7:01 [PATCH 0/8] parsing trailers with shortlog Jeff King
2020-09-25 7:01 ` [PATCH 1/8] shortlog: change "author" variables to "ident" Jeff King
2020-09-25 7:02 ` [PATCH 2/8] shortlog: refactor committer/author grouping Jeff King
2020-09-25 20:05 ` Eric Sunshine
2020-09-27 8:03 ` Jeff King
2020-09-27 8:08 ` Jeff King
2020-09-27 8:23 ` Eric Sunshine
2020-09-26 12:31 ` Martin Ågren
2020-09-27 7:59 ` Jeff King
2020-09-25 7:02 ` [PATCH 3/8] trailer: add interface for iterating over commit trailers Jeff King
2020-09-26 12:39 ` Martin Ågren
2020-09-27 8:20 ` Jeff King
2020-09-25 7:03 ` [PATCH 4/8] shortlog: match commit trailers with --group Jeff King
2020-09-25 7:05 ` [PATCH 5/8] shortlog: de-duplicate trailer values Jeff King
2020-09-25 7:05 ` [PATCH 6/8] shortlog: rename parse_stdin_ident() Jeff King
2020-09-25 7:05 ` [PATCH 7/8] shortlog: parse trailer idents Jeff King
2020-09-25 7:05 ` [PATCH 8/8] shortlog: allow multiple groups to be specified Jeff King
2020-09-25 20:23 ` Eric Sunshine
2020-09-27 8:06 ` Jeff King
2020-09-26 12:48 ` Martin Ågren
2020-09-27 8:25 ` Jeff King
2020-09-25 14:27 ` [PATCH 0/8] parsing trailers with shortlog Derrick Stolee
2020-09-25 16:57 ` Junio C Hamano
2020-09-27 8:39 ` [PATCH v2 " Jeff King
2020-09-27 8:39 ` [PATCH v2 1/8] shortlog: change "author" variables to "ident" Jeff King
2020-09-27 19:18 ` Junio C Hamano
2020-09-27 8:39 ` [PATCH v2 2/8] shortlog: add grouping option Jeff King
2020-09-27 8:40 ` [PATCH v2 3/8] trailer: add interface for iterating over commit trailers Jeff King
2020-09-27 8:40 ` Jeff King [this message]
2020-09-27 19:51 ` [PATCH v2 4/8] shortlog: match commit trailers with --group Junio C Hamano
2020-09-28 3:17 ` Jeff King
2020-09-28 17:01 ` Junio C Hamano
2020-09-27 8:40 ` [PATCH v2 5/8] shortlog: de-duplicate trailer values Jeff King
2020-09-27 20:23 ` Junio C Hamano
2020-09-28 3:19 ` Jeff King
2020-09-27 8:40 ` [PATCH v2 6/8] shortlog: rename parse_stdin_ident() Jeff King
2020-09-27 8:40 ` [PATCH v2 7/8] shortlog: parse trailer idents Jeff King
2020-09-27 20:49 ` Junio C Hamano
2020-09-27 8:40 ` [PATCH v2 8/8] shortlog: allow multiple groups to be specified Jeff King
2020-09-27 21:18 ` Junio C Hamano
2020-09-28 3:25 ` Jeff King
2020-12-28 11:29 ` Junio C Hamano
2021-02-04 6:44 ` Junio C Hamano
2020-09-27 14:38 ` [PATCH v2 0/8] parsing trailers with shortlog Martin Ågren
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200927084004.GD2465761@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=martin.agren@gmail.com \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).