builtin/describe: introduce --broken flag
authorStefan Beller <sbeller@google.com>
Tue, 21 Mar 2017 22:57:18 +0000 (15:57 -0700)
committerJunio C Hamano <gitster@pobox.com>
Wed, 22 Mar 2017 17:13:41 +0000 (10:13 -0700)
commitb0176ce6b5d954a747dc4d0c5a8593ed576714c4
tree2ff1ee516b34b29613cfe8ac9af99bf377a212f2
parentc0f9c705890ac30871c70219c4b08d740fb40e2e
builtin/describe: introduce --broken flag

git-describe tells you the version number you're at, or errors out, e.g.
when you run it outside of a repository, which may happen when downloading
a tar ball instead of using git to obtain the source code.

To keep this property of only erroring out, when not in a repository,
severe (submodule) errors must be downgraded to reporting them gently
instead of having git-describe error out completely.

To achieve that a flag '--broken' is introduced, which is in the same
vein as '--dirty' but uses an actual child process to check for dirtiness.
When that child dies unexpectedly, we'll append '-broken' instead of
'-dirty'.

Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-describe.txt
builtin/describe.c
t/t6120-describe.sh