From: Jeff King <peff@peff.net>
To: M Hickford via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, msuchanek@suse.de,
sandals@crustytoothpaste.net, lessleydennington@gmail.com,
me@ttaylorr.com, mjcheetham@github.com,
M Hickford <mirth.hickford@gmail.com>
Subject: Re: [PATCH v2] doc: gitcredentials: link to helper list
Date: Tue, 27 Jun 2023 04:21:01 -0400 [thread overview]
Message-ID: <20230627082101.GG1226768@coredump.intra.peff.net> (raw)
In-Reply-To: <pull.1538.v2.git.1687332624780.gitgitgadget@gmail.com>
On Wed, Jun 21, 2023 at 07:30:24AM +0000, M Hickford via GitGitGadget wrote:
> From: M Hickford <mirth.hickford@gmail.com>
>
> Link to community list of credential helpers. This is useful information
> for users.
>
> Describe how OAuth credential helpers work. OAuth is a user-friendly
> alternative to personal access tokens and SSH keys. Reduced setup cost
> makes it easier for users to contribute to projects across multiple
> forges.
Kind of seems like two topics in one patch, but OK.
I don't have much of an opinion on either topic, but...
> diff --git a/Documentation/gitcredentials.txt b/Documentation/gitcredentials.txt
> index 100f045bb1a..a266870a042 100644
> --- a/Documentation/gitcredentials.txt
> +++ b/Documentation/gitcredentials.txt
> @@ -104,6 +104,18 @@ $ git help credential-foo
> $ git config --global credential.helper foo
> -------------------------------------------
>
> +=== Available helpers
> +
> +The community maintains a comprehensive
> +https://git-scm.com/doc/credential-helpers[list of Git credential helpers]
> +available.
I'd note that full hyperlinks like this are kind of lousy in the manpage
builds. You get:
Available helpers
The community maintains a comprehensive list of Git credential
helpers[1] available.
in the text, and then way down at the bottom of the manpage:
NOTES
1. list of Git credential helpers
https://git-scm.com/doc/credential-helpers
Something like:
diff --git a/Documentation/gitcredentials.txt b/Documentation/gitcredentials.txt
index fd5ecede13..1c7d302f18 100644
--- a/Documentation/gitcredentials.txt
+++ b/Documentation/gitcredentials.txt
@@ -106,9 +106,8 @@ $ git config --global credential.helper foo
=== Available helpers
-The community maintains a comprehensive
-https://git-scm.com/doc/credential-helpers[list of Git credential helpers]
-available.
+The community maintains a comprehensive list of Git credential helpers
+at https://git-scm.com/doc/credential-helpers.
=== OAuth
yields nicer text in the manpage, and asciidoc is smart enough to turn
it into a hyperlink in the html version.
-Peff
next prev parent reply other threads:[~2023-06-27 8:21 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-28 19:45 [PATCH] doc: gitcredentials: introduce OAuth helpers M Hickford via GitGitGadget
2023-05-28 22:51 ` brian m. carlson
2023-05-29 9:50 ` M Hickford
2023-06-21 6:28 ` M Hickford
2023-06-21 7:30 ` [PATCH v2] doc: gitcredentials: link to helper list M Hickford via GitGitGadget
2023-06-27 8:21 ` Jeff King [this message]
2023-07-08 20:36 ` [PATCH v3] " M Hickford via GitGitGadget
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=20230627082101.GG1226768@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=lessleydennington@gmail.com \
--cc=me@ttaylorr.com \
--cc=mirth.hickford@gmail.com \
--cc=mjcheetham@github.com \
--cc=msuchanek@suse.de \
--cc=sandals@crustytoothpaste.net \
/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 read-only IMAP folder(s) and NNTP newsgroup(s).