git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [RFC] Another way to provide help details. (was Re: [PATCH] Add help details to git help command.)

From
Petr Baudis <pasky@ucw.cz>
Date
Apr 19, 2005, 17:32 UTC
Message-ID
<20050419173238.GJ12757@pasky.ji.cz>
In-Reply-To
<4265189E.6090801@dgreaves.com>

Dear diary, on Tue, Apr 19, 2005 at 04:41:34PM CEST, I got a letter where David Greaves <david@dgreaves.com> told me that...

> If Petr wants the top comment to be extracted by help then maybe a 
> bottom comment block could contain the more complete text?
> I *really* think that the user docs should live in the source for now 
> (hence I think that git man is better than going straight to man/docbook).

I'd stay with the top comment for now, and go for perldoc in the Perl scripts. It's cool, nice, and you can export it to anything and it still looks mostly cute.

> I wasn't sure whether to perlise the code or do a shell-lib - but 
> looking at the algorithms needed in things like git status I reckon the 
> shell will end up becoming a hackish mess of awk/sed/tr/sort/uniq/pipe 
> (ie perl) anyway.

I'm all for slow migration from sh to Perl so that we can add more cream on the stuff. Shell was great for the first phase of rapid development (where basically the most important thing was to be able to call the core git easily, and just wrap it around) but now if you want to do the fancier stuff (like git status, or even git log), it's getting more of a nuisance.

-- 
				Petr "Pasky" Baudis
Stuff: http://pasky.or.cz/
C++: an octopus made by nailing extra legs onto a dog. -- Steve Taylor
Previous: Steven ColeNext: Steven Cole
Message 8 of 16 in “Add help details to git help command.”
  1. Add help details to git help command.Steven Cole, Apr 18, 2005
  2. Petr BaudisApr 18, 2005
  3. Steven ColeApr 18, 2005
  4. [RFC] Another way to provide help details. (was Re: [PATCH] Add help details to git help command.)Steven Cole, Apr 19, 2005
  5. Petr BaudisApr 19, 2005
  6. David GreavesApr 19, 2005
  7. Steven ColeApr 19, 2005
  8. Petr BaudisApr 19, 2005
  9. Steven ColeApr 19, 2005
  10. Petr BaudisApr 19, 2005
  11. David GreavesApr 19, 2005
  12. Steven ColeApr 19, 2005
  13. David GreavesApr 19, 2005
  14. Petr BaudisApr 20, 2005
  15. David GreavesApr 21, 2005
  16. Petr BaudisApr 23, 2005

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.