git/cogito suggestion: tags with descriptions

git/cogito suggestion: tags with descriptions

[Zack Brown]

Hi folks,

I've been using git on my new projects, and loving it!

When I use tags, I typically will use a name like "0.3_basic_description"
and "0.4_full_outline", because I want to know not only what version number I'm
considering, but also the reason why I chose to tag that particular version.

The problem is that when I want to seek to a particular version to see where my
head was at, I have to do all that typing, or cut and paste the full text of the
tag, which is not terribly annoying, but it seems unnecessary. The version
number is the unique ID I'm really interested in, and the descriptive part of
the name is just extra, so I know what I'm talking about.

It would be great if tags also allowed a brief description to go along with
them, that would show up in cg-tag-ls. Then I could seek to a tag that's just
an easy-to-type version number, and still have an idea of what's significant
about that version because of the descriptive text.

Be well,
Zack

-- 
Zack Brown

Re: git/cogito suggestion: tags with descriptions

[Junio C Hamano]

Zack Brown <zbrown@tumblerings.org> writes:

> It would be great if tags also allowed a brief description to go along with
> them, that would show up in cg-tag-ls. Then I could seek to a tag that's just
> an easy-to-type version number, and still have an idea of what's significant
> about that version because of the descriptive text.

Would 'git tag -a' work for you?

: siamese; git tag -a -m 'This is to just demonstrate.' test-for-brown
: siamese; git cat-file tag test-for-brown
object 0516de30e8bdd26086e2a3edd3375981fd0c34d6
type commit
tag test-for-brown
tagger Junio C Hamano <junkio@cox.net> 1125946805 -0700

This is to just demonstrate.
: siamese; 

BTW, when will the next issue of GIT traffic appear ;-)?

Re: git/cogito suggestion: tags with descriptions

[Zack Brown]

Hi Junio!

On Mon, Sep 05, 2005 at 12:01:40PM -0700, Junio C Hamano wrote:
> Zack Brown <zbrown@tumblerings.org> writes:
> 
> > It would be great if tags also allowed a brief description to go along with
> > them, that would show up in cg-tag-ls. Then I could seek to a tag that's just
> > an easy-to-type version number, and still have an idea of what's significant
> > about that version because of the descriptive text.
> 
> Would 'git tag -a' work for you?
> 
> : siamese; git tag -a -m 'This is to just demonstrate.' test-for-brown
> : siamese; git cat-file tag test-for-brown
> object 0516de30e8bdd26086e2a3edd3375981fd0c34d6
> type commit
> tag test-for-brown
> tagger Junio C Hamano <junkio@cox.net> 1125946805 -0700
> 
> This is to just demonstrate.
> : siamese; 

I'm not sure. I'm not as familiar with the low-level git commands as I am with
cogito. But cogito has a -d option for giving a tag description. I guess what
would be closest to what I was thinking about would be this:

$ cg-tag -d "First draft, everything in place." 0.3 7540e503b9b9c1b03e44ee7fd700c844b2a02224
$ cg-tag-ls
0.1     Initial idea complete                 f953b71b21a0bea682c2bed91362f2dce2cc204f
0.3     First draft, everything in place.     7540e503b9b9c1b03e44ee7fd700c844b2a02224 
$

or something like that. Currently when I do the above cg-tag command,
a subsequent cg-tag-ls gives just:

$ cg-tag-ls
0.1     f953b71b21a0bea682c2bed91362f2dce2cc204f
0.3     7540e503b9b9c1b03e44ee7fd700c844b2a02224

In fact, I probably wouldn't even be interested in seeing the actual hash key
unless I gave a special flag, maybe -f (for "full"):

$ cg-tag-ls
0.1     Initial idea complete
0.3     First draft, everything in place.
$ cg-tag-ls -f
0.1     Initial idea complete                 f953b71b21a0bea682c2bed91362f2dce2cc204f
0.3     First draft, everything in place.     7540e503b9b9c1b03e44ee7fd700c844b2a02224
$

> 
> BTW, when will the next issue of GIT traffic appear ;-)?

Honestly, I don't know. I seem to be having my hands full just trying to
keep Kernel Traffic up-to-date (just caught up today, finally). I really did
the first Git Traffic to kind of spread the word about how mind-blowing the
whole git development process was.

But whether I'll keep on doing it, I don't know. Between Kernel Traffic,
my day job, and a few non-Linux projects, I may have my hands full.

On the other hand, if someone wanted to volunteer to write Git Traffic, I'd
be happy to help them get started. I don't mean you, but perhaps a regular
reader of this list would be interested. It seems like there's at least some
interest in seeing it continue. :-)

Be well,
Zack

> 
> 
> -
> To unsubscribe from this list: send the line "unsubscribe git" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

-- 
Zack Brown

Re: git/cogito suggestion: tags with descriptions

[Junio C Hamano]

Zack Brown <zbrown@tumblerings.org> writes:

> It would be great if tags also allowed a brief description to go along with
> them, that would show up in cg-tag-ls. Then I could seek to a tag that's just
> an easy-to-type version number, and still have an idea of what's significant
> about that version because of the descriptive text.

Do people crave for 'git tag' showing list of tags with their
brief descriptions just like 'git branch' does?
 

Re: git/cogito suggestion: tags with descriptions

[A Large Angry SCM]

Junio C Hamano wrote:
> Zack Brown <zbrown@tumblerings.org> writes:
> 
>>It would be great if tags also allowed a brief description to go along with
>>them, that would show up in cg-tag-ls. Then I could seek to a tag that's just
>>an easy-to-type version number, and still have an idea of what's significant
>>about that version because of the descriptive text.
> 
> Do people crave for 'git tag' showing list of tags with their
> brief descriptions just like 'git branch' does?

Sort of like what gitweb does now?

Re: git/cogito suggestion: tags with descriptions

[Petr Baudis]

Dear diary, on Mon, Sep 05, 2005 at 11:24:31PM CEST, I got a letter
where Zack Brown <zbrown@tumblerings.org> told me that...
> I'm not sure. I'm not as familiar with the low-level git commands as I am with
> cogito. But cogito has a -d option for giving a tag description. I guess what
> would be closest to what I was thinking about would be this:
> 
> $ cg-tag -d "First draft, everything in place." 0.3 7540e503b9b9c1b03e44ee7fd700c844b2a02224
> $ cg-tag-ls
> 0.1     Initial idea complete                 f953b71b21a0bea682c2bed91362f2dce2cc204f
> 0.3     First draft, everything in place.     7540e503b9b9c1b03e44ee7fd700c844b2a02224 
> $
> 
> or something like that. Currently when I do the above cg-tag command,
> a subsequent cg-tag-ls gives just:
> 
> $ cg-tag-ls
> 0.1     f953b71b21a0bea682c2bed91362f2dce2cc204f
> 0.3     7540e503b9b9c1b03e44ee7fd700c844b2a02224
> 
> In fact, I probably wouldn't even be interested in seeing the actual hash key
> unless I gave a special flag, maybe -f (for "full"):
> 
> $ cg-tag-ls
> 0.1     Initial idea complete
> 0.3     First draft, everything in place.
> $ cg-tag-ls -f
> 0.1     Initial idea complete                 f953b71b21a0bea682c2bed91362f2dce2cc204f
> 0.3     First draft, everything in place.     7540e503b9b9c1b03e44ee7fd700c844b2a02224

That's a nice idea (except that I'd prefer -l). I'll implement this
after cogito-0.14.

Thanks,

-- 
				Petr "Pasky" Baudis
Stuff: http://pasky.or.cz/
If you want the holes in your knowledge showing up try teaching
someone.  -- Alan Cox

Re: git/cogito suggestion: tags with descriptions

[Petr Baudis]

Dear diary, on Mon, Sep 12, 2005 at 03:00:51AM CEST, I got a letter
where Petr Baudis <pasky@suse.cz> said that...
> Dear diary, on Mon, Sep 05, 2005 at 11:24:31PM CEST, I got a letter
> where Zack Brown <zbrown@tumblerings.org> told me that...
> > I'm not sure. I'm not as familiar with the low-level git commands as I am with
> > cogito. But cogito has a -d option for giving a tag description. I guess what
> > would be closest to what I was thinking about would be this:
> > 
> > $ cg-tag -d "First draft, everything in place." 0.3 7540e503b9b9c1b03e44ee7fd700c844b2a02224
> > $ cg-tag-ls
> > 0.1     Initial idea complete                 f953b71b21a0bea682c2bed91362f2dce2cc204f
> > 0.3     First draft, everything in place.     7540e503b9b9c1b03e44ee7fd700c844b2a02224 
> > $
> > 
> > or something like that. Currently when I do the above cg-tag command,
> > a subsequent cg-tag-ls gives just:
> > 
> > $ cg-tag-ls
> > 0.1     f953b71b21a0bea682c2bed91362f2dce2cc204f
> > 0.3     7540e503b9b9c1b03e44ee7fd700c844b2a02224
> > 
> > In fact, I probably wouldn't even be interested in seeing the actual hash key
> > unless I gave a special flag, maybe -f (for "full"):
> > 
> > $ cg-tag-ls
> > 0.1     Initial idea complete
> > 0.3     First draft, everything in place.
> > $ cg-tag-ls -f
> > 0.1     Initial idea complete                 f953b71b21a0bea682c2bed91362f2dce2cc204f
> > 0.3     First draft, everything in place.     7540e503b9b9c1b03e44ee7fd700c844b2a02224
> 
> That's a nice idea (except that I'd prefer -l). I'll implement this
> after cogito-0.14.

So, I did. ;-) (In the master branch now.) The format is slightly
different from the proposed one:

	S cogito-0.16rc2   7766e3ba0664
	S cogito-0.17      51392f2dd82a  Poetic cogito-0.17.
	S cogito-0.17rc1   7cb4d8972d5b  Behold, cogito-0.17rc1! Plenty new features and cool stuff.
	% cogito-0.8       f9f0459b5b39
	% cogito-0.9       cc5517b4ea41
	  test             05862786175d

Object IDs are still shown, but abbreviated so they shouldn't get in the
way too much; the full first line is shown in the list output,
untrimmed. The initial flag column denotes signed tags by 'S', "direct
tags" (not pointing to a tag object) by '%' and broken tags by '!'.

P.S.: Also, cg-tag received a lot of improvements in the last two days.
Now features the same cool editor as cg-commit (but only if ran with
-e), -d was renamed to -m (but will stay aliased for quite some time),
cg-tag now also accepts multiple -m options for creating multi-paragraph
descriptions from the commandline, and bunch of other minor stuff was
implemented.

Thanks for the idea,

-- 
				Petr "Pasky" Baudis
Stuff: http://pasky.or.cz/
Right now I am having amnesia and deja-vu at the same time.  I think
I have forgotten this before.