Re: [PATCH] Modified the default git help message to be grouped by topic
- From
Jeff King <peff@peff.net>
- Date
- Dec 2, 2008, 23:30 UTC
- Message-ID
- <20081202233004.GA22379@coredump.intra.peff.net>
- In-Reply-To
- <alpine.DEB.1.00.0812022353410.27091@racer>
On Tue, Dec 02, 2008 at 11:55:03PM +0100, Johannes Schindelin wrote:
> If the whole thing gets longer than 24 lines, we have to leave some things > out. Personally, I consider rm and mv unimportant enough that they could > be shown in an extended list, but be left out of the summary page.
For the record, the current output is 26 lines, plus you probably want to account for 1 line of the user's next shell prompt. So we are 3 lines over already.
Scott's proposal is about grouping the commands more sensibly. Many of the complaints are about the length of the output. Maybe we should scrap having a list of commands altogether and just point at section-specific documentation, each of which could discuss basic commands related to it.
I think there has been mention of task-oriented documentation pointers before, and I think this is a place where we would want it.
-Peff