Skip to content

Commit

Permalink
Docs: describe how a credential-generating helper works
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
hickford authored and ttaylorr committed Nov 14, 2022
1 parent 319605f commit dabb9d8
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions Documentation/gitcredentials.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit dabb9d8

Please sign in to comment.