diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2020-04-28 11:15:15 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2020-04-28 21:27:50 -0700 |
| commit | 20b4964fdf43491494122fbd297b2da7d66663b2 (patch) | |
| tree | 3938960573950d9ed333d4e51f687ff091e076a2 /Documentation/git-credential-store.txt | |
| parent | Git 2.17.5 (diff) | |
| download | tgif-20b4964fdf43491494122fbd297b2da7d66663b2.tar.xz | |
credential-store: document the file format a bit more
Reading a malformed credential URL line and silently ignoring it
does not mean that we support empty lines and/or "# commented" lines
forever. We should document it to avoid confusion.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-credential-store.txt')
| -rw-r--r-- | Documentation/git-credential-store.txt | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/git-credential-store.txt b/Documentation/git-credential-store.txt index 25fb963f4b..24166ca8b9 100644 --- a/Documentation/git-credential-store.txt +++ b/Documentation/git-credential-store.txt @@ -94,6 +94,10 @@ stored on its own line as a URL like: https://user:pass@example.com ------------------------------ +No other kinds of lines (e.g. empty lines or comment lines) are +allowed in the file, even though some may be silently ignored. Do +not view or edit the file with editors. + When Git needs authentication for a particular URL context, credential-store will consider that context a pattern to match against each entry in the credentials file. If the protocol, hostname, and |