Jean Privatgit describe without refs still works on HEAD but append "-dirty" if the working three is dirty. If the working tree is clean, nothing is appended.
Previous behavior can be achieved by specifying "HEAD".
Many build scripts use `git describe` to produce a version number. However, additional git commands are required to distinguish builds done with a clean tree from builds done with a dirty tree. This patch helps the writing of these scripts since `git describe` do the intended thing.
This new behavior could affect existing scripts by producing version number like v1.0.4-14-g2414721-dirty-dirty. These scripts could be easily fixed by explicitly using HEAD when calling `git describe` and works with any version of git.
Signed-off-by: Jean Privat <jean@pryen.org> ---
Initially, I wanted to add an option `--worktree` that works on HEAD and appends "-dirty" when the working tree is dirty. After rethink I realized that users (me included) should prefer to describe the working tree by default, and only describe HEAD if HEAD was explicitly specified.
Note that documentation of `git describe` did not mentioned the behavior of the command when no committish is specified. However, since it is still a behavior change. If the patch is accepted, it could target version 1.7. --- Documentation/git-describe.txt | 5 ++++- builtin-describe.c | 18 +++++++++++++++++- t/t6120-describe.sh | 8 ++++++++ 3 files changed, 29 insertions(+), 2 deletions(-)
Show changes to 3 files +29 −2
Documentation/git-describe.txt, builtin-describe.c, t/t6120-describe.sh
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index b231dbb..c49ecc8 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@ -8,7 +8,7 @@ git-describe - Show the most recent tag that is reachable from a commit SYNOPSIS -------- -'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] <committish>... +'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] [<committish>...] DESCRIPTION ----------- @@ -18,6 +18,9 @@ shown. Otherwise, it suffixes the tag name with the number of additional commits on top of the tagged object and the abbreviated object name of the most recent commit. +Without any committish, `git describe` opperates on HEAD and +appends "-dirty" if the working tree is dirty. + By default (without --all or --tags) `git describe` only shows annotated tags. For more information about creating annotated tags see the -a and -s options to linkgit:git-tag[1]. diff --git a/builtin-describe.c b/builtin-describe.c index df67a73..4105d9c 100644 --- a/builtin-describe.c +++ b/builtin-describe.c @@ -5,6 +5,7 @@ #include "builtin.h" #include "exec_cmd.h" #include "parse-options.h" +#include "diff.h" #define SEEN (1u<<0) #define MAX_TAGS (FLAG_BITS - 1) @@ -23,6 +24,13 @@ static int max_candidates = 10; static int found_names; static const char *pattern; static int always; +static int dirty; /* Is working tree dirty? */ + +/* diff-index command arguments to check if working tree is dirty. */ +static const char *diff_index_args[] = { + "diff-index", "--quiet", "HEAD", "--", NULL +}; + struct commit_name { struct tag *tag; @@ -208,6 +216,8 @@ static void describe(const char *arg, int last_one) display_name(n); if (longformat) show_suffix(0, n->tag ? n->tag->tagged->sha1 : sha1); + if (dirty) + printf("-dirty"); printf("\n"); return; } @@ -265,7 +275,10 @@ static void describe(const char *arg, int last_one) if (!match_cnt) { const unsigned char *sha1 = cmit->object.sha1; if (always) { - printf("%s\n", find_unique_abbrev(sha1, abbrev)); + printf("%s", find_unique_abbrev(sha1, abbrev)); + if (dirty) + printf("-dirty"); + printf("\n"); return; } die("cannot describe '%s'", sha1_to_hex(sha1)); @@ -300,6 +313,8 @@ static void describe(const char *arg, int last_one) display_name(all_matches[0].name); if (abbrev) show_suffix(all_matches[0].depth, cmit->object.sha1); + if (dirty) + printf("-dirty"); printf("\n"); if (!last_one) @@ -360,6 +375,7 @@ int cmd_describe(int argc, const char **argv, const char *prefix) } if (argc == 0) { + dirty = cmd_diff_index(ARRAY_SIZE(diff_index_args) - 1, diff_index_args, prefix); describe("HEAD", 1); } else { while (argc-- > 0) { diff --git a/t/t6120-describe.sh b/t/t6120-describe.sh index 8c7e081..8938fc6 100755 --- a/t/t6120-describe.sh +++ b/t/t6120-describe.sh @@ -123,6 +123,14 @@ test_expect_success 'rename tag Q back to A' ' test_expect_success 'pack tag refs' 'git pack-refs' check_describe A-* HEAD +test_expect_success 'set-up dirty working tree' ' + echo >>file +' + +check_describe "A-*[0-9a-f]-dirty" + +check_describe "A-*[0-9a-f]" HEAD + test_expect_success 'set-up matching pattern tests' ' git tag -a -m test-annotated test-annotated && echo >>file &&
-- 1.6.5
