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:29:19 -0700	[thread overview]
Message-ID: <xmqqv9korkg0.fsf@gitster.c.googlers.com> (raw)
In-Reply-To: <xmqqzha1q6co.fsf@gitster.c.googlers.com> (Junio C. Hamano's message of "Thu, 21 May 2020 15:19:03 -0700")

Junio C Hamano <gitster@pobox.com> writes:

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

Having said that, I am not sure the way the material covered by the
user-manual is presented in is a good match for the manpage format
in the first place.  Don't modern manpage viewers, or generic pagers
that can display textual contents (which may happen to be the "man 1
git" output), or even a terminal enumrator that may happen to be
showing the output of such a pager, notice a URL and allow users to
activate on it (i.e. visit the HTML document the URL points at, by
opening the URL in an already-running browser, or in a new instance
of a browser)?  So perhaps a better solution for those who live in a
text terminal and view our documentation via "git help -m git" or
even "man git" would be to write a full URL to reach a version of
user manual available to the user, perhaps with file:/// URL "as
text" in the man output?  Then you do not have to reformat the user
manual in the manpage format or anything silly like that.

Hmm?

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