Git development
 help / color / mirror / Atom feed
From: "Philip Oakley" <philipoakley@iee.org>
To: "Junio C Hamano" <gitster@pobox.com>
Cc: "Jeff King" <peff@peff.net>,
	"Matthieu Moy" <Matthieu.Moy@imag.fr>, <git@vger.kernel.org>
Subject: Re: [PATCH 2/4] check-docs: update non-command documentation list
Date: Thu, 9 Aug 2012 07:34:08 +0100	[thread overview]
Message-ID: <676126318BF8488DBB65458177CBAC46@PhilipOakley> (raw)
In-Reply-To: 7v1ujhq9om.fsf@alter.siamese.dyndns.org

From: "Junio C Hamano" <gitster@pobox.com>
> "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.

>
> 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.

>
> -----

  reply	other threads:[~2012-08-09  6:34 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-08-08  7:58 [PATCH] Documentation: list git-credential in plumbing commands Matthieu Moy
2012-08-08 16:58 ` Junio C Hamano
2012-08-08 17:13   ` [PATCH v2] " Matthieu Moy
2012-08-08 18:31   ` [PATCH 0/4] update "make check-docs" Jeff King
2012-08-08 18:32     ` [PATCH 1/4] check-docs: mention gitweb specially Jeff King
2012-08-08 18:34     ` [PATCH 2/4] check-docs: update non-command documentation list Jeff King
2012-08-08 19:24       ` Junio C Hamano
2012-08-08 20:54         ` Jeff King
2012-08-08 20:56           ` [PATCH 5/4] check-docs: factor out command-list Jeff King
2012-08-08 20:56           ` [PATCH 6/4] check-docs: list git-gui as a command Jeff King
2012-08-08 20:57           ` [PATCH 7/4] check-docs: drop git-help special-case Jeff King
2012-08-08 20:57           ` [PATCH 8/4] check-docs: get documented command list from Makefile Jeff King
2012-08-08 21:35             ` Junio C Hamano
2012-08-08 22:11           ` [PATCH 2/4] check-docs: update non-command documentation list Philip Oakley
2012-08-08 22:51             ` Junio C Hamano
2012-08-09  6:34               ` Philip Oakley [this message]
2012-08-08 18:34     ` [PATCH 3/4] command-list: add git-sh-i18n Jeff King
2012-08-08 18:34     ` [PATCH 4/4] command-list: mention git-credential-* helpers Jeff King
2012-08-09  8:02       ` Matthieu Moy
2012-08-08 19:13     ` [PATCH 0/4] update "make check-docs" Junio C Hamano
2012-08-08 20:10       ` Jeff King

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=676126318BF8488DBB65458177CBAC46@PhilipOakley \
    --to=philipoakley@iee.org \
    --cc=Matthieu.Moy@imag.fr \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=peff@peff.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox