Subject: [PATCH v2] git status: Show detailed dirty status of submodules in long format

From: Jens Lehmann <[email-masked]>
Date: Sun, 07 Mar 2010 21:03:49 +0100

Since 1.7.0 there a three reasons a submodule is considered modified
against the work tree: It contains new commits, modified content or
untracked content. Lets show all reasons in the long format of git status,
so the user can better asses the nature of the modification. This change
does not affect the short and porcelain formats.

Two new members are added to "struct wt_status_change_data" to store the
information gathered by run_diff_files(). wt-status.c uses the new flag
DIFF_OPT_DIRTY_SUBMODULES to tell diff-lib.c it wants to get detailed
dirty information about submodules.

A hint line for submodules is printed in the dirty header when dirty
submodules are present.

Signed-off-by: Jens Lehmann <[email-masked]>
---

Am 07.03.2010 06:41, schrieb Junio C Hamano:
> Jens Lehmann <[email-masked]> writes:
> 
>> # Changed but not updated:
>> #   (use "git add <file>..." to update what will be committed)
>> #   (use "git checkout -- <file>..." to discard changes in working directory)
>> #   (commit or discard the untracked or modified content in submodules)
> 
> Can we do this additional line only when there is a submodule involved in
> the changes?  The whole point of "collect first and then print" is so that
> we can compute things like "has_deleted" before starting to emit any
> output to intelligently give an appropriate advice message, and it feels
> silly to say submodules to users who don't even use any submodule.  I have
> a suspicion that the majority of users may not even know nor care what a
> submodule is.

Good point, the line will only be printed when necessary.

>> I am not so proud of DIFF_FORMAT_DIRTY_SUBMODULES, the new flag i
>> introduced to tell run_diff_files() it should gather the information
>> needed even if we don't want patch output. It isn't a "format" per se,
>> but i couldn't come up with a better way to do this. Opinions?
> 
> It indeed does sound like DIFF_OPT_* than DIFF_FORMAT_*.

Right, using DIFF_OPT_DIRTY_SUBMODULES now.

> In any case, we
> probably would want to have a small helper function that encapsulates this
> part that appear twice:
> 
> 	changed = ce_match_stat(ce, &st, ce_option);
> 	if (S_ISGITLINK(ce->ce_mode)
> 	    && !DIFF_OPT_TST(&revs->diffopt, IGNORE_SUBMODULES)
> 	    && (!changed || (revs->diffopt.output_format & DIFF_FORMAT_PATCH)
> 		|| (revs->diffopt.output_format & DIFF_FORMAT_DIRTY_SUBMODULES))) {
> 		dirty_submodule = is_submodule_modified(ce->name);
> 		if (dirty_submodule)
> 			changed = 1;
> 	}
> 
> to something like
> 
> 	changed = match_stat_with_submodule(&revs->diffopt, ce, &st,
>         					ce_option, &dirty_submodule);
> 
> and the implementation of match_stat_with_submodule() a bit more heavily
> commented so that people will know what it is for.

I was planning a cleanup patch anyway to get rid of the test for
DIFF_FORMAT_PATCH by setting DIFF_OPT_DIRTY_SUBMODULES at the appropriate
call sites and then only test for DIFF_OPT_DIRTY_SUBMODULES here. Putting
the duplicated code into a new function is a good idea, so I'll do that
in the cleanup patch, o.k.?

 diff-lib.c                  |    6 +++-
 diff.h                      |    1 +
 t/t7506-status-submodule.sh |    6 ++--
 wt-status.c                 |   47 ++++++++++++++++++++++++++++++++++++------
 wt-status.h                 |    2 +
 5 files changed, 50 insertions(+), 12 deletions(-)

diff --git a/diff-lib.c b/diff-lib.c
index 15ca7cd..63f8fcc 100644
--- a/diff-lib.c
+++ b/diff-lib.c
@@ -180,7 +180,8 @@ int run_diff_files(struct rev_info *revs, unsigned int option)
 		changed = ce_match_stat(ce, &st, ce_option);
 		if (S_ISGITLINK(ce->ce_mode)
 		    && !DIFF_OPT_TST(&revs->diffopt, IGNORE_SUBMODULES)
-		    && (!changed || (revs->diffopt.output_format & DIFF_FORMAT_PATCH))) {
+		    && (!changed || (revs->diffopt.output_format & DIFF_FORMAT_PATCH)
+		        || DIFF_OPT_TST(&revs->diffopt, DIRTY_SUBMODULES))) {
 			dirty_submodule = is_submodule_modified(ce->name);
 			if (dirty_submodule)
 				changed = 1;
@@ -243,7 +244,8 @@ static int get_stat_data(struct cache_entry *ce,
 		changed = ce_match_stat(ce, &st, 0);
 		if (S_ISGITLINK(ce->ce_mode)
 		    && !DIFF_OPT_TST(diffopt, IGNORE_SUBMODULES)
-		    && (!changed || (diffopt->output_format & DIFF_FORMAT_PATCH))) {
+		    && (!changed || (diffopt->output_format & DIFF_FORMAT_PATCH)
+		        || DIFF_OPT_TST(diffopt, DIRTY_SUBMODULES))) {
 			*dirty_submodule = is_submodule_modified(ce->name);
 			if (*dirty_submodule)
 				changed = 1;
diff --git a/diff.h b/diff.h
index 2ef3341..95ed7f8 100644
--- a/diff.h
+++ b/diff.h
@@ -69,6 +69,7 @@ typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
 #define DIFF_OPT_ALLOW_TEXTCONV      (1 << 21)
 #define DIFF_OPT_DIFF_FROM_CONTENTS  (1 << 22)
 #define DIFF_OPT_SUBMODULE_LOG       (1 << 23)
+#define DIFF_OPT_DIRTY_SUBMODULES    (1 << 24)

 #define DIFF_OPT_TST(opts, flag)    ((opts)->flags & DIFF_OPT_##flag)
 #define DIFF_OPT_SET(opts, flag)    ((opts)->flags |= DIFF_OPT_##flag)
diff --git a/t/t7506-status-submodule.sh b/t/t7506-status-submodule.sh
index 253c334..1c8d32a 100755
--- a/t/t7506-status-submodule.sh
+++ b/t/t7506-status-submodule.sh
@@ -34,7 +34,7 @@ test_expect_success 'status with modified file in submodule' '
 	(cd sub && git reset --hard) &&
 	echo "changed" >sub/foo &&
 	git status >output &&
-	grep "modified:   sub" output
+	grep "modified:   sub (new commits, modified content)" output
 '

 test_expect_success 'status with modified file in submodule (porcelain)' '
@@ -49,7 +49,7 @@ test_expect_success 'status with modified file in submodule (porcelain)' '
 test_expect_success 'status with added file in submodule' '
 	(cd sub && git reset --hard && echo >foo && git add foo) &&
 	git status >output &&
-	grep "modified:   sub" output
+	grep "modified:   sub (new commits, modified content)" output
 '

 test_expect_success 'status with added file in submodule (porcelain)' '
@@ -64,7 +64,7 @@ test_expect_success 'status with untracked file in submodule' '
 	(cd sub && git reset --hard) &&
 	echo "content" >sub/new-file &&
 	git status >output &&
-	grep "modified:   sub" output
+	grep "modified:   sub (new commits, untracked content)" output
 '

 test_expect_success 'status with untracked file in submodule (porcelain)' '
diff --git a/wt-status.c b/wt-status.c
index 5807fc3..c028afd 100644
--- a/wt-status.c
+++ b/wt-status.c
@@ -78,7 +78,8 @@ static void wt_status_print_cached_header(struct wt_status *s)
 }

 static void wt_status_print_dirty_header(struct wt_status *s,
-					 int has_deleted)
+					 int has_deleted,
+					 int has_dirty_submodules)
 {
 	const char *c = color(WT_STATUS_HEADER, s);

@@ -90,6 +91,8 @@ static void wt_status_print_dirty_header(struct wt_status *s,
 	else
 		color_fprintf_ln(s->fp, c, "#   (use \"git add/rm <file>...\" to update what will be committed)");
 	color_fprintf_ln(s->fp, c, "#   (use \"git checkout -- <file>...\" to discard changes in working directory)");
+	if (has_dirty_submodules)
+		color_fprintf_ln(s->fp, c, "#   (commit or discard the untracked or modified content in submodules)");
 	color_fprintf_ln(s->fp, c, "#");
 }

@@ -144,6 +147,7 @@ static void wt_status_print_change_data(struct wt_status *s,
 	char *two_name;
 	const char *one, *two;
 	struct strbuf onebuf = STRBUF_INIT, twobuf = STRBUF_INIT;
+	struct strbuf extra = STRBUF_INIT;

 	one_name = two_name = it->string;
 	switch (change_type) {
@@ -153,6 +157,21 @@ static void wt_status_print_change_data(struct wt_status *s,
 			one_name = d->head_path;
 		break;
 	case WT_STATUS_CHANGED:
+		if (d->new_submodule_commits || d->dirty_submodule) {
+			const char *sep = "";
+			strbuf_addstr(&extra, " (");
+			if (d->new_submodule_commits) {
+				strbuf_addf(&extra, "new commits");
+				sep = ", ";
+			}
+			if (d->dirty_submodule & DIRTY_SUBMODULE_MODIFIED) {
+				strbuf_addf(&extra, "%smodified content", sep);
+				sep = ", ";
+			}
+			if (d->dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
+				strbuf_addf(&extra, "%suntracked content",sep);
+			strbuf_addch(&extra, ')');
+		}
 		status = d->worktree_status;
 		break;
 	}
@@ -189,6 +208,10 @@ static void wt_status_print_change_data(struct wt_status *s,
 	default:
 		die("bug: unhandled diff status %c", status);
 	}
+	if (extra.len) {
+		color_fprintf(s->fp, color(WT_STATUS_HEADER, s), extra.buf);
+		strbuf_release(&extra);
+	}
 	fprintf(s->fp, "\n");
 	strbuf_release(&onebuf);
 	strbuf_release(&twobuf);
@@ -218,6 +241,9 @@ static void wt_status_collect_changed_cb(struct diff_queue_struct *q,
 		}
 		if (!d->worktree_status)
 			d->worktree_status = p->status;
+		d->dirty_submodule = p->two->dirty_submodule;
+		if (S_ISGITLINK(p->two->mode))
+			d->new_submodule_commits = !!hashcmp(p->one->sha1, p->two->sha1);
 	}
 }

@@ -281,6 +307,7 @@ static void wt_status_collect_changes_worktree(struct wt_status *s)
 	init_revisions(&rev, NULL);
 	setup_revisions(0, NULL, &rev, NULL);
 	rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
+	DIFF_OPT_SET(&rev.diffopt, DIRTY_SUBMODULES);
 	rev.diffopt.format_callback = wt_status_collect_changed_cb;
 	rev.diffopt.format_callback_data = s;
 	rev.prune_data = s->pathspec;
@@ -418,33 +445,39 @@ static void wt_status_print_updated(struct wt_status *s)
  *  0 : no change
  *  1 : some change but no delete
  */
-static int wt_status_check_worktree_changes(struct wt_status *s)
+static int wt_status_check_worktree_changes(struct wt_status *s,
+					     int *dirty_submodules)
 {
 	int i;
 	int changes = 0;

+	*dirty_submodules = 0;
+
 	for (i = 0; i < s->change.nr; i++) {
 		struct wt_status_change_data *d;
 		d = s->change.items[i].util;
 		if (!d->worktree_status ||
 		    d->worktree_status == DIFF_STATUS_UNMERGED)
 			continue;
-		changes = 1;
+		if (!changes)
+			changes = 1;
+		if (d->dirty_submodule)
+			*dirty_submodules = 1;
 		if (d->worktree_status == DIFF_STATUS_DELETED)
-			return -1;
+			changes = -1;
 	}
 	return changes;
 }

 static void wt_status_print_changed(struct wt_status *s)
 {
-	int i;
-	int worktree_changes = wt_status_check_worktree_changes(s);
+	int i, dirty_submodules;
+	int worktree_changes = wt_status_check_worktree_changes(s, &dirty_submodules);

 	if (!worktree_changes)
 		return;

-	wt_status_print_dirty_header(s, worktree_changes < 0);
+	wt_status_print_dirty_header(s, worktree_changes < 0, dirty_submodules);

 	for (i = 0; i < s->change.nr; i++) {
 		struct wt_status_change_data *d;
diff --git a/wt-status.h b/wt-status.h
index c60f40a..9120673 100644
--- a/wt-status.h
+++ b/wt-status.h
@@ -25,6 +25,8 @@ struct wt_status_change_data {
 	int index_status;
 	int stagemask;
 	char *head_path;
+	unsigned dirty_submodule       : 2;
+	unsigned new_submodule_commits : 1;
 };

 struct wt_status {
-- 
1.7.0.1.326.g01b9ac