From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS3215 2.6.0.0/16 X-Spam-Status: No, score=-3.7 required=3.0 tests=AWL,BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE, SPF_PASS shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from out1.vger.email (out1.vger.email [IPv6:2620:137:e000::1:20]) by dcvr.yhbt.net (Postfix) with ESMTP id EFB211F61A for ; Mon, 12 Dec 2022 18:58:28 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232558AbiLLS54 (ORCPT ); Mon, 12 Dec 2022 13:57:56 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44112 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233723AbiLLS5O (ORCPT ); Mon, 12 Dec 2022 13:57:14 -0500 Received: from mail-pf1-f176.google.com (mail-pf1-f176.google.com [209.85.210.176]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C1D4318360 for ; Mon, 12 Dec 2022 10:55:22 -0800 (PST) Received: by mail-pf1-f176.google.com with SMTP id k79so547005pfd.7 for ; Mon, 12 Dec 2022 10:55:22 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=QQbs9SiyqLk2GXAa19bon+IbbIVzIvauw+kDfKZHpqM=; b=amcARtd4Jo91GZa7BBVLALjr4PZ+kM4NUjxinFGTnKQMuC60hMBRDw7ucHCuJZtxSI Er1nhwtZegm3aXhfQhAEdcRlM69Cs6dZ+pQAKti7QQEpsOxqXlO/GdiFGhu2oePTLadc vg7VDEnPom9NYVioaqrSWIPxTAjVNt/fa+h7pDpmH6SUa9B33qexC6xBTmhc1csRfHUd 2EKtGuUdnMQR7kP2LVHHIS/Oopi3OE+tagOuD1qaYtBipF2IR+30fAZYxq5WCt+hYFHq MqjOo+LNK7zudMkGJuUTRs9t1Kfliq6HcRG7JirCxO5FzH93iUhKFvNn0njeYilfTHV0 x0IA== X-Gm-Message-State: ANoB5pmPlGi78uxslZHaMVGv6yfTiq3wZ/SqJ7/O1HGI70bMAD3RxqXN vet6VnkNSbxg+zpW+PlvNvDADdYHss8OH2bwrj4= X-Google-Smtp-Source: AA0mqf7Ylbn/4xa+8M/JID9YEkhAN43sZJ/L4f/xakKGQjN5OIMs7m2AwJmzA+oeJQZCctDHR2OYCaTIJo9/W8l8VFY= X-Received: by 2002:a63:d43:0:b0:477:66b9:341b with SMTP id 3-20020a630d43000000b0047766b9341bmr70406692pgn.130.1670871322205; Mon, 12 Dec 2022 10:55:22 -0800 (PST) MIME-Version: 1.0 References: <5fb4b5a36ac806f3ee07a614bcb93df2c430507c.1670433958.git.gitgitgadget@gmail.com> <37efcfcd-fea1-c1d7-65f7-ae5f2d2a12e6@github.com> In-Reply-To: <37efcfcd-fea1-c1d7-65f7-ae5f2d2a12e6@github.com> From: Eric Sunshine Date: Mon, 12 Dec 2022 13:55:11 -0500 Message-ID: Subject: Re: [PATCH 2/4] read-cache: add index.skipHash config option To: Derrick Stolee Cc: Derrick Stolee via GitGitGadget , git@vger.kernel.org, gitster@pobox.com, vdye@github.com, avarab@gmail.com, newren@gmail.com Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org On Mon, Dec 12, 2022 at 8:59 AM Derrick Stolee wrote: > On 12/7/2022 1:59 PM, Eric Sunshine wrote: > > On Wed, Dec 7, 2022 at 12:27 PM Derrick Stolee via GitGitGadget > > wrote: > >> +index.skipHash:: > >> + When enabled, do not compute the trailing hash for the index file. > >> + Instead, write a trailing set of bytes with value zero, indicating > >> + that the computation was skipped. > >> ++ > >> +If you enable `index.skipHash`, then older Git clients may report that > >> +your index is corrupt during `git fsck`. > > > > This documentation is rather minimal. Given this description, are > > readers going to understand the purpose of the option, when they > > should use it, what the impact will be, when and why they should avoid > > it, etc.? > > I will expand this with explicit version numbers for older Git versions. Okay, but that doesn't address the larger questions I asked. The documentation, as written, gives no explanation of the purpose of this option. Since you conceived of the option and implemented it, you implicitly understand its use-case and repercussions which might arise from using it, but is the typical reader going to understand all that? Namely, is the reader going to understand: * why this option exists * what problem it is trying to solve * when to use it * when not to use it * what the repercussions are of not computing a hash for the index * etc. Are the answers to those questions documented somewhere? If so, then the documentation for this option should link to that discussion (and vice-versa). If not, then those questions should be answered by this documentation.