git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Philip Oakley <philipoakley@iee.email>
To: Junio C Hamano <gitster@pobox.com>
Cc: Git List <git@vger.kernel.org>
Subject: Re: How do Git on Linux users launch/read the user-manual?
Date: Thu, 21 May 2020 22:29:35 +0100	[thread overview]
Message-ID: <ecac8516-e536-80e8-fc72-098406592fd5@iee.email> (raw)
In-Reply-To: <xmqqpnaytb31.fsf@gitster.c.googlers.com>

On 21/05/2020 00:56, Junio C Hamano wrote:
> Philip Oakley <philipoakley@iee.email> writes:
>
>> Hi Junio,
>>
>> On 20/05/2020 22:27, Junio C Hamano wrote:
>>> Philip Oakley <philipoakley@iee.email> writes:
>>>
>>>> I can then browse that directory to find user-manual.html and open it
>>>> from there (because I know it is there!).
>>>>
>>>> How do Git on Linux users launch/read the user-manual?
>>> Start from the same starting point
>>>
>>> $ git help -w git
>>>
>>> and then navigate to the link to "Git User Manual"?
>>>
>> And then what? Is it always some .html viewer, or viewing the raw .txt
>> file, or something else? (it isn't the man view..)
> "git help -w" is showing stuff in the web browser, and when you open
> git(1), which is rendered in HTML, and visit "Git User's Manual"
> link in it, the experience would be no different from those viewing
> via the browser on Windows---$(htmldir)/user-manual.html is where
> the rendered HTML version of the user-manual is.
>
> Or are you asking something else?
>
I was more coming at the question from the other direction, that is,
about accessing, normally, the git manuals, and discovering the desired
information, both for existing and new users.

In your example, you needed to include the extra -w option, specific to
this 'special' manual, while all the other hundreds of man pages would
be accessed without it (even on Windows, as the config is set by default).

I also get the impression that many linux users may be using 'man' just
as much as much as 'git help' but neither (without realising the need
for the extra option) would show the user-manual (.txt|.html).

We do have the advised `git help -g` to list the concept guides, but
that doesn't advise about the user-manual, which surely we should
mention to those asking for help (without them needing a long journey of
discovery). The list does include `git everyday`...

I appreciate that, for some, there is a view that new users are other
peoples problems and that knowledgable users already know, roughly, 
which command they wish to use and thus then peruse the appropriate
reference manual to confirm the correct form for their command. I'd
rather we direct uncertain users to their appropriate guide quickly,
using their expected viewer method. Hence the question.

Philip

  reply	other threads:[~2020-05-21 21:29 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-20 20:58 How do Git on Linux users launch/read the user-manual? Philip Oakley
2020-05-20 21:27 ` Junio C Hamano
2020-05-20 21:50   ` Philip Oakley
2020-05-20 23:56     ` Junio C Hamano
2020-05-21 21:29       ` Philip Oakley [this message]
2020-05-21 22:19         ` Junio C Hamano
2020-05-21 22:29           ` Junio C Hamano
2020-05-22  9:57             ` Philip Oakley

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=ecac8516-e536-80e8-fc72-098406592fd5@iee.email \
    --to=philipoakley@iee.email \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /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;
as well as URLs for NNTP newsgroup(s).