Re: [PATCH v2] builtin/describe: introduce --broken flag

From: Jakub Narębski <jnareb@gmail.com>
Date: Mar 22, 2017, 21:50 UTC
Message-ID: <b418a7ec-a8e5-1702-1a1f-3e9c8b8a2f7e@gmail.com>
In-Reply-To: <20170321225718.18633-1-sbeller@google.com>

W dniu 21.03.2017 o 23:57, Stefan Beller pisze:

Show 17 quoted lines

> --- a/Documentation/git-describe.txt
> +++ b/Documentation/git-describe.txt
> @@ -30,9 +30,14 @@ OPTIONS
>  	Commit-ish object names to describe.  Defaults to HEAD if omitted.
>  
>  --dirty[=<mark>]::
> -	Describe the working tree.
> -	It means describe HEAD and appends <mark> (`-dirty` by
> -	default) if the working tree is dirty.
> +--broken[=<mark>]::
> +	Describe the state of the working tree.  When the working
> +	tree matches HEAD, the output is the same as "git describe
> +	HEAD".  If the working tree has local modification "-dirty"
> +	is appended to it.  If a repository is corrupt and Git
> +	cannot determine if there is local modification, Git will
> +	error out, unless `--broken' is given, which appends
> +	the suffix "-broken" instead.

The common description reads better... but unfortunately it lost information about the optional parameter, namely <mark>. The '-dirty' is just the default for <dirty-mark>, and '-broken' is the default for <broken-mark>.

Maybe /the suffix "-broken"/<broken-mark> suffix ('-broken' by default)/ and similarly for "-dirty"?

Best,

-- 
Jakub Narębski