From patchwork Fri Jul 29 08:25:47 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 12932116 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 88385C00144 for ; Fri, 29 Jul 2022 08:26:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234767AbiG2I0f (ORCPT ); Fri, 29 Jul 2022 04:26:35 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33642 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234779AbiG2I0C (ORCPT ); Fri, 29 Jul 2022 04:26:02 -0400 Received: from mail-wm1-x331.google.com (mail-wm1-x331.google.com [IPv6:2a00:1450:4864:20::331]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C103E286D0 for ; Fri, 29 Jul 2022 01:26:00 -0700 (PDT) Received: by mail-wm1-x331.google.com with SMTP id j29-20020a05600c1c1d00b003a2fdafdefbso2147807wms.2 for ; Fri, 29 Jul 2022 01:26:00 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc; bh=0U2O4DkUIBVAsjxraGQJy76siTM7vzKDbjb/To0tUsk=; b=T8UMCmvQMADKUoYCKTVZd6bIjfSoX4y8+8fH6ymFn99wPshUIVLu/PVodw1Jfv0cu2 bbHFT94tME4SeUG7BF7sT0KpxFGla3Dsff/0Zbuda3sau79NunFEGuRTPkBIrLreR0dC piMhl8HumOn4knEnOqzfa6w8QAKfEAZhhzwWB7MLVMlArnlp3dd4zicQvEf2twYLGPz+ Gx7x1iOncUuarko6vFtfXDBMMJazY/+Q/3xeSsCcW89LEWNwXHzzptVAhPyfpca9ZjfU RSW+5BlDhrAsaY06J2lBiFXOcTPnPj0abFmImYFz6voXnaTFdC0TXzy9zopftQJRstfw +PQg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc; bh=0U2O4DkUIBVAsjxraGQJy76siTM7vzKDbjb/To0tUsk=; b=T/hNCupPMR7o3lhgnUe8r76uxrSgJUBRnjQFu5+1hEPqjpeoRdSk3iTC9mzFldXMdr FrZhhQ3g25YJQHMy9t30g7eD6F3GcaVVoibhgmpXRQY8/Afo2OOZmP26w/WAd+D5qIQ0 T8+jVCQ9yH5qvIT/TAgLiG5PVhFcnv0h95FiAwERjXT7seNS8qdsIXJeJAi9L+khxugx IMf2CkhWnD8CH/B3xaEFuGWO7lT8ozHHdcTm0bdX62qBzCmSnYGvD3JrtATlPUc9lP03 mVdSl0CsxxKXGNxv7qJ3dGbFKRniaiU/L8dSQC2tSpEphTTVJARZkFt+TS2OWLN1thdg bPxw== X-Gm-Message-State: AJIora/kp73IvQmual27b1i0i/8Pk1vCGr/0rqCMquK2oMTK9saKwsL5 CaMtN+Xl5RB7ZOQBsPiOMeEzohOthP1CVw== X-Google-Smtp-Source: AGRyM1ugv1jxx/JN0oW9K3Yl7jaIlrh1njqQy82JzSjNdyri3wRI60ZNTaLb5a2L5o0qZA9DhbxmOA== X-Received: by 2002:a05:600c:1d21:b0:3a3:3227:e482 with SMTP id l33-20020a05600c1d2100b003a33227e482mr1957986wms.121.1659083158678; Fri, 29 Jul 2022 01:25:58 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id m20-20020a056000181400b0021e571a99d5sm2994802wrh.17.2022.07.29.01.25.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Jul 2022 01:25:58 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , Matheus Tavares , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v2 1/9] docs: add and use include template for config/* includes Date: Fri, 29 Jul 2022 10:25:47 +0200 Message-Id: X-Mailer: git-send-email 2.37.1.1196.g8af3636bc64 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org In b6a8d09f6d8 (gc docs: include the "gc.*" section from "config" in "gc", 2019-04-07) the "git gc" documentation was made to include the config/gc.txt in its "CONFIGURATION" section. We do that in several other places, but "git gc" was the only one with a blurb above the include to orient the reader. We don't want readers to carefully scrutinize "git-config(1)" and "git-gc(1)" looking for discrepancies, instead we should tell them that the latter includes a part of the former. This change formalizes that wording in two new templates to be included, one for the "git gc" case where the entire section is included from "git-config(1)", and another for when the inclusion of "git-config(1)" follows discussion unique to that documentation. In order to use that re-arrange the order of those being discussed in the "git-merge(1)" documentation. Signed-off-by: Ævar Arnfjörð Bjarmason --- Documentation/Makefile | 1 + Documentation/git-fsck.txt | 2 ++ Documentation/git-gc.txt | 3 +-- Documentation/git-imap-send.txt | 2 ++ Documentation/git-merge.txt | 5 ++++- Documentation/git-mergetool.txt | 3 +++ Documentation/git-rebase.txt | 2 ++ Documentation/includes/cmd-config-section-all.txt | 3 +++ Documentation/includes/cmd-config-section-rest.txt | 3 +++ 9 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 Documentation/includes/cmd-config-section-all.txt create mode 100644 Documentation/includes/cmd-config-section-rest.txt diff --git a/Documentation/Makefile b/Documentation/Makefile index 4f801f4e4c9..85b2088b888 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -51,6 +51,7 @@ HOWTO_TXT += $(wildcard howto/*.txt) DOC_DEP_TXT += $(wildcard *.txt) DOC_DEP_TXT += $(wildcard config/*.txt) +DOC_DEP_TXT += $(wildcard includes/*.txt) ifdef MAN_FILTER MAN_TXT = $(filter $(MAN_FILTER),$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)) diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt index 5088783dccb..29318ea957e 100644 --- a/Documentation/git-fsck.txt +++ b/Documentation/git-fsck.txt @@ -107,6 +107,8 @@ care about this output and want to speed it up further. CONFIGURATION ------------- +include::includes/cmd-config-section-all.txt[] + include::config/fsck.txt[] DISCUSSION diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt index 0af7540a0c8..a65c9aa62d6 100644 --- a/Documentation/git-gc.txt +++ b/Documentation/git-gc.txt @@ -110,8 +110,7 @@ users and their repositories. CONFIGURATION ------------- -The below documentation is the same as what's found in -linkgit:git-config[1]: +include::includes/cmd-config-section-all.txt[] include::config/gc.txt[] diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt index 63cf498ce9f..f7b18515141 100644 --- a/Documentation/git-imap-send.txt +++ b/Documentation/git-imap-send.txt @@ -54,6 +54,8 @@ CONFIGURATION To use the tool, `imap.folder` and either `imap.tunnel` or `imap.host` must be set to appropriate values. +include::includes/cmd-config-section-rest.txt[] + include::config/imap.txt[] EXAMPLES diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt index 3125473cc1d..6e5db8ef4c5 100644 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt @@ -386,13 +386,16 @@ include::merge-strategies.txt[] CONFIGURATION ------------- -include::config/merge.txt[] branch..mergeOptions:: Sets default options for merging into branch . The syntax and supported options are the same as those of 'git merge', but option values containing whitespace characters are currently not supported. +include::includes/cmd-config-section-rest.txt[] + +include::config/merge.txt[] + SEE ALSO -------- linkgit:git-fmt-merge-msg[1], linkgit:git-pull[1], diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt index f784027bc13..c44e205629b 100644 --- a/Documentation/git-mergetool.txt +++ b/Documentation/git-mergetool.txt @@ -102,6 +102,9 @@ success of the resolution after the custom tool has exited. CONFIGURATION ------------- :git-mergetool: 1 + +include::includes/cmd-config-section-all.txt[] + include::config/mergetool.txt[] TEMPORARY FILES diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index a872ab0fbd1..d9b6af8a571 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -1252,6 +1252,8 @@ merge cmake CONFIGURATION ------------- +include::includes/cmd-config-section-all.txt[] + include::config/rebase.txt[] include::config/sequencer.txt[] diff --git a/Documentation/includes/cmd-config-section-all.txt b/Documentation/includes/cmd-config-section-all.txt new file mode 100644 index 00000000000..296a239f2ab --- /dev/null +++ b/Documentation/includes/cmd-config-section-all.txt @@ -0,0 +1,3 @@ +Everything below this line in this section is selectively included +from the linkgit:git-config[1] documentation. The content is the same +as what's found there: diff --git a/Documentation/includes/cmd-config-section-rest.txt b/Documentation/includes/cmd-config-section-rest.txt new file mode 100644 index 00000000000..fe4721dac76 --- /dev/null +++ b/Documentation/includes/cmd-config-section-rest.txt @@ -0,0 +1,3 @@ +The discussion above this line is unique to this documentation, but +everything below is included from section(s) in linkgit:git-config[1] +aplicable to this command: From patchwork Fri Jul 29 08:25:48 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 12932118 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 671E1C00144 for ; Fri, 29 Jul 2022 08:26:41 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234497AbiG2I0k (ORCPT ); Fri, 29 Jul 2022 04:26:40 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33654 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234937AbiG2I0C (ORCPT ); Fri, 29 Jul 2022 04:26:02 -0400 Received: from mail-wr1-x42c.google.com (mail-wr1-x42c.google.com [IPv6:2a00:1450:4864:20::42c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AE261286D5 for ; Fri, 29 Jul 2022 01:26:01 -0700 (PDT) Received: by mail-wr1-x42c.google.com with SMTP id v17so5083596wrr.10 for ; Fri, 29 Jul 2022 01:26:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc; bh=tCNM3NEMNbmGhKLDz6qswddj8boGkYGXHPE+yJJCXn4=; b=XqSXbAEUu1aJtn+4w/0uQQOLlwWiHEl74sbA/bptFu6zN/ebO7sYHU5UnQD8sGKyyU +HX+NxduFnuJ8I+fXaxHcbS1zJR8W4jsISaW/Q8OY84cXHmzEwE4nguAVG/cDuhrUSa0 w89bYSEMIXveOAO7hzX2K6m/1f9IU0wvcIiC5Zv33Y4lfdoUOri46JiaHHB0SJhPZcB8 z8rJd3chKa2Ywu9c72qQJSLFMM0Mwy7zWOZoQVQQyrrJ8W/B2wLdx/Cqe242drE2MD87 e3LIDYk58aHXiAzJLwr/9vYVIz/KQC0cDW47QbAUSGRgf0yPiwViBR4cP6unZO6NTLAy l6NQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc; bh=tCNM3NEMNbmGhKLDz6qswddj8boGkYGXHPE+yJJCXn4=; b=daeA4YPafX/h9myKxDoYTuDmtuZzqf/YZE6720Ooj53bPD/1J7Lf7eFlmRoaCMyuKt 1nhJ9+XbysNlRionMUkQf0BmkpT++bjfBCZ0l38INGkVx6XyN8IloBXwYSDAWNuAisrv YXXH1OWyIDmvtzWaD6CTA4lMcF0Ch3TFjMZ2v1NsS0hkutcyK3VEdMyzn/Gueg8toy4C 9x4h5B5H/t05baOaJ4dKHbgOLsat0HHKdcFFj/07jSraMaJnJJfJk6JmuesOS2MhMkEJ 1lwER+CTlhldIITyglhvjCjN38TD2LLKkjseA4UJ7EKUVW4aINnoiioTKXIX8mukbAvZ TAtQ== X-Gm-Message-State: ACgBeo3+mGUQVf/NdA4uG/hDqxi7KoQgHYpRaj9279At90q/LZ4mqkPa ejrnPxpT4jSB3vSCPLeudm5vQhskuuEoUQ== X-Google-Smtp-Source: AA6agR7kHb5UxlfHcJXNLhYXePZrxSEM+anr4HWIqs+PMgI+NLpnszUYkh6Op2yM2D9gB5/kLXF2YQ== X-Received: by 2002:a5d:6483:0:b0:21e:999c:e1ca with SMTP id o3-20020a5d6483000000b0021e999ce1camr1593490wri.640.1659083159396; Fri, 29 Jul 2022 01:25:59 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id m20-20020a056000181400b0021e571a99d5sm2994802wrh.17.2022.07.29.01.25.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Jul 2022 01:25:58 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , Matheus Tavares , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v2 2/9] grep docs: de-duplicate configuration sections Date: Fri, 29 Jul 2022 10:25:48 +0200 Message-Id: X-Mailer: git-send-email 2.37.1.1196.g8af3636bc64 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Include the "config/grep.txt" file in "git-grep.txt", instead of repeating an almost identical description of the "grep" configuration variables in two places. There is no loss of information here that isn't shown in the addition to "grep.txt". This change was made by copying the contents of "git-grep.txt"'s version over the "grep.txt" version. Aside from the change "grep.txt" being made here the two were identical. This documentation started being copy/pasted around in b22520a37c8 (grep: allow -E and -n to be turned on by default via configuration, 2011-03-30). After that in e.g. 6453f7b3486 (grep: add grep.fullName config variable, 2014-03-17) they started drifting apart, with only grep.fullName being described in the command documentation. In 434e6e753fe (config.txt: move grep.* to a separate file, 2018-10-27) we gained the include, but didn't do this next step, let's do it now. Signed-off-by: Ævar Arnfjörð Bjarmason --- Documentation/config/grep.txt | 7 +++++-- Documentation/git-grep.txt | 29 ++--------------------------- 2 files changed, 7 insertions(+), 29 deletions(-) diff --git a/Documentation/config/grep.txt b/Documentation/config/grep.txt index 182edd813a5..e521f20390c 100644 --- a/Documentation/config/grep.txt +++ b/Documentation/config/grep.txt @@ -17,8 +17,11 @@ grep.extendedRegexp:: other than 'default'. grep.threads:: - Number of grep worker threads to use. - See `grep.threads` in linkgit:git-grep[1] for more information. + Number of grep worker threads to use. If unset (or set to 0), Git will + use as many threads as the number of logical cores available. + +grep.fullName:: + If set to true, enable `--full-name` option by default. grep.fallbackToNoIndex:: If set to true, fall back to git grep --no-index if git grep diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index 58d944bd578..dabdbe8471d 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -343,34 +343,9 @@ performance in this case, it might be desirable to use `--threads=1`. CONFIGURATION ------------- -grep.lineNumber:: - If set to true, enable `-n` option by default. - -grep.column:: - If set to true, enable the `--column` option by default. - -grep.patternType:: - Set the default matching behavior. Using a value of 'basic', 'extended', - 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`, - `--fixed-strings`, or `--perl-regexp` option accordingly, while the - value 'default' will return to the default matching behavior. - -grep.extendedRegexp:: - If set to true, enable `--extended-regexp` option by default. This - option is ignored when the `grep.patternType` option is set to a value - other than 'default'. - -grep.threads:: - Number of grep worker threads to use. If unset (or set to 0), Git will - use as many threads as the number of logical cores available. - -grep.fullName:: - If set to true, enable `--full-name` option by default. - -grep.fallbackToNoIndex:: - If set to true, fall back to git grep --no-index if git grep - is executed outside of a git repository. Defaults to false. +include::includes/cmd-config-section-all.txt[] +include::config/grep.txt[] GIT --- From patchwork Fri Jul 29 08:25:49 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 12932119 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id BE1B1C19F2B for ; Fri, 29 Jul 2022 08:26:42 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234893AbiG2I0l (ORCPT ); Fri, 29 Jul 2022 04:26:41 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33656 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235032AbiG2I0D (ORCPT ); Fri, 29 Jul 2022 04:26:03 -0400 Received: from mail-wr1-x42f.google.com (mail-wr1-x42f.google.com [IPv6:2a00:1450:4864:20::42f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4D78A28706 for ; Fri, 29 Jul 2022 01:26:02 -0700 (PDT) Received: by mail-wr1-x42f.google.com with SMTP id z17so384703wrq.4 for ; Fri, 29 Jul 2022 01:26:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc; bh=zbFs3FJw0bJFugD2PGTwrl3XgxCLDktr96Q38Ui9pbg=; b=Q9aAdu3klsXH/UaTU908Sescl6aKy4G4x/1xt/w8jW8y3lQMxKnJMVTzTjDYWzbNui Zm6G2SFNEOODOHCMSyv5cEgH399jJzZYycNngg+zx0NSiXbXbs0PFd3Y9DWzPC8XFo7U kDGnJ/8sfy0OAwK6gwLbacGQQhN8Ua92zpR4D3CS8qJd4vHvf3NDgP2MxaNdBd63usKn oA/u3BBSPft4JUr00E4tBwUcfYZPYsp8qEb2IMS3wcza6Zli1mbjPSUIQJfTRovgExLo N5P9eAwY9T37A+U3eGF1UFByMMThvjDIujVPCqueAVl/PjRptDhMcVvnDFIc10PuRkQT wEAA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc; bh=zbFs3FJw0bJFugD2PGTwrl3XgxCLDktr96Q38Ui9pbg=; b=KQHhVTsdmNQEmNewUN1ICV5dqLZJmUl0SOM+e9QWTibdkJAULCe7H9RkXdu4EodDmg rQV5MQA9NX0EGErs1P49NiDuun36X3l+bBG2DClek8SRQtNe65D54gTfE4ZLGEfuY4Ij 7u5eZuHMK6TPu0N5UdDYXQgs55LqnkNXRDGohmYxiugPHlMaofmix8AOShZMbfgdKs1A nQNQVx2jp27Ayr6/LislB+lfjH1j0C6D6I/WAvAfipi+w9D6j7XhSoHko9qUC0S/AeDE VVUZydPrE8qq22OJxZqYAp8rYyxK0MxX9t8X4Dw3nwarrRjvzC1l0nzvlTNbyboTfpIP QC2w== X-Gm-Message-State: ACgBeo0jIMOwgTja5pVJ2lr9X0hI/0sOKJOxBh1jr1Ur+Kv9Qi4PGxlZ 8WQ9NO/UjZqb4bz3GLmxoxJBR6b4I8e83A== X-Google-Smtp-Source: AA6agR5/8lS6DC/gqFRbO4KR3tAFkXhxIHK59v7txs/5dfBKi6EmeNJp/o70A2xVWu4XLYxuFUegxQ== X-Received: by 2002:adf:fbc3:0:b0:21e:3c88:2aa1 with SMTP id d3-20020adffbc3000000b0021e3c882aa1mr1685159wrs.84.1659083160159; Fri, 29 Jul 2022 01:26:00 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id m20-20020a056000181400b0021e571a99d5sm2994802wrh.17.2022.07.29.01.25.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Jul 2022 01:25:59 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , Matheus Tavares , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v2 3/9] send-email docs: de-duplicate configuration sections Date: Fri, 29 Jul 2022 10:25:49 +0200 Message-Id: X-Mailer: git-send-email 2.37.1.1196.g8af3636bc64 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org De-duplicate the discussion of "send-email" configuration, such that the "git-config(1)" manual page becomes the source of truth, and "git-send-email(1)" includes the relevant part. Most commands that suffered from such duplication had diverging text discussing the same variables, but in this case some config was also only discussed in one or the other. This is mostly a move-only change, the exception is a minor rewording of changing wording like "see above" to "see linkgit:git-config[1]", as well as a clarification about the big section of command-line option tweaking config being discussed in git-send-email(1)'s main docs. Signed-off-by: Ævar Arnfjörð Bjarmason --- Documentation/config/sendemail.txt | 40 +++++++++++++++++++++++++++--- Documentation/git-send-email.txt | 36 ++------------------------- 2 files changed, 39 insertions(+), 37 deletions(-) diff --git a/Documentation/config/sendemail.txt b/Documentation/config/sendemail.txt index 50baa5d6bfb..51da7088a84 100644 --- a/Documentation/config/sendemail.txt +++ b/Documentation/config/sendemail.txt @@ -18,17 +18,49 @@ sendemail..*:: identity is selected, through either the command-line or `sendemail.identity`. +sendemail.multiEdit:: + If true (default), a single editor instance will be spawned to edit + files you have to edit (patches when `--annotate` is used, and the + summary when `--compose` is used). If false, files will be edited one + after the other, spawning a new editor each time. + +sendemail.confirm:: + Sets the default for whether to confirm before sending. Must be + one of 'always', 'never', 'cc', 'compose', or 'auto'. See `--confirm` + in the linkgit:git-send-email[1] documentation for the meaning of these + values. + sendemail.aliasesFile:: + To avoid typing long email addresses, point this to one or more + email aliases files. You must also supply `sendemail.aliasFileType`. + sendemail.aliasFileType:: + Format of the file(s) specified in sendemail.aliasesFile. Must be + one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus', or 'sendmail'. ++ +What an alias file in each format looks like can be found in +the documentation of the email program of the same name. The +differences and limitations from the standard formats are +described below: ++ +-- +sendmail;; +* Quoted aliases and quoted addresses are not supported: lines that + contain a `"` symbol are ignored. +* Redirection to a file (`/path/name`) or pipe (`|command`) is not + supported. +* File inclusion (`:include: /path/name`) is not supported. +* Warnings are printed on the standard error output for any + explicitly unsupported constructs, and any other lines that are not + recognized by the parser. +-- sendemail.annotate:: sendemail.bcc:: sendemail.cc:: sendemail.ccCmd:: sendemail.chainReplyTo:: -sendemail.confirm:: sendemail.envelopeSender:: sendemail.from:: -sendemail.multiEdit:: sendemail.signedoffbycc:: sendemail.smtpPass:: sendemail.suppresscc:: @@ -44,7 +76,9 @@ sendemail.thread:: sendemail.transferEncoding:: sendemail.validate:: sendemail.xmailer:: - See linkgit:git-send-email[1] for description. + These configuration variables all provide a default for + linkgit:git-send-email[1] command-line options. See its + documentation for details. sendemail.signedoffcc (deprecated):: Deprecated alias for `sendemail.signedoffbycc`. diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt index 41cd8cb4247..3290043053a 100644 --- a/Documentation/git-send-email.txt +++ b/Documentation/git-send-email.txt @@ -456,41 +456,9 @@ Information CONFIGURATION ------------- -sendemail.aliasesFile:: - To avoid typing long email addresses, point this to one or more - email aliases files. You must also supply `sendemail.aliasFileType`. +include::includes/cmd-config-section-all.txt[] -sendemail.aliasFileType:: - Format of the file(s) specified in sendemail.aliasesFile. Must be - one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus', or 'sendmail'. -+ -What an alias file in each format looks like can be found in -the documentation of the email program of the same name. The -differences and limitations from the standard formats are -described below: -+ --- -sendmail;; -* Quoted aliases and quoted addresses are not supported: lines that - contain a `"` symbol are ignored. -* Redirection to a file (`/path/name`) or pipe (`|command`) is not - supported. -* File inclusion (`:include: /path/name`) is not supported. -* Warnings are printed on the standard error output for any - explicitly unsupported constructs, and any other lines that are not - recognized by the parser. --- - -sendemail.multiEdit:: - If true (default), a single editor instance will be spawned to edit - files you have to edit (patches when `--annotate` is used, and the - summary when `--compose` is used). If false, files will be edited one - after the other, spawning a new editor each time. - -sendemail.confirm:: - Sets the default for whether to confirm before sending. Must be - one of 'always', 'never', 'cc', 'compose', or 'auto'. See `--confirm` - in the previous section for the meaning of these values. +include::config/sendemail.txt[] EXAMPLES -------- From patchwork Fri Jul 29 08:25:50 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 12932122 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2E5B3C00144 for ; Fri, 29 Jul 2022 08:26:50 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235298AbiG2I0s (ORCPT ); Fri, 29 Jul 2022 04:26:48 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60054 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235099AbiG2I0H (ORCPT ); Fri, 29 Jul 2022 04:26:07 -0400 Received: from mail-wr1-x433.google.com (mail-wr1-x433.google.com [IPv6:2a00:1450:4864:20::433]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 00D2228712 for ; Fri, 29 Jul 2022 01:26:03 -0700 (PDT) Received: by mail-wr1-x433.google.com with SMTP id k8so2933271wrd.5 for ; Fri, 29 Jul 2022 01:26:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc; bh=wWZeOr+kJ23glTg/NpMT9QYRUyRn3ILzuF/LeSnGAF8=; b=B1q9NTwEo0k7JwcAn1EWCXxMkoY0mycrf6uzrlIqOGF+qH8W2GdWAfsX3ul30CfI81 NLVAmqKwRrE+rFjpz8HBUizsusHojND8WP46g2CHoJs0VXlSTk1mghn/Fnqi2yV5MStw slGF5VONmwDCDmETHot1V5iNeMF6EWP2RK+Ubti4yI7TSL83sjqRd4byrDJoq6EetVHV FP6bqR/RdajVqp6+AY+4oG6evwXEkTMECa0oPm58LQlfoDz7Byh9loRBVHTbCvcrcAgd nY/eDuJMXcfnArzXx1VC39INyxZ1ReQl8za+3qIdH13sXIqmltN6Ms39Rki/HcZZif28 +tCg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc; bh=wWZeOr+kJ23glTg/NpMT9QYRUyRn3ILzuF/LeSnGAF8=; b=xIr9Xf7ZicPyMZLGmpms3Cf9/rV2WtEEUbDfgp6F4udEO0gYRysYpkBqh1WehwGupZ Sln0IeXpRojUOx0whmUFT4/HjlPhPmACuPlX1lcoIGaB5Gl5hnqS6CM+4kP1Mj62X/la 2/1ZZkUnUHLU0Vq/6ELM5XzphMy42x63aCc8Q8vU3T8yLO9+Z0RrjqS2pbuyhWAYhmin X19uCX3kXZEaDfqJXcaEqGhjP8bVLXp1LrJfT6aI9r8bd0xbo0MZVID00MfsP2CSZGmO oygJ3vx6D0hUB9yABkHOcaU2FYynx52eJxkufj5D0qLQwZ6R4IWpsEdUAnNRO8rUr9m3 w4+A== X-Gm-Message-State: ACgBeo0BvA+++pQgJmn5aO3Ip8pibddnQU5HZGwwJlM7OVurlcLXLQHd uuUBjEguGvFAQk3w434RxTqq6Fs3Ou0W1Q== X-Google-Smtp-Source: AA6agR6vur5+vjbr3mv+vqMPP/oAm3oWD+nZXAEILIRlH4w15UasxtL8mHQPEdOVINnX1qbzM5qhBg== X-Received: by 2002:a5d:47a8:0:b0:21d:b690:9273 with SMTP id 8-20020a5d47a8000000b0021db6909273mr1533161wrb.242.1659083160910; Fri, 29 Jul 2022 01:26:00 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id m20-20020a056000181400b0021e571a99d5sm2994802wrh.17.2022.07.29.01.26.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Jul 2022 01:26:00 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , Matheus Tavares , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v2 4/9] apply docs: de-duplicate configuration sections Date: Fri, 29 Jul 2022 10:25:50 +0200 Message-Id: X-Mailer: git-send-email 2.37.1.1196.g8af3636bc64 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The wording is not identical to Documentation/config/apply.txt, but that version is better. Signed-off-by: Ævar Arnfjörð Bjarmason --- Documentation/git-apply.txt | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index b6d77f42068..1d478cbe9b5 100644 --- a/Documentation/git-apply.txt +++ b/Documentation/git-apply.txt @@ -263,13 +263,9 @@ has no effect when `--index` or `--cached` is in use. CONFIGURATION ------------- -apply.ignoreWhitespace:: - Set to 'change' if you want changes in whitespace to be ignored by default. - Set to one of: no, none, never, false if you want changes in - whitespace to be significant. -apply.whitespace:: - When no `--whitespace` flag is given from the command - line, this configuration item is used as the default. +include::includes/cmd-config-section-all.txt[] + +include::config/apply.txt[] SUBMODULES ---------- From patchwork Fri Jul 29 08:25:51 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 12932120 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id F3D9CC00144 for ; Fri, 29 Jul 2022 08:26:45 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235334AbiG2I0n (ORCPT ); Fri, 29 Jul 2022 04:26:43 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33696 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235111AbiG2I0H (ORCPT ); Fri, 29 Jul 2022 04:26:07 -0400 Received: from mail-wr1-x436.google.com (mail-wr1-x436.google.com [IPv6:2a00:1450:4864:20::436]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6D5E028E0B for ; Fri, 29 Jul 2022 01:26:03 -0700 (PDT) Received: by mail-wr1-x436.google.com with SMTP id v3so4160863wrp.0 for ; Fri, 29 Jul 2022 01:26:03 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc; bh=OwCqEtJUbQdMLUNoRKkvdjqkx6eWPz1KROX8PpUN0zQ=; b=qfpugIKZiayJWzNtHwRXP8AjyY2KSvdCuh2Ec12DPh3BNtzb98eONNxecZyHTxfWMb pvZj2J8SyzwMksNOZXRbg+Ij1lxgWFdr5POEL88B8Z+hsF94w6Ha35Ju4CktHYuN+B3D rRcgCjbLqoL6In0pDHcG6a9kYmAJDoRyPXy9zRbsNpmNItgK3K9nO+JsDCnZT2ihwl9b m29oX/U++/O7U1i31jhYiSLGhznUtKmb3Ff2JG2e8DS7DdsA3qRaQRtsEaeEakOISNBS XEoplk6UQJISBL01UFSmzfPRdzJI3eIdf/UtgU2X7BlB/bPyrb+On+YmS1eJmeO/ljBk 7jZw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc; bh=OwCqEtJUbQdMLUNoRKkvdjqkx6eWPz1KROX8PpUN0zQ=; b=0zA+PzWedj3GS+UkOFHvnZfU7ZYU4sJ3PcuNmQ+vwE3fCZAfTu+H0UMBeOunKlX3ih B+RkBduQBBxsT15iz6oGFYuergN6nZkDQ5ac8KTwUpRPvYnelm0N1jvwxtkc1jeBpFwi Z1hA+j8rpjo3ohWBSMScVmN56x6EEjYaYE/Srsj/NyGOf6EAK4KZzK5jfVUCBVZrrzm8 XhOMctRYZo2QQtHGwNebod8yJy7cS1r71gVbYgtnmOKUkOl4AlepmKOqaHA1KByvGr4J QCFj34moBQiRHKQVYYDOFRPBQIPdE8uTzFkUhLz6f3DsrbiLFCkZ26JDE8MkyCXEWjpe wb/w== X-Gm-Message-State: ACgBeo1auNxT+vWVRlMSHGCurtKQ0xECc7S0HOqejyRUp8j+usfxL8TA JJRTKaRMnQXvO9Zqe2RuKS3wYbNkEmy/9g== X-Google-Smtp-Source: AA6agR4wNWus7ujRhayAKS+R+6i3u2bnAfRe497mPGb1QP7rhyhNqqShjND7/FF954XQZ9jOCh7tTw== X-Received: by 2002:a5d:6c6f:0:b0:21d:cb1b:5776 with SMTP id r15-20020a5d6c6f000000b0021dcb1b5776mr1604008wrz.44.1659083161586; Fri, 29 Jul 2022 01:26:01 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id m20-20020a056000181400b0021e571a99d5sm2994802wrh.17.2022.07.29.01.26.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Jul 2022 01:26:01 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , Matheus Tavares , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v2 5/9] notes docs: de-duplicate configuration sections Date: Fri, 29 Jul 2022 10:25:51 +0200 Message-Id: X-Mailer: git-send-email 2.37.1.1196.g8af3636bc64 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Let's also fix the "git-notes(1)" docs so that we link to "git-config(1)", not "git-log(1)" as a reference for the "notes" docs. Signed-off-by: Ævar Arnfjörð Bjarmason --- Documentation/config/notes.txt | 43 ++++++++++++++++----------- Documentation/git-log.txt | 16 ++-------- Documentation/git-notes.txt | 54 ++-------------------------------- 3 files changed, 32 insertions(+), 81 deletions(-) diff --git a/Documentation/config/notes.txt b/Documentation/config/notes.txt index aeef56d49ae..c7c4811734b 100644 --- a/Documentation/config/notes.txt +++ b/Documentation/config/notes.txt @@ -3,6 +3,9 @@ notes.mergeStrategy:: conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES" section of linkgit:git-notes[1] for more information on each strategy. ++ +This setting can be overridden by passing the `--strategy` option to +linkgit:git-notes[1]. notes..mergeStrategy:: Which merge strategy to choose when doing a notes merge into @@ -11,28 +14,35 @@ notes..mergeStrategy:: linkgit:git-notes[1] for more information on the available strategies. notes.displayRef:: - The (fully qualified) refname from which to show notes when - showing commit messages. The value of this variable can be set - to a glob, in which case notes from all matching refs will be - shown. You may also specify this configuration variable - several times. A warning will be issued for refs that do not - exist, but a glob that does not match any refs is silently - ignored. + Which ref (or refs, if a glob or specified more than once), in + addition to the default set by `core.notesRef` or + `GIT_NOTES_REF`, to read notes from when showing commit + messages with the 'git log' family of commands. + This setting can be overridden with the `GIT_NOTES_DISPLAY_REF` environment variable, which must be a colon separated list of refs or globs. + +A warning will be issued for refs that do not exist, +but a glob that does not match any refs is silently ignored. ++ +This setting can be disabled by the `--no-notes` option to the 'git +log' family of commands, or by the `--notes=` option accepted by +those commands. ++ The effective value of "core.notesRef" (possibly overridden by GIT_NOTES_REF) is also implicitly added to the list of refs to be displayed. notes.rewrite.:: When rewriting commits with (currently `amend` or - `rebase`) and this variable is set to `true`, Git - automatically copies your notes from the original to the - rewritten commit. Defaults to `true`, but see - "notes.rewriteRef" below. + `rebase`), if this variable is `false`, git will not copy + notes from the original to the rewritten commit. Defaults to + `true`. See also "`notes.rewriteRef`" below. ++ +This setting can be overridden with the `GIT_NOTES_REWRITE_REF` +environment variable, which must be a colon separated list of refs or +globs. notes.rewriteMode:: When copying notes during a rewrite (see the @@ -46,14 +56,13 @@ environment variable. notes.rewriteRef:: When copying notes during a rewrite, specifies the (fully - qualified) ref whose notes should be copied. The ref may be a - glob, in which case notes in all matching refs will be copied. - You may also specify this configuration several times. + qualified) ref whose notes should be copied. May be a glob, + in which case notes in all matching refs will be copied. You + may also specify this configuration several times. + Does not have a default value; you must configure this variable to enable note rewriting. Set it to `refs/notes/commits` to enable rewriting for the default commit notes. + -This setting can be overridden with the `GIT_NOTES_REWRITE_REF` -environment variable, which must be a colon separated list of refs or -globs. +Can be overridden with the `GIT_NOTES_REWRITE_REF` environment variable. +See `notes.rewrite.` above for a further description of its format. diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt index 20e87cecf49..ed802bb8e12 100644 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@ -227,19 +227,9 @@ log.showSignature:: mailmap.*:: See linkgit:git-shortlog[1]. -notes.displayRef:: - Which refs, in addition to the default set by `core.notesRef` - or `GIT_NOTES_REF`, to read notes from when showing commit - messages with the `log` family of commands. See - linkgit:git-notes[1]. -+ -May be an unabbreviated ref name or a glob and may be specified -multiple times. A warning will be issued for refs that do not exist, -but a glob that does not match any refs is silently ignored. -+ -This setting can be disabled by the `--no-notes` option, -overridden by the `GIT_NOTES_DISPLAY_REF` environment variable, -and overridden by the `--notes=` option. +include::includes/cmd-config-section-rest.txt[] + +include::config/notes.txt[] GIT --- diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt index 0a4200674c4..68d547e2474 100644 --- a/Documentation/git-notes.txt +++ b/Documentation/git-notes.txt @@ -44,7 +44,7 @@ using the `--notes` option. Such notes are added as a patch commentary after a three dash separator line. To change which notes are shown by 'git log', see the -"notes.displayRef" configuration in linkgit:git-log[1]. +"notes.displayRef" configuration in linkgit:git-config[1]. See the "notes.rewrite." configuration for a way to carry notes across commands that rewrite commits. @@ -316,57 +316,9 @@ core.notesRef:: This setting can be overridden through the environment and command line. -notes.mergeStrategy:: - Which merge strategy to choose by default when resolving notes - conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or - `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES" - section above for more information on each strategy. -+ -This setting can be overridden by passing the `--strategy` option. - -notes..mergeStrategy:: - Which merge strategy to choose when doing a notes merge into - refs/notes/. This overrides the more general - "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section above - for more information on each available strategy. - -notes.displayRef:: - Which ref (or refs, if a glob or specified more than once), in - addition to the default set by `core.notesRef` or - `GIT_NOTES_REF`, to read notes from when showing commit - messages with the 'git log' family of commands. - This setting can be overridden on the command line or by the - `GIT_NOTES_DISPLAY_REF` environment variable. - See linkgit:git-log[1]. - -notes.rewrite.:: - When rewriting commits with (currently `amend` or - `rebase`), if this variable is `false`, git will not copy - notes from the original to the rewritten commit. Defaults to - `true`. See also "`notes.rewriteRef`" below. -+ -This setting can be overridden by the `GIT_NOTES_REWRITE_REF` -environment variable. +include::includes/cmd-config-section-rest.txt[] -notes.rewriteMode:: - When copying notes during a rewrite, what to do if the target - commit already has a note. Must be one of `overwrite`, - `concatenate`, `cat_sort_uniq`, or `ignore`. Defaults to - `concatenate`. -+ -This setting can be overridden with the `GIT_NOTES_REWRITE_MODE` -environment variable. - -notes.rewriteRef:: - When copying notes during a rewrite, specifies the (fully - qualified) ref whose notes should be copied. May be a glob, - in which case notes in all matching refs will be copied. You - may also specify this configuration several times. -+ -Does not have a default value; you must configure this variable to -enable note rewriting. -+ -Can be overridden with the `GIT_NOTES_REWRITE_REF` environment variable. +include::config/notes.txt[] ENVIRONMENT From patchwork Fri Jul 29 08:25:52 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 12932121 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id CA23DC04A68 for ; Fri, 29 Jul 2022 08:26:47 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235383AbiG2I0q (ORCPT ); Fri, 29 Jul 2022 04:26:46 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60108 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235072AbiG2I0H (ORCPT ); Fri, 29 Jul 2022 04:26:07 -0400 Received: from mail-wr1-x434.google.com (mail-wr1-x434.google.com [IPv6:2a00:1450:4864:20::434]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id CCDE628E2B for ; Fri, 29 Jul 2022 01:26:04 -0700 (PDT) Received: by mail-wr1-x434.google.com with SMTP id p10so891903wru.8 for ; Fri, 29 Jul 2022 01:26:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc; bh=iGWn60Jo1hdccX/ALML2Yb+t40t05WarPvwfQ+VcFbM=; b=ZviWuWnPSOXBZD5CfHyRrzydd2u94TgRK2/VYMKpCh4sKI+rZ9/6xyOY0nHOKUDhfD xJYCaV6UZ7wuzYovl+lSaSgG2zmv3PHOKhJEszBGh8R0WeMeht5Mn+QCbWBiRxhnjQJq ysMRfVfp+kNXPuL/1IsUVy5avlksSUQD9tfSzK1hTl16gfG1ilzdvg2SZz1ZP9hcRcYH ObKj/dzGru3SX0fFOd4/GEdLGeyWAF66bXXwjeW9Dl7hSxJPTGfE4HUhekpPecO06FcG fvu16r3TIrsMBItAb7/MCWsp4VWuNzHm6He8HqbflPenxYPlD+iOvYW790tnFBuZNgPK jS2Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc; bh=iGWn60Jo1hdccX/ALML2Yb+t40t05WarPvwfQ+VcFbM=; b=NsXpEL0GZlk7eghCWfl5tLmpgCpvESiQISBfxpfD93IaceU4eeddTOJiFB1L9ZRZr8 SGj57K+6gvlhfA+WGPyQTkobjRU5+WqORwOJbWbucyXCJdbbL2fbpLFmBim4qx4Q0WaI q9iUr0hjpeJCiVWcwFGDfIgHoiZGlPI3JdUlj+Dg3TfI0dYwkn8h3x5ZqMfQTiOcCa89 dQoxANf+yDlfJk0s9iLXj8HcBe++9HQBufB2UG5KGDf24Wmfwhfox7vldBInbER7OmUK C+tFGzuCtOdj12aU9K3tgkQm2UMGZ5UnoKedBBP+S2TPsgTXq7pQhg7fT7BnMgeIrXg3 sDOw== X-Gm-Message-State: ACgBeo1b69XizaE3wYqe1lyzBByclMnzp9d5WUyfDOb8F7q+S+9G3ENY jltN9fVeR58PgQYQwGtu9QQwjwusKM9nTg== X-Google-Smtp-Source: AA6agR6M4a7GWiZenBDyZ6YO6HnBuJgYqQ8YkwKRj6ZwduA/+pH3vzR0VKaB/UXt24XjlaEmOemHaw== X-Received: by 2002:adf:ee8f:0:b0:21e:529e:fa3b with SMTP id b15-20020adfee8f000000b0021e529efa3bmr1621224wro.207.1659083162722; Fri, 29 Jul 2022 01:26:02 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id m20-20020a056000181400b0021e571a99d5sm2994802wrh.17.2022.07.29.01.26.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Jul 2022 01:26:01 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , Matheus Tavares , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v2 6/9] difftool docs: de-duplicate configuration sections Date: Fri, 29 Jul 2022 10:25:52 +0200 Message-Id: X-Mailer: git-send-email 2.37.1.1196.g8af3636bc64 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Include the "config/difftool.txt" file in "git-difftool.txt", and move the relevant part of git-difftool(1) configuration from "config/diff.txt" to config/difftool.txt". Doing this is slightly odd, as we usually discuss configuration in alphabetical order, but by doing it we're able to include the full set of configuration used by git-difftool(1) (and only that configuration) in its own documentation. Signed-off-by: Ævar Arnfjörð Bjarmason --- Documentation/config/diff.txt | 15 --------------- Documentation/config/difftool.txt | 28 +++++++++++++++++++++++++--- Documentation/git-difftool.txt | 27 ++++----------------------- 3 files changed, 29 insertions(+), 41 deletions(-) diff --git a/Documentation/config/diff.txt b/Documentation/config/diff.txt index 32f84838ac1..35a7bf86d77 100644 --- a/Documentation/config/diff.txt +++ b/Documentation/config/diff.txt @@ -178,21 +178,6 @@ diff..cachetextconv:: Set this option to true to make the diff driver cache the text conversion outputs. See linkgit:gitattributes[5] for details. -diff.tool:: - Controls which diff tool is used by linkgit:git-difftool[1]. - This variable overrides the value configured in `merge.tool`. - The list below shows the valid built-in values. - Any other value is treated as a custom diff tool and requires - that a corresponding difftool..cmd variable is defined. - -diff.guitool:: - Controls which diff tool is used by linkgit:git-difftool[1] when - the -g/--gui flag is specified. This variable overrides the value - configured in `merge.guitool`. The list below shows the valid - built-in values. Any other value is treated as a custom diff tool - and requires that a corresponding difftool..cmd variable - is defined. - include::../mergetools-diff.txt[] diff.indentHeuristic:: diff --git a/Documentation/config/difftool.txt b/Documentation/config/difftool.txt index 67625944804..a3f82112102 100644 --- a/Documentation/config/difftool.txt +++ b/Documentation/config/difftool.txt @@ -1,6 +1,17 @@ -difftool..path:: - Override the path for the given tool. This is useful in case - your tool is not in the PATH. +diff.tool:: + Controls which diff tool is used by linkgit:git-difftool[1]. + This variable overrides the value configured in `merge.tool`. + The list below shows the valid built-in values. + Any other value is treated as a custom diff tool and requires + that a corresponding difftool..cmd variable is defined. + +diff.guitool:: + Controls which diff tool is used by linkgit:git-difftool[1] when + the -g/--gui flag is specified. This variable overrides the value + configured in `merge.guitool`. The list below shows the valid + built-in values. Any other value is treated as a custom diff tool + and requires that a corresponding difftool..cmd variable + is defined. difftool..cmd:: Specify the command to invoke the specified diff tool. @@ -9,6 +20,17 @@ difftool..cmd:: file containing the contents of the diff pre-image and 'REMOTE' is set to the name of the temporary file containing the contents of the diff post-image. ++ +See the `--tool=` option in linkgit:git-difftool[1] for more details. + +difftool..path:: + Override the path for the given tool. This is useful in case + your tool is not in the PATH. + +difftool.trustExitCode:: + Exit difftool if the invoked diff tool returns a non-zero exit status. ++ +See the `--trust-exit-code` option in linkgit:git-difftool[1] for more details. difftool.prompt:: Prompt before each invocation of the diff tool. diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt index 143b0c49d73..9d14c3c9f09 100644 --- a/Documentation/git-difftool.txt +++ b/Documentation/git-difftool.txt @@ -113,33 +113,14 @@ instead. `--no-symlinks` is the default on Windows. See linkgit:git-diff[1] for the full list of supported options. -CONFIG VARIABLES ----------------- +CONFIGURATION +------------- 'git difftool' falls back to 'git mergetool' config variables when the difftool equivalents have not been defined. -diff.tool:: - The default diff tool to use. +include::includes/cmd-config-section-rest.txt[] -diff.guitool:: - The default diff tool to use when `--gui` is specified. - -difftool..path:: - Override the path for the given tool. This is useful in case - your tool is not in the PATH. - -difftool..cmd:: - Specify the command to invoke the specified diff tool. -+ -See the `--tool=` option above for more details. - -difftool.prompt:: - Prompt before each invocation of the diff tool. - -difftool.trustExitCode:: - Exit difftool if the invoked diff tool returns a non-zero exit status. -+ -See the `--trust-exit-code` option above for more details. +include::config/difftool.txt[] SEE ALSO -------- From patchwork Fri Jul 29 08:25:53 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 12932123 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6C37EC00144 for ; Fri, 29 Jul 2022 08:26:52 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235029AbiG2I0v (ORCPT ); Fri, 29 Jul 2022 04:26:51 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33702 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235125AbiG2I0I (ORCPT ); Fri, 29 Jul 2022 04:26:08 -0400 Received: from mail-wr1-x429.google.com (mail-wr1-x429.google.com [IPv6:2a00:1450:4864:20::429]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7F0DE2980A for ; Fri, 29 Jul 2022 01:26:05 -0700 (PDT) Received: by mail-wr1-x429.google.com with SMTP id p10so891928wru.8 for ; Fri, 29 Jul 2022 01:26:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc; bh=WA3CTnIhIwO/ApTR4uUqeq6vPIIaH9HzuC3FpFJFngE=; b=LwhpAq8y1+pQxliPgqiHIhE+nfL/yTwy36Bfcgg5n2YtyALMv/YLoD9Y7WJ7I2yJ6f pBIxv9wKjVS6sGwUGqwJ5ofQECe9IvVQVxzuEuooNeFzQqnB5loojJPAyFcQSFuVwqHl 1nqVaPb4C3IyglbOEHWFe1VW2u+bVB+RDCGCkAYcYWwVzc8N30n+THZJ5R+JH5MhfVXP W/sHUn7OmlYufT3SKYvQk8tXFfDOrQj/CLYHq9MLgk1uh7b5JobozqWJZkZRoExgqGyS T1OH+PHl3S/4xz7rlwsRNVmJ8SRe+5IyG/kyPnRZEvGXRwcGmDVc3xPwUPUQ8QNmbN29 X7Ug== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc; bh=WA3CTnIhIwO/ApTR4uUqeq6vPIIaH9HzuC3FpFJFngE=; b=1H2GJTbCQygh0I17zcJtL8b3LOqJsgu2sEluVKz8VomFEplR6cDe3jdddB5MwnEOTu Mqpm4c+k7cn6GqjbAJou1y8D+bd9Vw/0leohlZeml6yJtLYz/yPIkUmugZOMVNhhYkm8 P3CTNn3/pcWa5JD6kqikvBcqZ5WLcTvYEawICC/Qm/Bu33UqXd2xOXKTwed7bwuW8B8a 0rb2Oz0e3M0wl07Zv1bIOq/hOZdWnfY3/+VQAYrcjK2mDK9ABmNIWBYnlV4Gzx1ecYn7 ocZMIPusE8yHP7f43vbV3FOmZibDhQ0zm7Gya4whTClyesuJLmHlEnuiYG5L99L3nOX6 RhvA== X-Gm-Message-State: ACgBeo2OCHQ8xP5RzxonLmPMYoSzHUlLK26KTfoaBOkZw7oQ9dPZ9nI/ ZIZCCjk+5yZGI9Z4/vaGKFe9fwppe67Esg== X-Google-Smtp-Source: AA6agR5J77A7PMSROvKhCEs9/f8dLnKFRJceOOnC42+/jsvD8y4BciG1xcd3saLCXxVm0s+80aA6zw== X-Received: by 2002:a5d:5a96:0:b0:21e:6120:edeb with SMTP id bp22-20020a5d5a96000000b0021e6120edebmr1568563wrb.121.1659083163432; Fri, 29 Jul 2022 01:26:03 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id m20-20020a056000181400b0021e571a99d5sm2994802wrh.17.2022.07.29.01.26.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Jul 2022 01:26:02 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , Matheus Tavares , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v2 7/9] log docs: de-duplicate configuration sections Date: Fri, 29 Jul 2022 10:25:53 +0200 Message-Id: X-Mailer: git-send-email 2.37.1.1196.g8af3636bc64 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Signed-off-by: Ævar Arnfjörð Bjarmason --- Documentation/config/log.txt | 18 +++++++++++++----- Documentation/git-log.txt | 33 +++++---------------------------- 2 files changed, 18 insertions(+), 33 deletions(-) diff --git a/Documentation/config/log.txt b/Documentation/config/log.txt index 456eb07800c..12ede8e31b8 100644 --- a/Documentation/config/log.txt +++ b/Documentation/config/log.txt @@ -1,12 +1,11 @@ -log.abbrevCommit:: - If true, makes linkgit:git-log[1], linkgit:git-show[1], and - linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may - override this option with `--no-abbrev-commit`. - log.date:: Set the default date-time mode for the 'log' command. Setting a value for log.date is similar to using 'git log''s `--date` option. See linkgit:git-log[1] for details. ++ +If the format is set to "auto:foo" and the pager is in use, format +"foo" will be the used for the date format. Otherwise "default" will +be used. log.decorate:: Print out the ref names of any commits that are shown by the log @@ -45,6 +44,11 @@ log.showRoot:: Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which normally hide the root commit will now show it. True by default. +log.abbrevCommit:: + If true, makes linkgit:git-log[1], linkgit:git-show[1], and + linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may + override this option with `--no-abbrev-commit`. + log.showSignature:: If true, makes linkgit:git-log[1], linkgit:git-show[1], and linkgit:git-whatchanged[1] assume `--show-signature`. @@ -53,3 +57,7 @@ log.mailmap:: If true, makes linkgit:git-log[1], linkgit:git-show[1], and linkgit:git-whatchanged[1] assume `--use-mailmap`, otherwise assume `--no-use-mailmap`. True by default. ++ +The behavior of `log.mailmap` is impacted by the setting of the more +general 'mailmap.*' configuration variables, i.e. `mailmap.file` and +`mailmap.blob`. diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt index ed802bb8e12..69c4e13833d 100644 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@ -42,6 +42,9 @@ OPTIONS shown. The option `--decorate` is short-hand for `--decorate=short`. Default to configuration value of `log.decorate` if configured, otherwise, `auto`. ++ +This output may be colored. See `color.ui` in linkgit:git-config[1] +and `color.decorate` there and in the "CONFIGURATION" section below. --decorate-refs=:: --decorate-refs-exclude=:: @@ -199,36 +202,10 @@ i18n.logOutputEncoding:: Defaults to the value of `i18n.commitEncoding` if set, and UTF-8 otherwise. -log.date:: - Default format for human-readable dates. (Compare the - `--date` option.) Defaults to "default", which means to write - dates like `Sat May 8 19:35:34 2010 -0500`. -+ -If the format is set to "auto:foo" and the pager is in use, format -"foo" will be the used for the date format. Otherwise "default" will -be used. - -log.follow:: - If `true`, `git log` will act as if the `--follow` option was used when - a single is given. This has the same limitations as `--follow`, - i.e. it cannot be used to follow multiple files and does not work well - on non-linear history. - -log.showRoot:: - If `false`, `git log` and related commands will not treat the - initial commit as a big creation event. Any root commits in - `git log -p` output would be shown without a diff attached. - The default is `true`. - -log.showSignature:: - If `true`, `git log` and related commands will act as if the - `--show-signature` option was passed to them. - -mailmap.*:: - See linkgit:git-shortlog[1]. - include::includes/cmd-config-section-rest.txt[] +include::config/log.txt[] + include::config/notes.txt[] GIT From patchwork Fri Jul 29 08:25:54 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 12932124 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id E73C2C19F2B for ; Fri, 29 Jul 2022 08:26:53 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235200AbiG2I0w (ORCPT ); Fri, 29 Jul 2022 04:26:52 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60782 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235153AbiG2I0I (ORCPT ); Fri, 29 Jul 2022 04:26:08 -0400 Received: from mail-wr1-x436.google.com (mail-wr1-x436.google.com [IPv6:2a00:1450:4864:20::436]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id DCFAF29812 for ; Fri, 29 Jul 2022 01:26:05 -0700 (PDT) Received: by mail-wr1-x436.google.com with SMTP id b26so5126528wrc.2 for ; Fri, 29 Jul 2022 01:26:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc; bh=7LImTpMeZre5xONIcSThNBzpaeQWZNQ0EgJusBjmPyY=; b=oxZUr95fbHpr1S6Uma6xHbvklkVERx6Kt2kQwa3Gg+lkJg8lsHushtGn5/ITu1dfon XjB/fwaX37wfCiVtESV/rfvQfYsYjDf6swR3Wa/+A5c6Zp1B4yvOZA87ARLeURDVrzt+ qDy+w32XSYeFLfHwY5Ub+P335QYZCFKZztfXa+jT9rocls0E9QHgXcTYR3xIQ5TBRyrv jg/V2R/mX6BHZPZxkzuYeFMmhwOgBIQ3t6rbuEIPtsGrwzW5kaNiE66W2zA93zDrLhDR 7mNkBi6m+vG9IXqp/UVHKBnQ0B+UGptxtf6hNyCeJjC1vqwcpu+HzBFHt8QSa+CQbstC 5C1g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc; bh=7LImTpMeZre5xONIcSThNBzpaeQWZNQ0EgJusBjmPyY=; b=262tqDuI39BjrtK/5K0kg3tbbvUDn94FEFsCVgmFJXe5tYVBC0d2lkZPtBlC6FhfBp K4t+KCOqWu0udbPWTczQXx1BTBGcXzRNZeHAPsgua/3wWWbbCm/XPVTYqsX8HJ8wtNOX tWzJjuFbYmo8H4W2DS0QqWyNVx0UMN9q+TnWTx5kruKEyPAZhe9dtTfaHTdjIds3y87F hmFZCusint9GWsGvmNGxqW2y/HJ6Q82IpLDPfVPIrEFo27wKHJWuePoX2bAAq1bsf1TB vNLcus7yp8URTQA5BOUVadKc4YeHSXsXNv/GnW4/UdZ0orievEQ6x7M10fAjH676tfyu h4/Q== X-Gm-Message-State: ACgBeo2l8LaGWenM8plVBXceUCVMcEsbdZhxEHwewM8wzlKaocFWKw+e Oo/9eFMrzds/y9lNFhpEp9oxOSz5NGXhtA== X-Google-Smtp-Source: AA6agR6wALlGLAd03bjDVitsMhHzI/0g//nmBh05TTFU6g0DkMzW50AwaYF9aWLChiu6v+uZdfXTPg== X-Received: by 2002:a05:6000:1b85:b0:21f:93d:a23d with SMTP id r5-20020a0560001b8500b0021f093da23dmr1628585wru.286.1659083164109; Fri, 29 Jul 2022 01:26:04 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id m20-20020a056000181400b0021e571a99d5sm2994802wrh.17.2022.07.29.01.26.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Jul 2022 01:26:03 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , Matheus Tavares , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v2 8/9] docs: add CONFIGURATION sections that map to a built-in Date: Fri, 29 Jul 2022 10:25:54 +0200 Message-Id: X-Mailer: git-send-email 2.37.1.1196.g8af3636bc64 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Add a CONFIGURATION section to the documentation of various built-ins, for those cases where the relevant config/NAME.txt describes configuration that is only used by the relevant built-in documented in git-NAME.txt. Subsequent commits will handle more complex cases. Signed-off-by: Ævar Arnfjörð Bjarmason --- Documentation/git-add.txt | 7 +++++++ Documentation/git-am.txt | 7 +++++++ Documentation/git-clean.txt | 7 +++++++ Documentation/git-clone.txt | 7 +++++++ Documentation/git-commit-graph.txt | 7 +++++++ Documentation/git-commit.txt | 4 ++++ Documentation/git-fast-import.txt | 7 +++++++ Documentation/git-mailinfo.txt | 7 +++++++ Documentation/git-maintenance.txt | 7 +++++++ Documentation/git-push.txt | 7 +++++++ Documentation/git-revert.txt | 7 +++++++ Documentation/git-show-branch.txt | 7 +++++++ Documentation/git-stash.txt | 7 +++++++ 13 files changed, 88 insertions(+) diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt index 11eb70f16c7..36da8bf9b51 100644 --- a/Documentation/git-add.txt +++ b/Documentation/git-add.txt @@ -431,6 +431,13 @@ they will make the patch impossible to apply: * deleting context or removal lines * modifying the contents of context or removal lines +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/add.txt[] + SEE ALSO -------- linkgit:git-status[1] diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index 09107fb1067..7ccb46b660c 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -261,6 +261,13 @@ This command can run `applypatch-msg`, `pre-applypatch`, and `post-applypatch` hooks. See linkgit:githooks[5] for more information. +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/am.txt[] + SEE ALSO -------- linkgit:git-apply[1]. diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index a7f309dff5a..91742633fa8 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -133,6 +133,13 @@ help:: Show brief usage of interactive git-clean. +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/clean.txt[] + SEE ALSO -------- linkgit:gitignore[5] diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 632bd1348ea..b9ee8a87238 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -363,6 +363,13 @@ $ cd my-linux $ git clone --bare -l /home/proj/.git /pub/scm/proj.git ------------ +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/clone.txt[] + GIT --- diff --git a/Documentation/git-commit-graph.txt b/Documentation/git-commit-graph.txt index e1f48c95b3c..5225f674546 100644 --- a/Documentation/git-commit-graph.txt +++ b/Documentation/git-commit-graph.txt @@ -142,6 +142,13 @@ $ git show-ref -s | git commit-graph write --stdin-commits $ git rev-parse HEAD | git commit-graph write --stdin-commits --append ------------------------------------------------ +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/commitgraph.txt[] + GIT --- diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 6c60bf98f9f..225c6c9f2e5 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -557,6 +557,10 @@ The editor used to edit the commit log message will be chosen from the `VISUAL` environment variable, or the `EDITOR` environment variable (in that order). See linkgit:git-var[1] for details. +include::includes/cmd-config-section-rest.txt[] + +include::config/commit.txt[] + HOOKS ----- This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`, diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index 39cfa05b28b..8b5dd6add00 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -1564,6 +1564,13 @@ operator can use this facility to peek at the objects and refs from an import in progress, at the cost of some added running time and worse compression. +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/fastimport.txt[] + SEE ALSO -------- linkgit:git-fast-export[1] diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt index 3fcfd965fde..28060283c70 100644 --- a/Documentation/git-mailinfo.txt +++ b/Documentation/git-mailinfo.txt @@ -115,6 +115,13 @@ If no such configuration option has been set, `warn` will be used. :: The patch extracted from e-mail. +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/mailinfo.txt[] + GIT --- Part of the linkgit:git[1] suite diff --git a/Documentation/git-maintenance.txt b/Documentation/git-maintenance.txt index e56bad28c65..9c630efe19c 100644 --- a/Documentation/git-maintenance.txt +++ b/Documentation/git-maintenance.txt @@ -397,6 +397,13 @@ If you want to customize the background tasks, please rename the tasks so future calls to `git maintenance (start|stop)` do not overwrite your custom tasks. +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/maintenance.txt[] + GIT --- diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt index 2f25aa3a291..def7657ef9c 100644 --- a/Documentation/git-push.txt +++ b/Documentation/git-push.txt @@ -692,6 +692,13 @@ a `git gc` command on the origin repository. include::transfer-data-leaks.txt[] +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/push.txt[] + GIT --- Part of the linkgit:git[1] suite diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt index 8463fe9cf75..700f937f60a 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -145,6 +145,13 @@ EXAMPLES changes. The revert only modifies the working tree and the index. +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/revert.txt[] + SEE ALSO -------- linkgit:git-cherry-pick[1] diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index 5cc2fcefbab..e5ec6b467f9 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -199,6 +199,13 @@ shows 10 reflog entries going back from the tip as of 1 hour ago. Without `--list`, the output also shows how these tips are topologically related with each other. +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/showbranch.txt[] + GIT --- Part of the linkgit:git[1] suite diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index 6e15f475257..c5d70918283 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -382,6 +382,13 @@ grep commit | cut -d\ -f3 | xargs git log --merges --no-walk --grep=WIP ---------------------------------------------------------------- +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/stash.txt[] + SEE ALSO -------- From patchwork Fri Jul 29 08:25:55 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 12932125 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 29019C00144 for ; Fri, 29 Jul 2022 08:26:56 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235341AbiG2I0y (ORCPT ); Fri, 29 Jul 2022 04:26:54 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33704 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235157AbiG2I0I (ORCPT ); Fri, 29 Jul 2022 04:26:08 -0400 Received: from mail-wm1-x32c.google.com (mail-wm1-x32c.google.com [IPv6:2a00:1450:4864:20::32c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D5C962E6A6 for ; Fri, 29 Jul 2022 01:26:06 -0700 (PDT) Received: by mail-wm1-x32c.google.com with SMTP id v5so2186785wmj.0 for ; Fri, 29 Jul 2022 01:26:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc; bh=5S72UZti9Wzpdk3f5bdC4w9ltfycZlQOtVo05XS1s5E=; b=eLBg9FKpmWcjNSyGyn5WYpXJ5AUxsmGdxjU/kpX6pFgyAM3RpoQhWtgk5gPla64SCZ DHUVkL6OOqte5CedqVpaQaDm5oKCZ0ewc0a3pXWdCoyDG8gAs2Vqca6XlZZZ7f5G28h2 H5IZY0EV62v1UdyUT2WpeDgJpmQp15N8iwvCPVP4oiCGWpGreJ9VIX62GdI6cppJr5Tx 32/ykIO2XdoTelOorxmujn9aKvT8IbnZB9vab9L0CDP3dWjUGGpPTj1j08p4vpNLw++7 YfgZIzMSERqGjz7KnxcwjDv6dzb6kbEAlXvjmPC4r7pePHsqkplPNKuNXTt6WHV9q6Ka ijPA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc; bh=5S72UZti9Wzpdk3f5bdC4w9ltfycZlQOtVo05XS1s5E=; b=NZKL2TzictnRUfSIKnluxuv1NaGxahw2iSlwMy+mHxTtorrBOffR5SV97ky5EY+4L1 ok0DqrRY6JD6t2X7Wqvl8Zh+Ai7ZEsNPiRPS++iNhXcps5EhalFy7CzF5epJbJYGEM3l 3Q9RQIvksQgP2/qTCuFOrQJNArPNnnMpJO+WDs7x3nUzvzy1GgSLzYeUKsbqAf/kTZq7 +Q/SzqC0GwA9iHtebA96glU7I85Dt3saQ6i/4s4mLkN6LnDfGee9yyAXTyJQDrAEa22C iUW1KdSKNK29AdipwPj8lcSu62cKtenvIOpX5fegZaq/Y63miqlknrlkXfMUayBE9Ovm PK7w== X-Gm-Message-State: AJIora8Al+Bki4fhqEGJYMVc+yj0bigb21MEDUzeL6vGbhv3KDOnKDI2 NmFgRZAISbJKedg+lx4Zox29cQNONZlBCw== X-Google-Smtp-Source: AGRyM1vsBLMIu+L3sSpFi8/dBiuWpe02Ak8GG/RpC8YcDaihoJB2/lQ6pf5/0C5/sYJOefSs5xFj1A== X-Received: by 2002:a05:600c:3ac6:b0:3a3:4178:a9a8 with SMTP id d6-20020a05600c3ac600b003a34178a9a8mr2042953wms.22.1659083165010; Fri, 29 Jul 2022 01:26:05 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id m20-20020a056000181400b0021e571a99d5sm2994802wrh.17.2022.07.29.01.26.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Jul 2022 01:26:04 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , Matheus Tavares , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v2 9/9] docs: add CONFIGURATION sections that fuzzy map to built-ins Date: Fri, 29 Jul 2022 10:25:55 +0200 Message-Id: X-Mailer: git-send-email 2.37.1.1196.g8af3636bc64 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Add a CONFIGURATION section to the documentation of various built-ins, for those cases where the relevant config/NAME.txt doesn't map only to one git-NAME.txt. In particular: * config/blame.txt: used by git-{blame,annotate}.txt. Since the git-annotate(1) documentation refers to git-blame(1) don't add a "CONFIGURATION" section to git-annotate(1), only to git-blame(1)> * config/branch.txt: maps to both git-checkout.txt and git-switch.txt (but nothing else). * config/init.txt: should be included in git-init(1) and git-clone(1). * config/column.txt: We should ideally mention the relevant subset of this in git-{branch,clean,status,tag}.txt, but let's punt on it for now. We will when we eventually split these sort of files into e.g. config/column.txt and config/column/{branch,clean,status,tag}.txt, with the former including the latter set. Things that are being left out, and why: * config/remote.txt: let's not include this in git-{fetch,remote,push}.txt etc. for now, various options there change their behavior. * config/remotes.txt: As we're not including config/remote.txt for now, let's not include this one either. * config/credential.txt: let's not include this in git-credential.txt, it talks more generally about how the credential facility is used by various other commands, not that command in particular. Signed-off-by: Ævar Arnfjörð Bjarmason --- Documentation/git-blame.txt | 6 ++++++ Documentation/git-branch.txt | 4 ++++ Documentation/git-checkout.txt | 7 +++++++ Documentation/git-clone.txt | 2 ++ Documentation/git-column.txt | 7 +++++++ Documentation/git-diff.txt | 7 +++++++ Documentation/git-fetch.txt | 7 +++++++ Documentation/git-switch.txt | 7 +++++++ 8 files changed, 47 insertions(+) diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index d7a46cc6744..4400a17330b 100644 --- a/Documentation/git-blame.txt +++ b/Documentation/git-blame.txt @@ -241,6 +241,12 @@ MAPPING AUTHORS See linkgit:gitmailmap[5]. +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/blame.txt[] SEE ALSO -------- diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index ae82378349d..12c5f84e3be 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -336,6 +336,10 @@ CONFIGURATION `--list` is used or implied. The default is to use a pager. See linkgit:git-config[1]. +include::includes/cmd-config-section-rest.txt[] + +include::config/branch.txt[] + EXAMPLES -------- diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index 9f37e22e130..4cb9d555b4b 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -600,6 +600,13 @@ $ edit frotz $ git add frotz ------------ +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/checkout.txt[] + SEE ALSO -------- linkgit:git-switch[1], diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index b9ee8a87238..43955a3b504 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -368,6 +368,8 @@ CONFIGURATION include::includes/cmd-config-section-all.txt[] +include::config/init.txt[] + include::config/clone.txt[] diff --git a/Documentation/git-column.txt b/Documentation/git-column.txt index 6cea9ab4638..18431647a2d 100644 --- a/Documentation/git-column.txt +++ b/Documentation/git-column.txt @@ -74,6 +74,13 @@ v2.4.3 v2.4.4 v2.4.5 v2.4.6 v2.4.7 v2.4.8 v2.4.9 ------------ +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/column.txt[] + GIT --- Part of the linkgit:git[1] suite diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index 6236c75c9b8..85ae6d6d08a 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -213,6 +213,13 @@ $ git diff -R <2> rewrites (very expensive). <2> Output diff in reverse. +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/diff.txt[] + SEE ALSO -------- diff(1), diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt index e9d364669af..63d9569e164 100644 --- a/Documentation/git-fetch.txt +++ b/Documentation/git-fetch.txt @@ -285,6 +285,13 @@ linkgit:git-gc[1]). include::transfer-data-leaks.txt[] +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/fetch.txt[] + BUGS ---- Using --recurse-submodules can only fetch new commits in submodules that are diff --git a/Documentation/git-switch.txt b/Documentation/git-switch.txt index bbcbdceb459..c60fc9c138b 100644 --- a/Documentation/git-switch.txt +++ b/Documentation/git-switch.txt @@ -265,6 +265,13 @@ always create a new name for it (without switching away): $ git switch -c good-surprises ------------ +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/checkout.txt[] + SEE ALSO -------- linkgit:git-checkout[1],