Re: [PATCH v4] diff: do not show submodule with untracked files as "-dirty"
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Oct 23, 2020, 15:56 UTC
- Message-ID
- <xmqq7drhhr5o.fsf@gitster.c.googlers.com>
- In-Reply-To
- <20201023111711.38739-1-sangunb09@gmail.com>
Sangeeta Jain <sangunb09@gmail.com> writes:
Show 7 quoted lines
> From: sangu09 <sangunb09@gmail.com> > > Make `--ignore-submodules=untracked` the default for `git diff` when > there is no configuration variable or command line option, so that the > command would not give '-dirty' suffix to a submodule whose working > tree has untracked files, to make it consistent with `git > describe --dirty` that is run in the submodule working tree.
What happened to the first/introductory paragraph that was excellently written in the previous round?
The usaul way to compose a log message is to
- Give an observation on how the current system work in the present tense (so no need to say "Currently X is Y", just "X is Y"), and discuss what you perceive as a problem in it.
- Propose a solution (optional---often, problem description trivially leads to an obvious solution in reader's minds).
- Give commands to the codebase to "become like so".
The first paragraph you had in the previous round was a good example of the "observation". What we see above is only the "commands" part. To those who have been intimately following the discussion, it often is understandable without both, but we are not writing for those who review the patches. We are writing for future readers who are not aware of these exchanges we are having, so we should give something to prepare them by setting the stage and stating the objective.
Show 11 quoted lines
> diff --git a/diff.c b/diff.c > index 2bb2f8f57e..5a80695da8 100644 > --- a/diff.c > +++ b/diff.c > @@ -4585,6 +4585,9 @@ void repo_diff_setup(struct repository *r, struct diff_options *options) > DIFF_XDL_SET(options, INDENT_HEURISTIC); > > options->orderfile = diff_order_file_cfg; > + > + if (!options->flags.ignore_submodule_set) > + options->flags.ignore_untracked_in_submodules = 1;
I think I already touched about this one in the previous review.
> strvec_pushl(&cp.args, "status", "--porcelain=2", NULL); > if (ignore_untracked) > - strvec_push(&cp.args, "-uno"); > + strvec_push (&cp.args, "-uno");
Noise.
Show 13 quoted lines
> diff --git a/t/t3701-add-interactive.sh b/t/t3701-add-interactive.sh > index ca04fac417..98e46ad1ae 100755 > --- a/t/t3701-add-interactive.sh > +++ b/t/t3701-add-interactive.sh > @@ -761,7 +761,7 @@ test_expect_success 'setup different kinds of dirty submodules' ' > echo dirty >>initial && > : >untracked > ) && > - git -C for-submodules diff-files --name-only >actual && > + git -C for-submodules diff-files --name-only --ignore-submodules=none >actual && > cat >expected <<-\EOF && > dirty-both-ways > dirty-head
Hmph, it seems that you chose to give options that are no longer the default to command invocations, so that the expected output from the previous world order before this patch can be reused, but is that a sensible way to go? If we are changing the default behaviour, shouldn't we rather be testing that new behaviour, I wonder?
Show 70 quoted lines
> diff --git a/t/t7064-wtstatus-pv2.sh b/t/t7064-wtstatus-pv2.sh > index 537787e598..78cd86be3a 100755 > --- a/t/t7064-wtstatus-pv2.sh > +++ b/t/t7064-wtstatus-pv2.sh > @@ -503,6 +503,31 @@ test_expect_success 'untracked changes in added submodule (AM S..U)' ' > 1 AM S..U 000000 160000 160000 $ZERO_OID $HSUB sub1 > EOF > > + git status --porcelain=v2 --branch --untracked-files=all --ignore-submodules=none >actual && > + test_cmp expect actual > + ) > +' > + > +test_expect_success 'untracked changes in added submodule (A. S...) (untracked ignored)' ' > + ( cd super_repo && > + ## create untracked file in the submodule. > + ( cd sub1 && > + echo "xxxx" >file_in_sub > + ) && > + > + HMOD=$(git hash-object -t blob -- .gitmodules) && > + HSUP=$(git rev-parse HEAD) && > + HSUB=$HSUP && > + > + cat >expect <<-EOF && > + # branch.oid $HSUP > + # branch.head master > + # branch.upstream origin/master > + # branch.ab +0 -0 > + 1 A. N... 000000 100644 100644 $ZERO_OID $HMOD .gitmodules > + 1 A. S... 000000 160000 160000 $ZERO_OID $HSUB sub1 > + EOF > + > git status --porcelain=v2 --branch --untracked-files=all >actual && > test_cmp expect actual > ) > @@ -582,6 +607,33 @@ test_expect_success 'staged and untracked changes in added submodule (AM S.MU)' > 1 AM S.MU 000000 160000 160000 $ZERO_OID $HSUB sub1 > EOF > > + git status --porcelain=v2 --branch --untracked-files=all --ignore-submodules=none >actual && > + test_cmp expect actual > + ) > +' > + > +test_expect_success 'staged and untracked changes in added submodule (AM S.M.) (untracked ignored)' ' > + ( cd super_repo && > + ( cd sub1 && > + ## stage new changes in tracked file. > + git add file_in_sub && > + ## create new untracked file. > + echo "yyyy" >>another_file_in_sub > + ) && > + > + HMOD=$(git hash-object -t blob -- .gitmodules) && > + HSUP=$(git rev-parse HEAD) && > + HSUB=$HSUP && > + > + cat >expect <<-EOF && > + # branch.oid $HSUP > + # branch.head master > + # branch.upstream origin/master > + # branch.ab +0 -0 > + 1 A. N... 000000 100644 100644 $ZERO_OID $HMOD .gitmodules > + 1 AM S.M. 000000 160000 160000 $ZERO_OID $HSUB sub1 > + EOF > + > git status --porcelain=v2 --branch --untracked-files=all >actual && > test_cmp expect actual > )
OK.
By the way, in builtin/describe.c there is an invocation of "diff-index" without any --ignore-submodules=<what> option.
/* diff-index command arguments to check if working tree is dirty. */
static const char *diff_index_args[] = {
"diff-index", "--quiet", "HEAD", "--", NULL
};Would the behaviour of diff-index invocation in "git describe --dirty" affected by the change of the default in any way?
Thanks.