diff options
author | Junio C Hamano <gitster@pobox.com> | 2020-05-13 12:19:18 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2020-05-13 12:19:19 -0700 |
commit | aa28171c2752c0aa04c2e25f2f79bc01a7f045d5 (patch) | |
tree | 7a761e7356b0521d67a6ee4be3ecbf92de24e832 /Documentation/gitcredentials.txt | |
parent | 69ae8ffa2a011384d317891c256aa6d381b003cd (diff) | |
parent | 1aed817f99bf259ea18ec49829b8d46b914e0230 (diff) | |
download | git-aa28171c2752c0aa04c2e25f2f79bc01a7f045d5.tar.gz |
Merge branch 'cb/credential-doc-fixes'
Minor in-code comments and documentation updates around credential
API.
* cb/credential-doc-fixes:
credential: document protocol updates
credential: update gitcredentials documentation
credential: correct order of parameters for credential_match
credential: update description for credential_from_url_gently
Diffstat (limited to 'Documentation/gitcredentials.txt')
-rw-r--r-- | Documentation/gitcredentials.txt | 26 |
1 files changed, 18 insertions, 8 deletions
diff --git a/Documentation/gitcredentials.txt b/Documentation/gitcredentials.txt index 0d0f7149bd..9e481aec85 100644 --- a/Documentation/gitcredentials.txt +++ b/Documentation/gitcredentials.txt @@ -268,16 +268,26 @@ For a `get` operation, the helper should produce a list of attributes on stdout in the same format (see linkgit:git-credential[1] for common attributes). A helper is free to produce a subset, or even no values at all if it has nothing useful to provide. Any provided attributes will -overwrite those already known about by Git. If a helper outputs a -`quit` attribute with a value of `true` or `1`, no further helpers will -be consulted, nor will the user be prompted (if no credential has been -provided, the operation will then fail). +overwrite those already known about by Git's credential subsystem. + +While it is possible to override all attributes, well behaving helpers +should refrain from doing so for any attribute other than username and +password. + +If a helper outputs a `quit` attribute with a value of `true` or `1`, +no further helpers will be consulted, nor will the user be prompted +(if no credential has been provided, the operation will then fail). + +Similarly, no more helpers will be consulted once both username and +password had been provided. For a `store` or `erase` operation, the helper's output is ignored. -If it fails to perform the requested operation, it may complain to -stderr to inform the user. If it does not support the requested -operation (e.g., a read-only store), it should silently ignore the -request. + +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 a helper receives any other operation, it should silently ignore the request. This leaves room for future operations to be added (older |