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

Re: [PATCH 2/4] check-docs: update non-command documentation list

From
Philip Oakley <philipoakley@iee.org>
Date
Aug 9, 2012, 06:34 UTC
Message-ID
<676126318BF8488DBB65458177CBAC46@PhilipOakley>
In-Reply-To
<7v1ujhq9om.fsf@alter.siamese.dyndns.org>
From: "Junio C Hamano" <gitster@pobox.com>
Show 14 quoted lines
> "Philip Oakley" <philipoakley@iee.org> writes:
>
>> One issue I notice a few weeks ago is that `git help --all` does not
>> list all of the available git help pages, rather it just limits 
>> itself
>> to the available command pages.
>>
>> This means that new users can't discover those additional help pages
>> in any easy manner.
>
> That would be a problem _only_ if these "additional help pages" are
> of importance for new users.  I do not think things that come from
> Documentation/technical and ARTICLES (in Documentation/Makefile)
> qualify as such.

I'd generally agree with that. I wasn't aware of ARTICLES (in Documentation/Makefile), so that's something to I'll need to look at.

Show 5 quoted lines
>
> I'd be perfectly happy as long as all documents are reachable from
> git.html in html-fied documentation (the man pages have equivalent
> cross references, I think).
>

That is generally the tack I was looking of taking. Part of the task is making sure the 'right' pages are found from the 'right' places. So that, for the beginner needing help (git help --all), even the 'everyday git in 20 commands' and 'User manual' would be listed in the available guides section.

>
> -----
Previous: Junio C HamanoNext: Jeff King
Message 16 of 21 in “Documentation: list git-credential in plumbing commands”
  1. Documentation: list git-credential in plumbing commandsMatthieu Moy, Aug 8, 2012
  2. Junio C HamanoAug 8, 2012
  3. Documentation: list git-credential in plumbing commandsMatthieu Moy, Aug 8, 2012
  4. 0/4 update "make check-docs"Jeff King, Aug 8, 2012
  5. 1/4 check-docs: mention gitweb speciallyJeff King, Aug 8, 2012
  6. 2/4 check-docs: update non-command documentation listJeff King, Aug 8, 2012
  7. Junio C HamanoAug 8, 2012
  8. Jeff KingAug 8, 2012
  9. 5/4 check-docs: factor out command-listJeff King, Aug 8, 2012
  10. 6/4 check-docs: list git-gui as a commandJeff King, Aug 8, 2012
  11. 7/4 check-docs: drop git-help special-caseJeff King, Aug 8, 2012
  12. 8/4 check-docs: get documented command list from MakefileJeff King, Aug 8, 2012
  13. Junio C HamanoAug 8, 2012
  14. Philip OakleyAug 8, 2012
  15. Junio C HamanoAug 8, 2012
  16. Philip OakleyAug 9, 2012
  17. 3/4 command-list: add git-sh-i18nJeff King, Aug 8, 2012
  18. 4/4 command-list: mention git-credential-* helpersJeff King, Aug 8, 2012
  19. Matthieu MoyAug 9, 2012
  20. Junio C HamanoAug 8, 2012
  21. Jeff KingAug 8, 2012

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.