Re: [RFC] describe: add option --dirty

From: Shawn O. Pearce <spearce@spearce.org>
Date: Jul 23, 2007, 07:08 UTC
Message-ID: <20070723070818.GI32566@spearce.org>
In-Reply-To: <7vsl7fmwud.fsf@assigned-by-dhcp.cox.net>

Junio C Hamano <gitster@pobox.com> wrote:

Show 19 quoted lines

> Yasushi SHOJI <yashi@atmark-techno.com> writes:
> 
> > when --dirty is given, git describe will check the working tree and
> > append "-dirty" to describe string if the tree is dirty.
> > ---
> > I'm not sure this is good idea or the current way (using diff-index in
> > shell script) is more prefered.
> 
> Hmph, this makes sense _ONLY_ for HEAD, doesn't it?
> 
> IOW, what should this output?
> 
> 	$ git checkout v1.5.0 ;# detached HEAD
>         $ git reset --hard  ;# clean slate
>         $ echo >>Makefile ;# not anymore
>         $ git describe --dirty v1.4.0^1
> 
> Should it say "v1.4.0-rc2-156-g0a8f4f0-dirty"?  The dirtiness
> does not have anything to do with commit v1.4.0^1, so...

Good catch. I had that in my mind when I was reading the patch, but failed to mention it. I blame metze on #git, he interrupted my train of thought. ;-)

I think the answer is the user passes either --dirty OR one or more commit-ish. But not --dirty and a commit-ish. In other words you can either describe the working directory state, or a commit, but not both at once. Which also neatly solves my issue with diff-index running more than once.

-- 
Shawn.