From: Junio C Hamano <gitster@pobox.com>
To: "Philip Oakley" <philipoakley@iee.org>
Cc: <git@vger.kernel.org>, "Ramkumar Ramachandra" <artagnon@gmail.com>
Subject: Re: What's cooking in git.git (Mar 2014, #03; Fri, 14)
Date: Mon, 17 Mar 2014 10:21:27 -0700 [thread overview]
Message-ID: <xmqqd2hkg2qw.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <EA1EF5746EA7414CAE1320AA61100178@PhilipOakley> (Philip Oakley's message of "Sun, 16 Mar 2014 18:30:49 -0000")
"Philip Oakley" <philipoakley@iee.org> writes:
>> * po/git-help-user-manual (2014-02-18) 1 commit
>> - Provide a 'git help user-manual' route to the docbook
>>
>> I am not sure if this is even needed.
>
> My rhetorical question would be "what should 'git help user-manual'
> do?" for the beginner, ...
Why would any _beginner_ even be expected to ask "git help"
everything, including "user-manual", in the first place? Wouldn't
things like /usr/share/doc/git-doc/ be the place to help them in a
consistent manner across different programs instead?
> ... do we have a sort of policy on ensuring
> that the majority of user documentation should be available (or at
> least referenced) via the 'git help' mechanism?
I doubt that there should be such a policy.
"git help" is primarily to show the manual pages, and some technical
details docs that are referenced from manpages may need to be
reachable from it. The user manual, on the other hand, may
reference individual manpages but because it is primarily a document
that shows the overall flow to employ different commands, individual
manpages referring to the user manual feels entirely the other way
around.
next prev parent reply other threads:[~2014-03-17 17:21 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-03-14 22:09 What's cooking in git.git (Mar 2014, #03; Fri, 14) Junio C Hamano
2014-03-15 8:15 ` Torsten Bögershausen
2014-03-17 17:01 ` Junio C Hamano
2014-03-19 10:53 ` Max Horn
2014-03-19 12:32 ` Max Horn
2014-03-19 17:04 ` Junio C Hamano
2014-03-19 17:21 ` Max Horn
2014-03-19 18:53 ` Junio C Hamano
2014-03-15 12:34 ` Duy Nguyen
2014-03-17 18:05 ` Junio C Hamano
2014-03-16 18:30 ` Philip Oakley
2014-03-16 23:15 ` Ramkumar Ramachandra
2014-03-17 18:01 ` Junio C Hamano
2014-03-17 22:41 ` Philip Oakley
2014-03-17 17:21 ` Junio C Hamano [this message]
2014-03-18 0:16 ` Philip Oakley
2014-03-18 4:40 ` 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=xmqqd2hkg2qw.fsf@gitster.dls.corp.google.com \
--to=gitster@pobox.com \
--cc=artagnon@gmail.com \
--cc=git@vger.kernel.org \
--cc=philipoakley@iee.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.