Re: [PATCH] Add help details to git help command. (This time with Perl)

From: Steven Cole <elenstev@mesatop.com>
Date: Apr 19, 2005, 20:34 UTC
Message-ID: <42656B6B.3080209@mesatop.com>
In-Reply-To: <42655630.80207@dgreaves.com>

David Greaves wrote:

Show 42 quoted lines

> Petr Baudis wrote:
> 
>> Dear diary, on Tue, Apr 19, 2005 at 07:35:15PM CEST, I got a letter
>> where Steven Cole <elenstev@mesatop.com> told me that...
>>
> 
> I've been working on git.pl and getting help working nicely
> 
> things to try:
> git.pl help
> git.pl add
> git.pl add --help
> git.pl add --man
> git.pl help add
> 
> The main objectives:
> * get a reasonable perl code base in git.pl
> * provide some way to document WTF is going on :)
> * keep the docs near the developer
> * allow variations in verbosity
> * modularise
> * don't use modules outside the base perl set
> * allow a gentle migration (so start by calling the .sh's)
> 
> I don't like the pod2usage calling convention but I use them for now.
> 
> I don't love the 'require gitadd.pl' but it's a gradual start...
> 
> Cogito.pm seems to be a good place for the library stuff.
> 
> git.pl
> passes everything to scripts except gitadd.pl
> works when called from somewhere other than the git dir
> I don't feel 100% about the fixup ports
> 
> gitadd.pl
> 
> 
> I thought I'd ask for comments before I spent too much time on this...
> 
> David
>

I only did my version which spits out the comments at the top of the shell script as a quick hack.

This looks good to me. Keeping the docs near the developer is essential, I think. Speaking of "I think", the name "cogito" was suggested for the SCM layer, but IIRC Linus suggested staying with just plain git. Petr suggested tig, perhaps because it looks at git from another point of view.

If we ever do decide to name the SCM layer (the git-pasky stuff) something with "git inside", other choices are:

agitato Beethoven's "Moonlight Sonata" 3rd movment is "Presto agitato" legit Since git is GPLv2, but perhaps a little too French. regurgitate No comment neccessary.

Steven