Re: Improve 'git help' with basic user guide linkss
- From
Philip Oakley <philipoakley@iee.org>
- Date
- Feb 8, 2013, 23:04 UTC
- Message-ID
- <27C7EA38DDD345F994F01E5B8FB6D278@PhilipOakley>
- In-Reply-To
- <7v6222za9x.fsf@alter.siamese.dyndns.org>
From: "Junio C Hamano" <gitster@pobox.com> Sent: Friday, February 08, 2013 10:54 PM
Show 14 quoted lines
> "Philip Oakley" <philipoakley@iee.org> writes:
>
>> My initial https://github.com/PhilipOakley/git/commit/e6217d simply
>> updates
>> - N_("See 'git help <command>' for more information on a specific
>> command.");
>> + N_("See 'git help <command>' for more information on a specific
>> command.\n"
>> + "Or 'git help <guide>', such as 'tutorial' for an introduction
>> to Git.");
>> as a starter for the new users.
>
> Yeah, that would be a good change to make to "git help<RETURN>"
> output.I'll sort some patches early next week (the weekend's committed elsewhere)
Show 8 quoted lines
> >> My view is that help --all (-a) is essentially incomplete as it >> currently doesn't provide all the help. > > It has always been about "tell me all subcommands", not about "give > me all the help you could give me". You are not adding a "help" > subcommand to a system you wrote last week. Changing the semantics > this late feels, eh, too late.
OK, I'll limit the the follow-ons to just an extra --guides option (probably just a list of the common guides initially), and leave --all(-a) for just the commands.