Eric Sunshine <sunshine@xxxxxxxxxxxxxx> writes: > On Tue, Apr 28, 2020 at 6:53 AM Carlo Marcelo Arenas Belón > <carenas@xxxxxxxxx> wrote: >> Reading a malformed credential URL line and silently ignoring it >> does not mean that we promise to torelate and/or keep empty lines >> and "# commented" lines forever. >> >> Some people seem to take anything that is not explicitly forbidden >> as allowed, but the world does not work that way. >> >> Signed-off-by: Junio C Hamano <gitster@xxxxxxxxx> >> --- >> diff --git 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: >> +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. > > I suggest dropping the "even though some may be silently ignored" bit > since it's both mysterious (providing no concrete information) and > unnecessarily confusing since it flat out contradicts the earlier part > of the sentence. The fact that the implementation has accidentally > been loose in its parsing doesn't warrant introducing such ambiguity > into the (newly-added) documentation. I do not think it is an ambiguity. The phrase is there just to remind the readers that they are not allowed to take a loose implementation in the past as an excuse to throw in crufts and expect the result to continue working.
