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@xxxxxxx>
Suggested-by: Junio C Hamano <gitster@xxxxxxxxx>
Helped-by: Junio C Hamano <gitster@xxxxxxxxx>
Helped-by: Phillip Wood <phillip.wood123@xxxxxxxxx>
Signed-off-by: Abhijeet Sonar <abhijeet.nkt@xxxxxxxxx>
---
builtin/describe.c | 11 ++
t/t6120-describe.sh | 24 +++
...esh-the-index-when-broken-flag-is-us.patch | 178 ++++++++++++++++++
3 files changed, 213 insertions(+)
create mode 100644 v3-0001-describe-refresh-the-index-when-broken-flag-is-us.patch
diff --git a/builtin/describe.c b/builtin/describe.c
index e5287eddf2..7cb9d50b36 100644
--- a/builtin/describe.c
+++ b/builtin/describe.c
@@ -53,6 +53,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,13 @@ 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;
+ if (run_command(&cp))
+ child_process_clear(&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 e78315d23d..6c396e7abc 100755
--- a/t/t6120-describe.sh
+++ b/t/t6120-describe.sh
@@ -671,4 +671,28 @@ 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' '
+ git init stat-dirty &&
+ (
+ cd stat-dirty &&
+
+ echo A >file &&
+ git add file &&
+ git commit -m A &&
+ git tag A -a -m A &&
+
+ cat file >file.new &&
+ mv file.new file &&
+ git describe --dirty >actual &&
+ echo "A" >expected &&
+ test_cmp expected actual &&
+
+ cat file >file.new &&
+ mv file.new file &&
+ git describe --dirty --broken >actual &&
+ echo "A" >expected &&
+ test_cmp expected actual
+ )
+'
+
test_done
diff --git a/v3-0001-describe-refresh-the-index-when-broken-flag-is-us.patch b/v3-0001-describe-refresh-the-index-when-broken-flag-is-us.patch
new file mode 100644
index 0000000000..22e295d5eb
--- /dev/null
+++ b/v3-0001-describe-refresh-the-index-when-broken-flag-is-us.patch
@@ -0,0 +1,178 @@
+From 1da5fa48d913e1cefb2b6e1bc58df565076ee438 Mon Sep 17 00:00:00 2001
+From: Abhijeet Sonar <abhijeet.nkt@xxxxxxxxx>
+Date: Mon, 24 Jun 2024 02:57:59 +0530
+Subject: [PATCH v3] describe: refresh the index when 'broken' flag is used
+To: git@xxxxxxxxxxxxxxx
+
+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@xxxxxxx>
+Suggested-by: Junio C Hamano <gitster@xxxxxxxxx>
+Helped-by: Junio C Hamano <gitster@xxxxxxxxx>
+Helped-by: Phillip Wood <phillip.wood123@xxxxxxxxx>
+Signed-off-by: Abhijeet Sonar <abhijeet.nkt@xxxxxxxxx>
+---
+ builtin/describe.c | 11 +++++++++++
+ t/t6120-describe.sh | 24 ++++++++++++++++++++++++
+ 2 files changed, 35 insertions(+)
+
+diff --git a/builtin/describe.c b/builtin/describe.c
+index e5287eddf2..deec19b29a 100644
+--- a/builtin/describe.c
++++ b/builtin/describe.c
+@@ -53,6 +53,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,13 @@ 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);
++ strvec_clear(&cp.args);
++
+ 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 e78315d23d..6c396e7abc 100755
+--- a/t/t6120-describe.sh
++++ b/t/t6120-describe.sh
+@@ -671,4 +671,28 @@ 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' '
++ git init stat-dirty &&
++ (
++ cd stat-dirty &&
++
++ echo A >file &&
++ git add file &&
++ git commit -m A &&
++ git tag A -a -m A &&
++
++ cat file >file.new &&
++ mv file.new file &&
++ git describe --dirty >actual &&
++ echo "A" >expected &&
++ test_cmp expected actual &&
++
++ cat file >file.new &&
++ mv file.new file &&
++ git describe --dirty --broken >actual &&
++ echo "A" >expected &&
++ test_cmp expected actual
++ )
++'
++
+ test_done
+
+Range-diff against v2:
+1: d60fc0fa02 ! 1: 1da5fa48d9 describe: refresh the index when 'broken' flag is used
+ @@ Commit message
+ Reported-by: Paul Millar <paul.millar@xxxxxxx>
+ Suggested-by: Junio C Hamano <gitster@xxxxxxxxx>
+ Helped-by: Junio C Hamano <gitster@xxxxxxxxx>
+ + Helped-by: Phillip Wood <phillip.wood123@xxxxxxxxx>
+ Signed-off-by: Abhijeet Sonar <abhijeet.nkt@xxxxxxxxx>
+
+ ## builtin/describe.c ##
+ @@ builtin/describe.c: int cmd_describe(int argc, const char **argv, const char *pr
+ if (argc == 0) {
+ if (broken) {
+ struct child_process cp = CHILD_PROCESS_INIT;
+ -+ struct child_process update_index_cp = CHILD_PROCESS_INIT;
+ -+
+ -+ strvec_pushv(&update_index_cp.args, update_index_args);
+ -+ update_index_cp.git_cmd = 1;
+ -+ update_index_cp.no_stdin = 1;
+ -+ update_index_cp.no_stdout = 1;
+ -+ run_command(&update_index_cp);
+ ++ strvec_pushv(&cp.args, update_index_args);
+ ++ cp.git_cmd = 1;
+ ++ cp.no_stdin = 1;
+ ++ cp.no_stdout = 1;
+ ++ run_command(&cp);
+ ++ strvec_clear(&cp.args);
+ +
+ strvec_pushv(&cp.args, diff_index_args);
+ cp.git_cmd = 1;
+ @@ t/t6120-describe.sh: test_expect_success 'setup misleading taggerdates' '
+
+ +test_expect_success 'describe --dirty with a file with changed stat' '
+ + git init stat-dirty &&
+ -+ cd stat-dirty &&
+ -+
+ -+ echo A >file &&
+ -+ git add file &&
+ -+ git commit -m A &&
+ -+ git tag A -a -m A &&
+ -+
+ -+ cat file >file.new &&
+ -+ mv file.new file &&
+ -+ git describe --dirty >actual &&
+ -+ echo "A" >expected &&
+ -+ test_cmp expected actual
+ -+'
+ ++ (
+ ++ cd stat-dirty &&
+ +
+ -+test_expect_success 'describe --dirty --broken with a file with changed stat' '
+ -+ git init stat-dirty-broken &&
+ -+ cd stat-dirty-broken &&
+ ++ echo A >file &&
+ ++ git add file &&
+ ++ git commit -m A &&
+ ++ git tag A -a -m A &&
+ +
+ -+ echo A >file &&
+ -+ git add file &&
+ -+ git commit -m A &&
+ -+ git tag A -a -m A &&
+ ++ cat file >file.new &&
+ ++ mv file.new file &&
+ ++ git describe --dirty >actual &&
+ ++ echo "A" >expected &&
+ ++ test_cmp expected actual &&
+ +
+ -+ cat file >file.new &&
+ -+ mv file.new file &&
+ -+ git describe --dirty --broken >actual &&
+ -+ echo "A" >expected &&
+ -+ test_cmp expected actual
+ ++ cat file >file.new &&
+ ++ mv file.new file &&
+ ++ git describe --dirty --broken >actual &&
+ ++ echo "A" >expected &&
+ ++ test_cmp expected actual
+ ++ )
+ +'
+ +
+ test_done
+--
+2.45.2.606.g9005149a4a.dirty
+
Range-diff against v3:
1: 1da5fa48d9 ! 1: 9ff85435b1 describe: refresh the index when 'broken' flag is used
@@ builtin/describe.c: int cmd_describe(int argc, const char **argv, const char *pr
+ cp.git_cmd = 1;
+ cp.no_stdin = 1;
+ cp.no_stdout = 1;
-+ run_command(&cp);
-+ strvec_clear(&cp.args);
++ if (run_command(&cp))
++ child_process_clear(&cp);
+
strvec_pushv(&cp.args, diff_index_args);
cp.git_cmd = 1;
@@ t/t6120-describe.sh: test_expect_success 'setup misleading taggerdates' '
+'
+
test_done
+
+ ## v3-0001-describe-refresh-the-index-when-broken-flag-is-us.patch (new) ##
+@@
++From 1da5fa48d913e1cefb2b6e1bc58df565076ee438 Mon Sep 17 00:00:00 2001
++From: Abhijeet Sonar <abhijeet.nkt@xxxxxxxxx>
++Date: Mon, 24 Jun 2024 02:57:59 +0530
++Subject: [PATCH v3] describe: refresh the index when 'broken' flag is used
++To: git@xxxxxxxxxxxxxxx
++
++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@xxxxxxx>
++Suggested-by: Junio C Hamano <gitster@xxxxxxxxx>
++Helped-by: Junio C Hamano <gitster@xxxxxxxxx>
++Helped-by: Phillip Wood <phillip.wood123@xxxxxxxxx>
++Signed-off-by: Abhijeet Sonar <abhijeet.nkt@xxxxxxxxx>
++---
++ builtin/describe.c | 11 +++++++++++
++ t/t6120-describe.sh | 24 ++++++++++++++++++++++++
++ 2 files changed, 35 insertions(+)
++
++diff --git a/builtin/describe.c b/builtin/describe.c
++index e5287eddf2..deec19b29a 100644
++--- a/builtin/describe.c
+++++ b/builtin/describe.c
++@@ -53,6 +53,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,13 @@ 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);
+++ strvec_clear(&cp.args);
+++
++ 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 e78315d23d..6c396e7abc 100755
++--- a/t/t6120-describe.sh
+++++ b/t/t6120-describe.sh
++@@ -671,4 +671,28 @@ 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' '
+++ git init stat-dirty &&
+++ (
+++ cd stat-dirty &&
+++
+++ echo A >file &&
+++ git add file &&
+++ git commit -m A &&
+++ git tag A -a -m A &&
+++
+++ cat file >file.new &&
+++ mv file.new file &&
+++ git describe --dirty >actual &&
+++ echo "A" >expected &&
+++ test_cmp expected actual &&
+++
+++ cat file >file.new &&
+++ mv file.new file &&
+++ git describe --dirty --broken >actual &&
+++ echo "A" >expected &&
+++ test_cmp expected actual
+++ )
+++'
+++
++ test_done
++
++Range-diff against v2:
++1: d60fc0fa02 ! 1: 1da5fa48d9 describe: refresh the index when 'broken' flag is used
++ @@ Commit message
++ Reported-by: Paul Millar <paul.millar@xxxxxxx>
++ Suggested-by: Junio C Hamano <gitster@xxxxxxxxx>
++ Helped-by: Junio C Hamano <gitster@xxxxxxxxx>
++ + Helped-by: Phillip Wood <phillip.wood123@xxxxxxxxx>
++ Signed-off-by: Abhijeet Sonar <abhijeet.nkt@xxxxxxxxx>
++
++ ## builtin/describe.c ##
++ @@ builtin/describe.c: int cmd_describe(int argc, const char **argv, const char *pr
++ if (argc == 0) {
++ if (broken) {
++ struct child_process cp = CHILD_PROCESS_INIT;
++ -+ struct child_process update_index_cp = CHILD_PROCESS_INIT;
++ -+
++ -+ strvec_pushv(&update_index_cp.args, update_index_args);
++ -+ update_index_cp.git_cmd = 1;
++ -+ update_index_cp.no_stdin = 1;
++ -+ update_index_cp.no_stdout = 1;
++ -+ run_command(&update_index_cp);
++ ++ strvec_pushv(&cp.args, update_index_args);
++ ++ cp.git_cmd = 1;
++ ++ cp.no_stdin = 1;
++ ++ cp.no_stdout = 1;
++ ++ run_command(&cp);
++ ++ strvec_clear(&cp.args);
++ +
++ strvec_pushv(&cp.args, diff_index_args);
++ cp.git_cmd = 1;
++ @@ t/t6120-describe.sh: test_expect_success 'setup misleading taggerdates' '
++
++ +test_expect_success 'describe --dirty with a file with changed stat' '
++ + git init stat-dirty &&
++ -+ cd stat-dirty &&
++ -+
++ -+ echo A >file &&
++ -+ git add file &&
++ -+ git commit -m A &&
++ -+ git tag A -a -m A &&
++ -+
++ -+ cat file >file.new &&
++ -+ mv file.new file &&
++ -+ git describe --dirty >actual &&
++ -+ echo "A" >expected &&
++ -+ test_cmp expected actual
++ -+'
++ ++ (
++ ++ cd stat-dirty &&
++ +
++ -+test_expect_success 'describe --dirty --broken with a file with changed stat' '
++ -+ git init stat-dirty-broken &&
++ -+ cd stat-dirty-broken &&
++ ++ echo A >file &&
++ ++ git add file &&
++ ++ git commit -m A &&
++ ++ git tag A -a -m A &&
++ +
++ -+ echo A >file &&
++ -+ git add file &&
++ -+ git commit -m A &&
++ -+ git tag A -a -m A &&
++ ++ cat file >file.new &&
++ ++ mv file.new file &&
++ ++ git describe --dirty >actual &&
++ ++ echo "A" >expected &&
++ ++ test_cmp expected actual &&
++ +
++ -+ cat file >file.new &&
++ -+ mv file.new file &&
++ -+ git describe --dirty --broken >actual &&
++ -+ echo "A" >expected &&
++ -+ test_cmp expected actual
++ ++ cat file >file.new &&
++ ++ mv file.new file &&
++ ++ git describe --dirty --broken >actual &&
++ ++ echo "A" >expected &&
++ ++ test_cmp expected actual
++ ++ )
++ +'
++ +
++ test_done
++--
++2.45.2.606.g9005149a4a.dirty
++
--
2.45.2.606.g9005149a4a.dirty
