man git-config inconsistency (*.fsckObjects)

From: Markus Kuhn <markus.kuhn@cl.cam.ac.uk>
Date: Feb 8, 2016, 14:41 UTC
Message-ID: <56B8A928.4000802@cl.cam.ac.uk>

https://www.kernel.org/pub/software/scm/git/docs/git-config.html

The git-config(1) man page entries for "fetch.fsckObjects" and "receive.fsckObjects" both end with the lines

            Defaults to false. If not set, the value of transfer.fsckObjects is
            used instead.

These two sentences contradict each other: if the variable is not set, the first sentence says it is interpreted as false, the second sentence says the value of transfer.fsckObjects is used instead.

Both sentences can't be true at the same time when transfer.fsckObjects = true.

Suggested rephrasing:

            If not set, the value of transfer.fsckObjects is used
            instead, which defaults to false.

Markus

-- 
Markus Kuhn, Computer Laboratory, University of Cambridge
http://www.cl.cam.ac.uk/~mgk25/ || CB3 0FD, Great Britain


 From f6253cce1a0f9df53b020c5821e9fc9fa27cd23f Mon Sep 17 00:00:00 2001
From: Markus Kuhn <Markus.Kuhn@cl.cam.ac.uk>
Date: Mon, 8 Feb 2016 14:36:22 +0000
Subject: [PATCH] avoid self-contradiction on fsckObjects default

---
  Documentation/config.txt | 8 ++++----
  1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 02bcde6..85832ba 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1157,8 +1157,8 @@ fetch.fsckObjects::
  	If it is set to true, git-fetch-pack will check all fetched
  	objects. It will abort in the case of a malformed object or a
  	broken link. The result of an abort are only dangling objects.
-	Defaults to false. If not set, the value of `transfer.fsckObjects`
-	is used instead.
+	If not set, the value of `transfer.fsckObjects` is used
+	instead, which defaults to false.
  
  fetch.unpackLimit::
  	If the number of objects fetched over the Git native
@@ -2348,8 +2348,8 @@ receive.fsckObjects::
  	If it is set to true, git-receive-pack will check all received
  	objects. It will abort in the case of a malformed object or a
  	broken link. The result of an abort are only dangling objects.
-	Defaults to false. If not set, the value of `transfer.fsckObjects`
-	is used instead.
+	If not set, the value of `transfer.fsckObjects` is used
+	instead, which defaults to false.
  
  receive.fsck.<msg-id>::
  	When `receive.fsckObjects` is set to true, errors can be switched
-- 
1.9.1