From patchwork Sat Oct 27 06:22:58 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Duy Nguyen X-Patchwork-Id: 10658123 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 3D7945A4 for ; Sat, 27 Oct 2018 06:24:31 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 27D4F2BF74 for ; Sat, 27 Oct 2018 06:24:31 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 1C33C2BF90; Sat, 27 Oct 2018 06:24:31 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 586752BF74 for ; Sat, 27 Oct 2018 06:24:30 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728438AbeJ0PEW (ORCPT ); Sat, 27 Oct 2018 11:04:22 -0400 Received: from mail-lj1-f195.google.com ([209.85.208.195]:39200 "EHLO mail-lj1-f195.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728339AbeJ0PEV (ORCPT ); Sat, 27 Oct 2018 11:04:21 -0400 Received: by mail-lj1-f195.google.com with SMTP id a28-v6so82153ljd.6 for ; Fri, 26 Oct 2018 23:24:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=KOrYKh3/qobLotZj0OgorS02sVmdHMf19T+MOf2jf78=; b=DpfVI36MknHRmNL0oO0y9hUCAaOlczOmTpWyaWY6wKFbVnPP7HcRaXl5VRWASaY21t 83bcTcHTVGDdw810BPfXCmoNDL0ATkAz1H5F2GIGmAZfBPFZk8Tah0fMeAZWFFxjoIll RFrIy60asFHQ1WaMjE3accfec1NqgniI+cfXz35gPsSb8fgylz8aeo3nHzkfpSe2kccD hOZ1UlkTBappsueGKeWXQYOKHlo6cIks43CXDAVETV8bxXp1fjDpzEkcLIUKqheZXeyu HzdUA2274TzHIPH7KkInQrVGTjNIXViA8aHA56TeybtTKWFDm/CmJi6y/LfGAzlO9q9g SRmA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=KOrYKh3/qobLotZj0OgorS02sVmdHMf19T+MOf2jf78=; b=p8DyS6FByyQaAXb0qCdXVLiUSvHEAE7l4yow2kVcmGDh18i9wjwc5e9DnkvPSmUunQ I67l4b10GakP+74YjDYLc53JILE51hDJo41ML5GO7fut8AGP+c135LY5hnovUDIzXB7P gqI33EWauDQrGL2kXjcJzZaQcYji8Xfp0x19F5mVseiQIBpxAMEL1uu5izx1ZvTgVfJV LvTe92exx3pcZGhhfZMkwtWTLCUIgb367Ra0DIpkbdIiHlQRLBGop6hm3JOQrB/fTOO8 dunVxRmce1MkNlqAfM76ODc370P+oog+Qc5U8bhoyQx5ngrnNajU1qukuHNqj1n3K5ix iCmA== X-Gm-Message-State: AGRZ1gKoCDwJTSI5/F+Kjr6DFyybSHIuVWNNP33wzyxavuMEhWPBiK/V oVuGH6DtLsMomRQo0iMfHhnlPVIT X-Google-Smtp-Source: AJdET5c2MXc24FxmnV+yNPF0gTvlXKZGaLqs/Zd9Md+H9uUX6FQ5zKG1+1I8sbvxWXGOXl7qPZUD4A== X-Received: by 2002:a2e:1241:: with SMTP id t62-v6mr4019047lje.81.1540621465666; Fri, 26 Oct 2018 23:24:25 -0700 (PDT) Received: from localhost.localdomain (c80-216-12-205.bredband.comhem.se. [80.216.12.205]) by smtp.gmail.com with ESMTPSA id c81-v6sm2097487lfe.79.2018.10.26.23.24.24 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 26 Oct 2018 23:24:24 -0700 (PDT) From: =?utf-8?b?Tmd1eeG7hW4gVGjDoWkgTmfhu41jIER1eQ==?= To: git@vger.kernel.org Cc: Junio C Hamano , =?utf-8?b?Tmd1eeG7hW4gVGjDoWkgTmc=?= =?utf-8?b?4buNYyBEdXk=?= Subject: [PATCH 25/78] config.txt: move fsck.* to a separate file Date: Sat, 27 Oct 2018 08:22:58 +0200 Message-Id: <20181027062351.30446-26-pclouds@gmail.com> X-Mailer: git-send-email 2.19.1.647.g708186aaf9 In-Reply-To: <20181027062351.30446-1-pclouds@gmail.com> References: <20181027062351.30446-1-pclouds@gmail.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Signed-off-by: Nguyễn Thái Ngọc Duy --- Documentation/config.txt | 68 +---------------------------------- Documentation/config/fsck.txt | 67 ++++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+), 67 deletions(-) create mode 100644 Documentation/config/fsck.txt diff --git a/Documentation/config.txt b/Documentation/config.txt index 3dc2285ba5..f70f95d5cf 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -331,73 +331,7 @@ include::config/format.txt[] include::config/filter.txt[] -fsck.:: - During fsck git may find issues with legacy data which - wouldn't be generated by current versions of git, and which - wouldn't be sent over the wire if `transfer.fsckObjects` was - set. This feature is intended to support working with legacy - repositories containing such data. -+ -Setting `fsck.` will be picked up by linkgit:git-fsck[1], but -to accept pushes of such data set `receive.fsck.` instead, or -to clone or fetch it set `fetch.fsck.`. -+ -The rest of the documentation discusses `fsck.*` for brevity, but the -same applies for the corresponding `receive.fsck.*` and -`fetch..*`. variables. -+ -Unlike variables like `color.ui` and `core.editor` the -`receive.fsck.` and `fetch.fsck.` variables will not -fall back on the `fsck.` configuration if they aren't set. To -uniformly configure the same fsck settings in different circumstances -all three of them they must all set to the same values. -+ -When `fsck.` is set, errors can be switched to warnings and -vice versa by configuring the `fsck.` setting where the -`` is the fsck message ID and the value is one of `error`, -`warn` or `ignore`. For convenience, fsck prefixes the error/warning -with the message ID, e.g. "missingEmail: invalid author/committer line -- missing email" means that setting `fsck.missingEmail = ignore` will -hide that issue. -+ -In general, it is better to enumerate existing objects with problems -with `fsck.skipList`, instead of listing the kind of breakages these -problematic objects share to be ignored, as doing the latter will -allow new instances of the same breakages go unnoticed. -+ -Setting an unknown `fsck.` value will cause fsck to die, but -doing the same for `receive.fsck.` and `fetch.fsck.` -will only cause git to warn. - -fsck.skipList:: - The path to a list of object names (i.e. one unabbreviated SHA-1 per - line) that are known to be broken in a non-fatal way and should - be ignored. On versions of Git 2.20 and later comments ('#'), empty - lines, and any leading and trailing whitespace is ignored. Everything - but a SHA-1 per line will error out on older versions. -+ -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. -+ -Like `fsck.` this variable has corresponding -`receive.fsck.skipList` and `fetch.fsck.skipList` variants. -+ -Unlike variables like `color.ui` and `core.editor` the -`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not -fall back on the `fsck.skipList` configuration if they aren't set. To -uniformly configure the same fsck settings in different circumstances -all three of them they must all set to the same values. -+ -Older versions of Git (before 2.20) documented that the object names -list should be sorted. This was never a requirement, the object names -could appear in any order, but when reading the list we tracked whether -the list was sorted for the purposes of an internal binary search -implementation, which could save itself some work with an already sorted -list. Unless you had a humongous list there was no reason to go out of -your way to pre-sort the list. After Git version 2.20 a hash implementation -is used instead, so there's now no reason to pre-sort the list. +include::config/fsck.txt[] gc.aggressiveDepth:: The depth parameter used in the delta compression diff --git a/Documentation/config/fsck.txt b/Documentation/config/fsck.txt new file mode 100644 index 0000000000..879c5a29c4 --- /dev/null +++ b/Documentation/config/fsck.txt @@ -0,0 +1,67 @@ +fsck.:: + During fsck git may find issues with legacy data which + wouldn't be generated by current versions of git, and which + wouldn't be sent over the wire if `transfer.fsckObjects` was + set. This feature is intended to support working with legacy + repositories containing such data. ++ +Setting `fsck.` will be picked up by linkgit:git-fsck[1], but +to accept pushes of such data set `receive.fsck.` instead, or +to clone or fetch it set `fetch.fsck.`. ++ +The rest of the documentation discusses `fsck.*` for brevity, but the +same applies for the corresponding `receive.fsck.*` and +`fetch..*`. variables. ++ +Unlike variables like `color.ui` and `core.editor` the +`receive.fsck.` and `fetch.fsck.` variables will not +fall back on the `fsck.` configuration if they aren't set. To +uniformly configure the same fsck settings in different circumstances +all three of them they must all set to the same values. ++ +When `fsck.` is set, errors can be switched to warnings and +vice versa by configuring the `fsck.` setting where the +`` is the fsck message ID and the value is one of `error`, +`warn` or `ignore`. For convenience, fsck prefixes the error/warning +with the message ID, e.g. "missingEmail: invalid author/committer line +- missing email" means that setting `fsck.missingEmail = ignore` will +hide that issue. ++ +In general, it is better to enumerate existing objects with problems +with `fsck.skipList`, instead of listing the kind of breakages these +problematic objects share to be ignored, as doing the latter will +allow new instances of the same breakages go unnoticed. ++ +Setting an unknown `fsck.` value will cause fsck to die, but +doing the same for `receive.fsck.` and `fetch.fsck.` +will only cause git to warn. + +fsck.skipList:: + The path to a list of object names (i.e. one unabbreviated SHA-1 per + line) that are known to be broken in a non-fatal way and should + be ignored. On versions of Git 2.20 and later comments ('#'), empty + lines, and any leading and trailing whitespace is ignored. Everything + but a SHA-1 per line will error out on older versions. ++ +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. ++ +Like `fsck.` this variable has corresponding +`receive.fsck.skipList` and `fetch.fsck.skipList` variants. ++ +Unlike variables like `color.ui` and `core.editor` the +`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not +fall back on the `fsck.skipList` configuration if they aren't set. To +uniformly configure the same fsck settings in different circumstances +all three of them they must all set to the same values. ++ +Older versions of Git (before 2.20) documented that the object names +list should be sorted. This was never a requirement, the object names +could appear in any order, but when reading the list we tracked whether +the list was sorted for the purposes of an internal binary search +implementation, which could save itself some work with an already sorted +list. Unless you had a humongous list there was no reason to go out of +your way to pre-sort the list. After Git version 2.20 a hash implementation +is used instead, so there's now no reason to pre-sort the list.