Re: [PATCH v2 1/5] config doc: don't describe *.fetchObjects twice

[Eric Sunshine]

On Fri, May 25, 2018 at 3:28 PM, Ævar Arnfjörð Bjarmason
 wrote:
> Let's not duplicate the description of what *.fsckObjects does twice.

Nit: "duplicate" and "twice" smell redundant.

> instead let's refer to transfer.fsckObjects from both fetch.* and
> receive.*.

s/instead/Instead/

Perhaps the above paragraph can be rewritten:

Refer readers of fetch.fsckObjects and receive.fsckObjects to
transfer.fsckObjects instead of repeating the description at each
location.

(Not at all worth a re-roll.)

> I don't think this description of it makes much sense, but for now I'm
> just moving the existing documentation around. Making it better will
> be done in a later patch.
>
> Signed-off-by: Ævar Arnfjörð Bjarmason 

[PATCH v2 1/5] config doc: don't describe *.fetchObjects twice

[Ævar Arnfjörð Bjarmason]

Let's not duplicate the description of what *.fsckObjects does twice.
instead let's refer to transfer.fsckObjects from both fetch.* and
receive.*.

I don't think this description of it makes much sense, but for now I'm
just moving the existing documentation around. Making it better will
be done in a later patch.

Signed-off-by: Ævar Arnfjörð Bjarmason 
---
 Documentation/config.txt | 18 ++
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 84e2891aed..623dffd198 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1422,10 +1422,9 @@ fetch.recurseSubmodules::
 
 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.
+   objects. See `transfer.fsckObjects` for what's
+   checked. Defaults to false. If not set, the value of
+   `transfer.fsckObjects` is used instead.
 
 fetch.unpackLimit::
If the number of objects fetched over the Git native
@@ -2845,10 +2844,9 @@ receive.certNonceSlop::
 
 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.
+   objects. See `transfer.fsckObjects` for what's checked.
+   Defaults to false. If not set, the value of
+   `transfer.fsckObjects` is used instead.
 
 receive.fsck.::
When `receive.fsckObjects` is set to true, errors can be switched
@@ -3332,6 +3330,10 @@ transfer.fsckObjects::
When `fetch.fsckObjects` or `receive.fsckObjects` are
not set, the value of this variable is used instead.
Defaults to false.
++
+When set, the fetch or receive will abort in the case of a malformed
+object or a broken link. The result of an abort are only dangling
+objects.
 
 transfer.hideRefs::
String(s) `receive-pack` and `upload-pack` use to decide which
-- 
2.17.0.290.gded63e768a