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>
Junio C Hamano committed
Apr 28, 2020 at 11:15 UTC
20b4964fdf43491494122fbd297b2da7d66663b2
1 file changed
+4
Documentation/git-credential-store.txt
+4
@@ -94,6 +94,10 @@ stored on its own line as a URL like:
94
https://user:pass@example.com
95
------------------------------
96
97
+No other kinds of lines (e.g. empty lines or comment lines) are
98
+allowed in the file, even though some may be silently ignored. Do
99
+not view or edit the file with editors.
100
+
101
When Git needs authentication for a particular URL context,
102
credential-store will consider that context a pattern to match against
103
each entry in the credentials file. If the protocol, hostname, and