Skip to content

Commit dabb9d8

Browse files
hickfordttaylorr
authored andcommitted
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 <[email protected]> Signed-off-by: Taylor Blau <[email protected]>
1 parent 319605f commit dabb9d8

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

Documentation/gitcredentials.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,9 @@ for a password. It is generally configured by adding this to your config:
6161

6262
Credential helpers, on the other hand, are external programs from which Git can
6363
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.
6567

6668
To use a helper, you must first select one to use. Git currently
6769
includes the following helpers:
@@ -286,8 +288,8 @@ For a `store` or `erase` operation, the helper's output is ignored.
286288
If a helper fails to perform the requested operation or needs to notify
287289
the user of a potential issue, it may write to stderr.
288290

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

292294
If a helper receives any other operation, it should silently ignore the
293295
request. This leaves room for future operations to be added (older

0 commit comments

Comments
 (0)