]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Docs: describe how a credential-generating helper works
authorM Hickford <mirth.hickford@gmail.com>
Sat, 12 Nov 2022 01:44:30 +0000 (01:44 +0000)
committerTaylor Blau <me@ttaylorr.com>
Mon, 14 Nov 2022 23:18:59 +0000 (18:18 -0500)
Previously the docs only described storage helpers.

A concrete example: Git Credential Manager can generate credentials
for GitHub and GitLab via OAuth.
https://github.com/GitCredentialManager/git-credential-manager

Signed-off-by: M Hickford <mirth.hickford@gmail.com>
Signed-off-by: Taylor Blau <me@ttaylorr.com>
Documentation/gitcredentials.txt

index 80517b4eb2cb259d7b99528902e3192db2f4166d..72888402e733ff10a3b1a4d625b4a08d5de96607 100644 (file)
@@ -61,7 +61,9 @@ for a password. It is generally configured by adding this to your config:
 
 Credential helpers, on the other hand, are external programs from which Git can
 request both usernames and passwords; they typically interface with secure
-storage provided by the OS or other programs.
+storage provided by the OS or other programs. Alternatively, a
+credential-generating helper might generate credentials for certain servers via
+some API.
 
 To use a helper, you must first select one to use. Git currently
 includes the following helpers:
@@ -286,8 +288,8 @@ For a `store` or `erase` operation, the helper's output is ignored.
 If a helper fails to perform the requested operation or needs to notify
 the user of a potential issue, it may write to stderr.
 
-If it does not support the requested operation (e.g., a read-only store),
-it should silently ignore the request.
+If it does not support the requested operation (e.g., a read-only store
+or generator), it should silently ignore the request.
 
 If a helper receives any other operation, it should silently ignore the
 request. This leaves room for future operations to be added (older