git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Philip Oakley <philipoakley@iee.email>
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 15:19:03 -0700	[thread overview]
Message-ID: <xmqqzha1q6co.fsf@gitster.c.googlers.com> (raw)
In-Reply-To: <ecac8516-e536-80e8-fc72-098406592fd5@iee.email> (Philip Oakley's message of "Thu, 21 May 2020 22:29:35 +0100")

Philip Oakley <philipoakley@iee.email> writes:

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

For those who have help.format set to html, it is no "extra" thing
required.  I said "git help -w" so that people would understand what
I meant regardless of their personal settings are.

Or are you saying that nobody on Linux uses the html format?  I
should stop keeping the git-htmldocs.git repository up to date,
if that is the case, but I suspect it is not.

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

Or are you volunteering to update the mark-up (if necessary) so that
user-manual would become part of "man" ("man git-user-manual",
perhaps) suite?  That would be an excellent suggestion.

Whatever proposal/volunteering comes from you after your question is
answered would be quite interesting.  Hopefully that would be one
that is beneficial to the project as a whoel ;-)

Thanks.


  reply	other threads:[~2020-05-21 22:19 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
2020-05-21 22:19         ` Junio C Hamano [this message]
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

  List information: http://vger.kernel.org/majordomo-info.html

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

  git send-email \
    --in-reply-to=xmqqzha1q6co.fsf@gitster.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=philipoakley@iee.email \
    /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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).