Re: [PATCH v2 2/5] config doc: unify the description of fsck.* and receive.fsck.*
- From
Eric Sunshine <sunshine@sunshineco.com>
- Date
- May 25, 2018, 21:16 UTC
- Message-ID
- <CAPig+cT=i0XYOrMymNjsBJqcLfJ38Ft_=MZPZD3N-AMo8raAHQ@mail.gmail.com>
- In-Reply-To
- <20180525192811.25680-3-avarab@gmail.com>
On Fri, May 25, 2018 at 3:28 PM, Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:
Show 18 quoted lines
> The documentation for the fsck.<msg-id> and receive.fsck.<msg-id> > variables was mostly duplicated in two places, with fsck.<msg-id> > making no mention of the corresponding receive.fsck.<msg-id>, and the > same for fsck.skipList. > [...] > Rectify this situation by describing the feature in general terms > under the fsck.* documentation, and make the receive.fsck.* > documentation refer to those variables instead. > [...] > Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> > --- > diff --git a/Documentation/config.txt b/Documentation/config.txt > @@ -1554,23 +1554,42 @@ filter.<driver>.smudge:: > +Depending on the circumstances it might be better to use > +`fsck.skipList` instead to explicitly whitelist those objects that > +have issues, otherwise new occurrences of the same issue will be > +hidden going forward, although that's unlikely to happen in practice > +unless someone is being deliberately malicious.
Is it worth mentioning buggy tools and/or other buggy Git implementations as sources?
Show 13 quoted lines
> fsck.skipList:: > The path to a sorted list of object names (i.e. one SHA-1 per > - line) that are known to be broken in a non-fatal way and should > - be ignored. This feature is useful when an established project > - should be accepted despite early commits containing errors that > - can be safely ignored such as invalid committer email addresses. > - Note: corrupt objects cannot be skipped with this setting. > + line) that are known to be broken in a non-fatal way and > + should be ignored. This feature is useful when an established > + project should be accepted despite early commits containing > + errors that can be safely ignored such as invalid committer > + email addresses. Note: corrupt objects cannot be skipped with > + this setting.
Not sure why this paragraph got re-wrapped (without, as far as I can see, any other changes), thus making the patch unnecessarily noisy.
> +Like `fsck.<msg-id>` this variable has a corresponding > +`receive.fsck.skipList` variant.