{"thread":{"id":"41371","subject":"man git-config inconsistency (*.fsckObjects)","startedAt":"2016-02-08T14:41:44Z","lastAt":"2016-02-08T18:41:10Z","messageCount":4,"participants":["Markus Kuhn","Jeff King","Eric Sunshine"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"277734","messageId":"56B8A928.4000802@cl.cam.ac.uk","threadId":"41371","inReplyTo":null,"subject":"man git-config inconsistency (*.fsckObjects)","fromName":"Markus Kuhn","fromEmail":"markus.kuhn@cl.cam.ac.uk","sentAt":"2016-02-08T14:41:44Z","receivedAt":"2016-02-08T14:41:44Z","isPatch":false,"sender":{"key":"markus.kuhn@cl.cam.ac.uk","avatar":null},"body":"https://www.kernel.org/pub/software/scm/git/docs/git-config.html\n\nThe git-config(1) man page entries for \"fetch.fsckObjects\" and\n\"receive.fsckObjects\" both end with the lines\n\n Defaults to false. If not set, the value of transfer.fsckObjects is\n used instead.\n\nThese two sentences contradict each other: if the variable is not set,\nthe first sentence says it is interpreted as false, the second sentence\nsays the value of transfer.fsckObjects is used instead.\n\nBoth sentences can't be true at the same time when transfer.fsckObjects = true.\n\nSuggested rephrasing:\n\n If not set, the value of transfer.fsckObjects is used\n instead, which defaults to false.\n\nMarkus\n\n-- \nMarkus Kuhn, Computer Laboratory, University of Cambridge\nhttp://www.cl.cam.ac.uk/~mgk25/ || CB3 0FD, Great Britain\n\n\n From f6253cce1a0f9df53b020c5821e9fc9fa27cd23f Mon Sep 17 00:00:00 2001\nFrom: Markus Kuhn \nDate: Mon, 8 Feb 2016 14:36:22 +0000\nSubject: [PATCH] avoid self-contradiction on fsckObjects default\n\n---\n Documentation/config.txt | 8 ++++----\n 1 file changed, 4 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex 02bcde6..85832ba 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -1157,8 +1157,8 @@ fetch.fsckObjects::\n \tIf it is set to true, git-fetch-pack will check all fetched\n \tobjects. It will abort in the case of a malformed object or a\n \tbroken link. The result of an abort are only dangling objects.\n-\tDefaults to false. If not set, the value of `transfer.fsckObjects`\n-\tis used instead.\n+\tIf not set, the value of `transfer.fsckObjects` is used\n+\tinstead, which defaults to false.\n \n fetch.unpackLimit::\n \tIf the number of objects fetched over the Git native\n@@ -2348,8 +2348,8 @@ receive.fsckObjects::\n \tIf it is set to true, git-receive-pack will check all received\n \tobjects. It will abort in the case of a malformed object or a\n \tbroken link. The result of an abort are only dangling objects.\n-\tDefaults to false. If not set, the value of `transfer.fsckObjects`\n-\tis used instead.\n+\tIf not set, the value of `transfer.fsckObjects` is used\n+\tinstead, which defaults to false.\n \n receive.fsck.::\n \tWhen `receive.fsckObjects` is set to true, errors can be switched\n-- \n1.9.1\n"},{"id":"277736","messageId":"20160208150856.GB13664@sigill.intra.peff.net","threadId":"41371","inReplyTo":"56B8A928.4000802@cl.cam.ac.uk","subject":"Re: man git-config inconsistency (*.fsckObjects)","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2016-02-08T15:08:56Z","receivedAt":"2016-02-08T15:08:56Z","isPatch":false,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Mon, Feb 08, 2016 at 02:41:44PM +0000, Markus Kuhn wrote:\n\n> https://www.kernel.org/pub/software/scm/git/docs/git-config.html\n> \n> The git-config(1) man page entries for \"fetch.fsckObjects\" and\n> \"receive.fsckObjects\" both end with the lines\n> \n> Defaults to false. If not set, the value of transfer.fsckObjects is\n> used instead.\n> \n> These two sentences contradict each other: if the variable is not set,\n> the first sentence says it is interpreted as false, the second sentence\n> says the value of transfer.fsckObjects is used instead.\n> \n> Both sentences can't be true at the same time when transfer.fsckObjects = true.\n> \n> Suggested rephrasing:\n> \n> If not set, the value of transfer.fsckObjects is used\n> instead, which defaults to false.\n\nYeah, I agree your phrasing is much clearer.\n\n> From f6253cce1a0f9df53b020c5821e9fc9fa27cd23f Mon Sep 17 00:00:00 2001\n> From: Markus Kuhn \n> Date: Mon, 8 Feb 2016 14:36:22 +0000\n> Subject: [PATCH] avoid self-contradiction on fsckObjects default\n> \n> ---\n> Documentation/config.txt | 8 ++++----\n> 1 file changed, 4 insertions(+), 4 deletions(-)\n> \n\nI think the text in your email would make a good commit message. :)\n\n-Peff\n"},{"id":"277748","messageId":"CAPig+cQZ2LWsy1VC7Aqm+V3cWG7Y3rb0dGfyS_c3BCVM3Dekgw@mail.gmail.com","threadId":"41371","inReplyTo":"20160208150856.GB13664@sigill.intra.peff.net","subject":"Re: man git-config inconsistency (*.fsckObjects)","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2016-02-08T18:00:50Z","receivedAt":"2016-02-08T18:00:50Z","isPatch":false,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Mon, Feb 8, 2016 at 10:08 AM, Jeff King wrote:\n> On Mon, Feb 08, 2016 at 02:41:44PM +0000, Markus Kuhn wrote:\n>> Suggested rephrasing:\n>>\n>> If not set, the value of transfer.fsckObjects is used\n>> instead, which defaults to false.\n>\n> Yeah, I agree your phrasing is much clearer.\n\nShould we worry about this becoming outdated if the default of\ntransfer.fsckObjects ever changes, or is that being overcautious? If\nit is a legitimate concern, then perhaps drop \"which defaults to\nfalse\" from the end of the sentence.\n"},{"id":"277752","messageId":"20160208184109.GA29332@sigill.intra.peff.net","threadId":"41371","inReplyTo":"CAPig+cQZ2LWsy1VC7Aqm+V3cWG7Y3rb0dGfyS_c3BCVM3Dekgw@mail.gmail.com","subject":"Re: man git-config inconsistency (*.fsckObjects)","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2016-02-08T18:41:10Z","receivedAt":"2016-02-08T18:41:10Z","isPatch":false,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Mon, Feb 08, 2016 at 01:00:50PM -0500, Eric Sunshine wrote:\n\n> On Mon, Feb 8, 2016 at 10:08 AM, Jeff King wrote:\n> > On Mon, Feb 08, 2016 at 02:41:44PM +0000, Markus Kuhn wrote:\n> >> Suggested rephrasing:\n> >>\n> >> If not set, the value of transfer.fsckObjects is used\n> >> instead, which defaults to false.\n> >\n> > Yeah, I agree your phrasing is much clearer.\n> \n> Should we worry about this becoming outdated if the default of\n> transfer.fsckObjects ever changes, or is that being overcautious? If\n> it is a legitimate concern, then perhaps drop \"which defaults to\n> false\" from the end of the sentence.\n\nI agree that is a potential maintenance pitfall, but I think it is\noutweighed by the benefit: namely that the information the user wants is\nright there, without them having to cross-reference themselves.\n\nFlipping the default for transfer.fsckObjects would hopefully cause us\nto examine matching fetch.*, and we would notice this during review.\n\n-Peff\n"}]}