public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: David Greaves <david@dgreaves•com>
To: Petr Baudis <pasky@ucw•cz>
Cc: Steven Cole <elenstev@mesatop•com>, git@vger•kernel.org
Subject: Re: [PATCH] Add help details to git help command. (This time with Perl)
Date: Tue, 19 Apr 2005 20:04:16 +0100	[thread overview]
Message-ID: <42655630.80207@dgreaves.com> (raw)
In-Reply-To: <20050419175051.GK12757@pasky.ji.cz>

[-- Attachment #1: Type: text/plain, Size: 1045 bytes --]

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

-- 

[-- Attachment #2: Cogito.pm --]
[-- Type: application/x-perl, Size: 449 bytes --]

[-- Attachment #3: gitadd.pl --]
[-- Type: application/x-perl, Size: 1919 bytes --]

[-- Attachment #4: git.pl --]
[-- Type: application/x-perl, Size: 3681 bytes --]

  reply	other threads:[~2005-04-19 19:01 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-04-18  4:42 [PATCH] Add help details to git help command Steven Cole
2005-04-18 10:24 ` Petr Baudis
2005-04-18 16:59   ` Steven Cole
2005-04-19  1:40     ` [RFC] Another way to provide help details. (was Re: [PATCH] Add help details to git help command.) Steven Cole
2005-04-19  1:51       ` Petr Baudis
2005-04-19 14:41         ` David Greaves
2005-04-19 16:03           ` Steven Cole
2005-04-19 17:32           ` Petr Baudis
2005-04-19 17:35   ` [PATCH] Add help details to git help command. (This time with Perl) Steven Cole
2005-04-19 17:50     ` Petr Baudis
2005-04-19 19:04       ` David Greaves [this message]
2005-04-19 20:34         ` Steven Cole
2005-04-19 20:45           ` David Greaves
2005-04-20 23:34         ` Petr Baudis
2005-04-21  9:29           ` David Greaves
2005-04-23 23:41             ` Petr Baudis

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=42655630.80207@dgreaves.com \
    --to=david@dgreaves$(echo .)com \
    --cc=elenstev@mesatop$(echo .)com \
    --cc=git@vger$(echo .)kernel.org \
    --cc=pasky@ucw$(echo .)cz \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox