From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: Colin Curtis <colinpcurtis@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 0/2] Add cmd_gud and detect libiconv path for Mac OS
Date: Wed, 08 Sep 2021 12:50:48 +0200 [thread overview]
Message-ID: <871r5zibca.fsf@evledraar.gmail.com> (raw)
In-Reply-To: <20210908051340.13332-1-colinpcurtis826@ucla.edu>
On Tue, Sep 07 2021, Colin Curtis wrote:
> From: Colin Curtis <colinpcurtis@gmail.com>
>
> The gud command opens the Pro Git book webpage in the default
> web browser. The reason to add this command is due to the
> play on words when saying 'git gud', which sounds like 'get good'.
> Hence this command when invoked will open up the Pro Git
> webpage to allow the user to 'get good' at git.
Purely in terms of implementation if we had this sort of thing it really
would belong in "git help", not in an overly cleverly named new
built-in.
More generally we don't link to git-scm.org now for anything
significant, AFAICT the only things we do link to are to our own
generated documentation.
[Not with my Git PLC hat on, in case anyone's wondering]
I don't think we should be further endorsing proprietary documentation
in liue of improving the free docs in git.git itself.
If this command (whether via "git help" or not) linked to anything it
should be to our own https://git-scm.com/docs/user-manual; if there's
things lacking there let's try to improve the freely available docs.
And purely in terms of UX once we had such freely available docs we
should not be opening a webpage to display them, but linking to a
manpage etc. Perhaps we should be opening a webpage, and indeed "git
help" can do that for you, but that should be to docs we have built
locally & are guaranteed to apply to the git version you're working
with.
prev parent reply other threads:[~2021-09-08 10:58 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-08 5:13 [PATCH 0/2] Add cmd_gud and detect libiconv path for Mac OS Colin Curtis
2021-09-08 5:13 ` [PATCH 1/2] add cmd_gud to open git-scm.com webpage Colin Curtis
2021-09-08 5:13 ` [PATCH 2/2] add liconv link for makefile Colin Curtis
2021-09-08 5:52 ` Carlo Arenas
2021-09-08 6:01 ` [PATCH 0/2] Add cmd_gud and detect libiconv path for Mac OS Bagas Sanjaya
2021-09-08 10:50 ` Ævar Arnfjörð Bjarmason [this message]
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=871r5zibca.fsf@evledraar.gmail.com \
--to=avarab@gmail.com \
--cc=colinpcurtis@gmail.com \
--cc=git@vger.kernel.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.
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).