Re: [PATCH v3 04/10] config doc: elaborate on what transfer.fsckObjects does
From: Junio C Hamano <hidden>
Date: 2018-07-27 19:41:14
Ævar Arnfjörð Bjarmason [off-list ref] writes:
quoted hunk
The existing documentation led the user to believe that all we were doing were basic reachability sanity checks, but that hasn't been true for a very long time. Update the description to match reality, and note the caveat that there's a quarantine for accepting pushes, but not for fetching. Also mention that the fsck checks for security issues, which was my initial motivation for writing this fetch.fsck.* series. Signed-off-by: Ævar Arnfjörð Bjarmason <redacted> --- Documentation/config.txt | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-)diff --git a/Documentation/config.txt b/Documentation/config.txt index 8d08250a5b..291b4f3c57 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt@@ -3397,8 +3397,17 @@ transfer.fsckObjects:: Defaults to false. + When set, the fetch or receive will abort in the case of a malformed... +On the receiving side, failing fsckObjects will make those objects +unreachable, see "QUARANTINE ENVIRONMENT" in +linkgit:git-receive-pack[1]. On the fetch side, malformed objects will +instead be left unreferenced in the repository.
"On the receiving side" would contrast better if the counterpart were "On the fetching side", no? It may be clear to everybody who updates this document and reviews such updates that "receive" is what happens on the other side when you "push", but I think it is helpful to new readers if there were a hint that indicates the linkage nearby (if merely as a reminder). When set, the fetch or receive (i.e. the other side that accepts your "push") will abort in the case of ...