From: "Junio C Hamano" <gits...@pobox.com>
"Philip Oakley" <philipoak...@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?
It would be my view that 'git help' would be the first place for a
_beginner_ to start. In some ways it depends on what background one
expects the beginner to have, and whether they know well their way
around their machine, which often isn't the case.
Given that Git is available on many systems as a packaged application,
the user may not even know where the raw documentation is held. That's
certainly likely for those on Windows ;-)
My approach, as you may have gathered, would be that the basic
documenation should at least be available via a 'git help <something>'
mechanism, even if advanced users already use alternative means suitable
to their expertise.
... 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
Ideally (from my viewpoint) there would be a way to directly access the
current "user-manual" via the 'git help'. It's whether special casing
the user-manual would be sensible.
At the moment 'git help' prompts for 'git help -g' which then lists the
leading guides (I have a -gg option to list all guides in draft), so
beginners who read the prompts would at least be led to the tutorial,
which does have an extra link into the user-manual. Otherwise it's
catch-22 - if a user doesn't know it's there they might never find it.
One has to lead the horse to the water before it can drink, even though
some never do ;-)
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html