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

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.

Previous: Junio C HamanoNext: Philip Oakley
Message 5 of 8 in “Improve 'git help' with basic user guide linkss”
  1. Philip OakleyFeb 8, 2013
  2. Junio C HamanoFeb 8, 2013
  3. Philip OakleyFeb 8, 2013
  4. Junio C HamanoFeb 8, 2013
  5. Philip OakleyFeb 8, 2013
  6. Philip OakleyFeb 12, 2013
  7. John KeepingFeb 12, 2013
  8. Philip OakleyFeb 12, 2013

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.