diff options
| author | M Hickford <mirth.hickford@gmail.com> | 2022-11-12 01:44:30 (GMT) |
|---|---|---|
| committer | Taylor Blau <me@ttaylorr.com> | 2022-11-14 23:18:59 (GMT) |
| commit | dabb9d875f665ec5da9ae8c84fed765cf9187463 (patch) | |
| tree | 7a2c79afec6ff4d69733621cac8e0d4312a9fbeb /Documentation/gitcredentials.txt | |
| parent | 319605f8f00e402f3ea758a02c63534ff800a711 (diff) | |
| download | git-dabb9d875f665ec5da9ae8c84fed765cf9187463.zip git-dabb9d875f665ec5da9ae8c84fed765cf9187463.tar.gz git-dabb9d875f665ec5da9ae8c84fed765cf9187463.tar.bz2 | |
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>
Diffstat (limited to 'Documentation/gitcredentials.txt')
| -rw-r--r-- | Documentation/gitcredentials.txt | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/Documentation/gitcredentials.txt b/Documentation/gitcredentials.txt index 80517b4..7288840 100644 --- a/Documentation/gitcredentials.txt +++ b/Documentation/gitcredentials.txt @@ -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 |