Docs: describe how a credential-generating helper works
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>
M Hickford committed
Nov 12, 2022 at 01:44 UTC
dabb9d875f665ec5da9ae8c84fed765cf9187463
1 file changed
+5
-3
Documentation/gitcredentials.txt
+5
-3
@@ -61,7 +61,9 @@ for a password. It is generally configured by adding this to your config:
61
62
Credential helpers, on the other hand, are external programs from which Git can
63
request both usernames and passwords; they typically interface with secure
64
-storage provided by the OS or other programs.
64
+storage provided by the OS or other programs. Alternatively, a
65
+credential-generating helper might generate credentials for certain servers via
66
+some API.
67
68
To use a helper, you must first select one to use. Git currently
69
includes the following helpers:
@@ -286,8 +288,8 @@ For a `store` or `erase` operation, the helper's output is ignored.
288
If a helper fails to perform the requested operation or needs to notify
289
the user of a potential issue, it may write to stderr.
290
289
-If it does not support the requested operation (e.g., a read-only store),
290
-it should silently ignore the request.
291
+If it does not support the requested operation (e.g., a read-only store
292
+or generator), it should silently ignore the request.
293
294
If a helper receives any other operation, it should silently ignore the
295
request. This leaves room for future operations to be added (older