[PATCH] custom log formats for "diff --submodule=log"

Jeff King· Nov 8, 2012, 20:29 UTC · lore

An off-list discussion made me wonder if something like this would be useful:

  git log -p --submodule=log:'  %m %an <%ae>: %s'

where the format could be whatever you find useful.

I do not use submodules myself, so writing the patch below was just a fun exercise. I'm not planning on polishing it for inclusion. But I thought I would publish it here in case anybody who is more interested feels like picking it up. It would need documentation and tests at the very least.

---

Show changes to 4 files +20 −7

diff.c, diff.h, submodule.c, submodule.h

diff --git a/diff.c b/diff.c
index 86e5f2a..f2adaca 100644
--- a/diff.c
+++ b/diff.c
@@ -2241,7 +2241,7 @@ static void builtin_diff(const char *name_a,
 		const char *add = diff_get_color_opt(o, DIFF_FILE_NEW);
 		show_submodule_summary(o->file, one ? one->path : two->path,
 				one->sha1, two->sha1, two->dirty_submodule,
-				del, add, reset);
+				del, add, reset, o->submodule_log_format);
 		return;
 	}
 
@@ -3654,8 +3654,13 @@ int diff_opt_parse(struct diff_options *options, const char **av, int ac)
 	} else if (!strcmp(arg, "--submodule"))
 		DIFF_OPT_SET(options, SUBMODULE_LOG);
 	else if (!prefixcmp(arg, "--submodule=")) {
-		if (!strcmp(arg + 12, "log"))
+		const char *v = arg + 12;
+		if (!strcmp(v, "log"))
 			DIFF_OPT_SET(options, SUBMODULE_LOG);
+		else if (!prefixcmp(v, "log:")) {
+			DIFF_OPT_SET(options, SUBMODULE_LOG);
+			options->submodule_log_format = xstrdup(v + 4);
+		}
 	}
 
 	/* misc options */
diff --git a/diff.h b/diff.h
index a658f85..9726375 100644
--- a/diff.h
+++ b/diff.h
@@ -132,6 +132,8 @@ struct diff_options {
 	const char *stat_sep;
 	long xdl_opts;
 
+	char *submodule_log_format;
+
 	int stat_width;
 	int stat_name_width;
 	int stat_graph_width;
diff --git a/submodule.c b/submodule.c
index e3e0b45..149bd87 100644
--- a/submodule.c
+++ b/submodule.c
@@ -217,12 +217,16 @@ static int prepare_submodule_summary(struct rev_info *rev, const char *path,
 }
 
 static void print_submodule_summary(struct rev_info *rev, FILE *f,
-		const char *del, const char *add, const char *reset)
+		const char *del, const char *add, const char *reset,
+		const char *format)
 {
-	static const char format[] = "  %m %s";
+	static const char default_format[] = "  %m %s";
 	struct strbuf sb = STRBUF_INIT;
 	struct commit *commit;
 
+	if (!format)
+		format = default_format;
+
 	while ((commit = get_revision(rev))) {
 		struct pretty_print_context ctx = {0};
 		ctx.date_mode = rev->date_mode;
@@ -259,7 +263,8 @@ int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg)
 void show_submodule_summary(FILE *f, const char *path,
 		unsigned char one[20], unsigned char two[20],
 		unsigned dirty_submodule,
-		const char *del, const char *add, const char *reset)
+		const char *del, const char *add, const char *reset,
+		const char *format)
 {
 	struct rev_info rev;
 	struct commit *left = left, *right = right;
@@ -304,7 +309,7 @@ void show_submodule_summary(FILE *f, const char *path,
 	fwrite(sb.buf, sb.len, 1, f);
 
 	if (!message) {
-		print_submodule_summary(&rev, f, del, add, reset);
+		print_submodule_summary(&rev, f, del, add, reset, format);
 		clear_commit_marks(left, ~0);
 		clear_commit_marks(right, ~0);
 	}
diff --git a/submodule.h b/submodule.h
index f2e8271..49a7b75 100644
--- a/submodule.h
+++ b/submodule.h
@@ -21,7 +21,8 @@ int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg);
 void show_submodule_summary(FILE *f, const char *path,
 		unsigned char one[20], unsigned char two[20],
 		unsigned dirty_submodule,
-		const char *del, const char *add, const char *reset);
+		const char *del, const char *add, const char *reset,
+		const char *format);
 void set_config_fetch_recurse_submodules(int value);
 void check_for_new_submodule_commits(unsigned char new_sha1[20]);
 int fetch_populated_submodules(const struct argv_array *options,

Ramkumar Ramachandra· Nov 11, 2012, 11:26 UTC · re: Jeff King · lore

Re: [PATCH] custom log formats for "diff --submodule=log"

Hi Peff,

Jeff King wrote:

Show 6 quoted lines

> An off-list discussion made me wonder if something like this would be
> useful:
>
>   git log -p --submodule=log:'  %m %an <%ae>: %s'
>
> where the format could be whatever you find useful.

Interesting. Don't you mean `git diff` in place of `git log -p` though? I don't think `git log --submodule` does anything differently from `git log`. Should this respect format.pretty? Does it?

Ram

Ramkumar Ramachandra· Nov 11, 2012, 13:05 UTC · re: Ramkumar Ramachandra · lore

Re: [PATCH] custom log formats for "diff --submodule=log"

Hi again,

Ramkumar Ramachandra wrote:

> Don't you mean `git diff` in place of `git log -p`
> though?  I don't think `git log --submodule` does anything differently
> from `git log`.

Sorry for the nonsense. I just realized that it affects the diffs shown by `git log -p`.

Ram

Jeff King· Nov 12, 2012, 22:19 UTC · re: Ramkumar Ramachandra · lore

Re: [PATCH] custom log formats for "diff --submodule=log"

On Sun, Nov 11, 2012 at 06:35:16PM +0530, Ramkumar Ramachandra wrote:

Show 7 quoted lines

> Ramkumar Ramachandra wrote:
> > Don't you mean `git diff` in place of `git log -p`
> > though?  I don't think `git log --submodule` does anything differently
> > from `git log`.
> 
> Sorry for the nonsense.  I just realized that it affects the diffs
> shown by `git log -p`.

Right. I don't know if that is a common workflow (I do not really use submodules), but it was the first thing I tried when I heard about --submodule (and it does make sense to me that it would work).

But the logic could apply equally well to:

  git diff --submodule=log:%an

-Peff

patchcustom log formats for "diff --submodule=log"