Skip to content

Commit 20b4964

Browse files
committed
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 <[email protected]>
1 parent df5be6d commit 20b4964

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Documentation/git-credential-store.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,10 @@ stored on its own line as a URL like:
9494
https://user:[email protected]
9595
------------------------------
9696

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+
97101
When Git needs authentication for a particular URL context,
98102
credential-store will consider that context a pattern to match against
99103
each entry in the credentials file. If the protocol, hostname, and

0 commit comments

Comments
 (0)