describe: refresh the index when 'broken' flag is used

When describe is run with 'dirty' flag, we refresh the index
to make sure it is in sync with the filesystem before
determining if the working tree is dirty.  However, this is
not done for the codepath where the 'broken' flag is used.

This causes `git describe --broken --dirty` to false
positively report the worktree being dirty if a file has
different stat info than what is recorded in the index.
Running `git update-index -q --refresh` to refresh the index
before running diff-index fixes the problem.

Also add tests to deliberately update stat info of a
file before running describe to verify it behaves correctly.

Reported-by: Paul Millar <paul.millar@desy.de>
Suggested-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Phillip Wood <phillip.wood123@gmail.com>
Signed-off-by: Abhijeet Sonar <abhijeet.nkt@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/builtin/describe.c b/builtin/describe.c
index d6c77a714f46194faca18739d0118294bc233f81..e936d2c19f2b64b859c598c02bb029a30cc9f02f 100644 (file)
--- a/builtin/describe.c
+++ b/builtin/describe.c
@@ -54,6 +54,10 @@ static const char *diff_index_args[] = {
        "diff-index", "--quiet", "HEAD", "--", NULL
 };
 
+static const char *update_index_args[] = {
+       "update-index", "--unmerged", "-q", "--refresh", NULL
+};
+
 struct commit_name {
        struct hashmap_entry entry;
        struct object_id peeled;
@@ -645,6 +649,14 @@ int cmd_describe(int argc, const char **argv, const char *prefix)
        if (argc == 0) {
                if (broken) {
                        struct child_process cp = CHILD_PROCESS_INIT;
+
+                       strvec_pushv(&cp.args, update_index_args);
+                       cp.git_cmd = 1;
+                       cp.no_stdin = 1;
+                       cp.no_stdout = 1;
+                       run_command(&cp);
+
+                       child_process_init(&cp);
                        strvec_pushv(&cp.args, diff_index_args);
                        cp.git_cmd = 1;
                        cp.no_stdin = 1;

diff --git a/t/t6120-describe.sh b/t/t6120-describe.sh
index e78315d23d7d32c6db1f9405aa8788862bf37cd5..79e0f19deba0efbdaff2c3ffdf8b43a0dcbf4d84 100755 (executable)
--- a/t/t6120-describe.sh
+++ b/t/t6120-describe.sh
@@ -671,4 +671,40 @@ test_expect_success 'setup misleading taggerdates' '
 
 check_describe newer-tag-older-commit~1 --contains unique-file~2
 
+test_expect_success 'describe --dirty with a file with changed stat' '
+       test_when_finished "rm -fr stat-dirty" &&
+       git init stat-dirty &&
+       (
+               cd stat-dirty &&
+
+               echo A >file &&
+               git add file &&
+               git commit -m A &&
+               git tag A -a -m A &&
+               echo "A" >expect &&
+
+               test-tool chmtime -10 file &&
+               git describe --dirty >actual &&
+               test_cmp expect actual
+       )
+'
+
+test_expect_success 'describe --broken --dirty with a file with changed stat' '
+       test_when_finished "rm -fr stat-dirty" &&
+       git init stat-dirty &&
+       (
+               cd stat-dirty &&
+
+               echo A >file &&
+               git add file &&
+               git commit -m A &&
+               git tag A -a -m A &&
+               echo "A" >expect &&
+
+               test-tool chmtime -10 file &&
+               git describe --dirty --broken >actual &&
+               test_cmp expect actual
+       )
+'
+
 test_done