From patchwork Wed Sep 7 08:26:57 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: 12968620 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 4A8FAC54EE9 for ; Wed, 7 Sep 2022 08:27:20 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229809AbiIGI1S (ORCPT ); Wed, 7 Sep 2022 04:27:18 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40522 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229553AbiIGI1P (ORCPT ); Wed, 7 Sep 2022 04:27:15 -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 3ED91A2A92 for ; Wed, 7 Sep 2022 01:27:14 -0700 (PDT) Received: by mail-wr1-x436.google.com with SMTP id k9so19173162wri.0 for ; Wed, 07 Sep 2022 01:27:14 -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:subject:date; bh=Qr9RwiKEedbxOCRaabHS3bDBQN0xFPDagz4Nc9igTSI=; b=p/679pMVJRq2m7hPpZzwdqIs87PPPHIOeQTqAzN08w7rQ0AmDfBEOWx65fGWAMjIsF P4bzSWzvNlAgrsr1V29GGHbz+jt7mS3bpN+QVQ+7bEXutOgReKZ/UA4X+GSpqdFX5BCY xbdXMVl99/ayuo3SYXsMRCqrKovj/1Lqk4a+Y/bsXC3GzpgCCeWMoLDlVKAsc5ywLBpU w9OJ/iC3hFpBr2+y1+63nGwjMezLmjO+0jx2ubCn29C77IRbaABi1brp1oT2Dbuz6Ym/ gLctXjmaUEhWEOByJuf3cM5vt/dpfQowf4DiKMRiBGfIVs6KVI4QAkfxO7bwBe3VXZTo XFKw== 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 :subject:date; bh=Qr9RwiKEedbxOCRaabHS3bDBQN0xFPDagz4Nc9igTSI=; b=yPv6AxO3tOy5wTiO3JJzMBywJO+B1PjMrQl52KWF8LoKJU0fcyLXcIgbqXQkStyTnX /0IeFjizOvxzlRS6R1SxPZrd7ehLZG8LPNWaWywJ08uJHsayekN06uA/jmWcb82ypYXY H7FSkc5RNqko8+fgSaAsLdbFUoeMLYx1WXn16nFqq//NxkfKO1yhcLwazX9AAxi/xz8d Vnx812muiSga4l2vc6kU2V3uTtArNOyActifMDElyXbZOWt1XhmUfaVrPcadBRiSyxT0 KRiF4XIOyRXHF6BhXq3gSKULfSRirsgdZKc8IjTScEy8ylhNmRRG0/cHmZx6qXoppE4L yD2g== X-Gm-Message-State: ACgBeo0LWA/CpX+u4aksQ3FD6d3yiGEQw7e3MPG5Nqgud+9BtiqpzhM8 lxLOre0NkISQ1IvtGAEGUA8HRCyPV64= X-Google-Smtp-Source: AA6agR5Mz3Qr3Ha0gbisYM9ajbE/12qdf5MaYvvj5EpdIDJGwxG/aKZODZKeH1+mlzXCCp6IzYUOZA== X-Received: by 2002:a5d:47c5:0:b0:226:efcf:49a3 with SMTP id o5-20020a5d47c5000000b00226efcf49a3mr1372300wrc.174.1662539232369; Wed, 07 Sep 2022 01:27:12 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id l6-20020a05600c4f0600b003a3170a7af9sm19532096wmq.4.2022.09.07.01.27.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 07 Sep 2022 01:27:11 -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 v4 1/9] docs: add and use include template for config/* includes Date: Wed, 7 Sep 2022 10:26:57 +0200 Message-Id: X-Mailer: git-send-email 2.37.3.1490.g9adf4224da0 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 bd6b6fcb930..849af6da307 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -62,6 +62,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 fee1dc2df28..2d6a1391c89 100644 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt @@ -383,13 +383,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 1877942180e..9cb8931c7ac 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -1259,6 +1259,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..b1e7682c1dc --- /dev/null +++ b/Documentation/includes/cmd-config-section-rest.txt @@ -0,0 +1,3 @@ +Everything above this line in this section isn't included from the +linkgit:git-config[1] documentation. The content that follows is the +same as what's found there: From patchwork Wed Sep 7 08:26:58 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: 12968621 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 3DBC2C38145 for ; Wed, 7 Sep 2022 08:27:21 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229836AbiIGI1U (ORCPT ); Wed, 7 Sep 2022 04:27:20 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40524 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229617AbiIGI1Q (ORCPT ); Wed, 7 Sep 2022 04:27:16 -0400 Received: from mail-wr1-x42a.google.com (mail-wr1-x42a.google.com [IPv6:2a00:1450:4864:20::42a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5D7F2A2A9A for ; Wed, 7 Sep 2022 01:27:15 -0700 (PDT) Received: by mail-wr1-x42a.google.com with SMTP id t7so14124519wrm.10 for ; Wed, 07 Sep 2022 01:27:15 -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:subject:date; bh=Dxo/6zLHt+5JLsnHrqgp3k9Ot/IsC/bYbSni+chKz80=; b=ivo6PMrnaivqSFfA4efcq6pCHvIAUcCktjxBpN5rnUIKO0GctGCYdYIrm38j4CPi3B QO658JigvF+iuGg4YvgApuwBkvcvZUpDo42z89eicFaczsrjXZWLD2sO3yxgDmPRWQd7 nNwqol+1ikhIgsvBu27GNtaAC8N63qOQeEq1rcy+L/22LZKlMLwE/2ypw/QMHR6kHaOv yxp+qfiNteeXEFdnVs2/d6zDaLGJiE+kdmdGROfl2bhkht9GIUe6vVGiDarui3VYtdVD oezagzk5UmTve9Rxn7DGc51eCTdOkU40dw3xYC6B/Jtca2uWPoWWAx71u22mbQENRZqo G9lg== 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 :subject:date; bh=Dxo/6zLHt+5JLsnHrqgp3k9Ot/IsC/bYbSni+chKz80=; b=312HkRs2R6rCbDJO7Vdp0QvCopvTJEvgCOxw4wHF87bqG+nG1T+nt4CQMrKnaqBDg0 /DFUyTG5Y5oO64nrGLLINegNw5wDjyRjMe/jVLkEAjA/vivL5CfAerlK9GkGMIam07RK WUSL+ycnOb/UoFq2qvB6jL7+4p2q1mH0tsG0f4z7bnN9ybwE1fq46KD/jrkWxfdFDq7x ggC3Y+LnlQ37zCVle1XAZuJp924UpcCi15vOTMPI9mNGCWhLBk/KekacD/+3xsgM2OJW 79WTHx9TkzL+EeGGP5OFkVXaSspipouutxTFkD36eeoYhHsD/PqJrZHUGV8oHxbrZPRP 5bVg== X-Gm-Message-State: ACgBeo3rV2XhlVUPcVZ8PAU+iX2wCQcNfEYD09WgWEXvffcf2Rifntgp lQ3jAAJ5ylrN8zJop6nP/dEdnzsFxDF9+A== X-Google-Smtp-Source: AA6agR4co1fQR/zRms8Yp+WlfH6t6MECzlc4On+uht4Gj6PX0iJ1yfLHhIfzdyQNHax3ieoxgW2UPw== X-Received: by 2002:a5d:488c:0:b0:226:ded7:69f8 with SMTP id g12-20020a5d488c000000b00226ded769f8mr1285243wrq.418.1662539233476; Wed, 07 Sep 2022 01:27:13 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id l6-20020a05600c4f0600b003a3170a7af9sm19532096wmq.4.2022.09.07.01.27.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 07 Sep 2022 01:27:12 -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 v4 2/9] grep docs: de-duplicate configuration sections Date: Wed, 7 Sep 2022 10:26:58 +0200 Message-Id: X-Mailer: git-send-email 2.37.3.1490.g9adf4224da0 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 Wed Sep 7 08:26:59 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: 12968622 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 2FC30ECAAD3 for ; Wed, 7 Sep 2022 08:27:30 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229927AbiIGI13 (ORCPT ); Wed, 7 Sep 2022 04:27:29 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40612 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229820AbiIGI1T (ORCPT ); Wed, 7 Sep 2022 04:27:19 -0400 Received: from mail-wr1-x435.google.com (mail-wr1-x435.google.com [IPv6:2a00:1450:4864:20::435]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A9A70A2A92 for ; Wed, 7 Sep 2022 01:27:16 -0700 (PDT) Received: by mail-wr1-x435.google.com with SMTP id c11so14921071wrp.11 for ; Wed, 07 Sep 2022 01:27:16 -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:subject:date; bh=O2eEHWeCeyI2dFwYcxXvouMTslPu0pCAj7JobwcO6c0=; b=cVl7voS/y3yFzpTCMn7Uw25mlaH3mxvD5kgHgjyWuuhyHhPHlCUkvtuMfXM1ECHa0m kRPVatNY+ZPcSuvNdcdFm1LO8DsSF9yoixwk5TfzXCURSawhVj8rHlpjrwFSRIp/eC1w C0ASrQutcqBou8k8Qgt24ptbxxvQcMyTVwLD6OvosnDpW4PowJ3dfe9KAKZwNOlpY8YA NTkUQmYsqEZawnexn/Gkukl4Gvy/TUhsoA/u1Nwg3itWRc0tM5DLzEbiQUMuu7lnvx2O lD/RxM0nVex1r+lVRMjyzQ4+sbD58zk/UyKSIjvwzsCO7BoebJe9llW5SBll5nnk8bz3 YRVA== 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 :subject:date; bh=O2eEHWeCeyI2dFwYcxXvouMTslPu0pCAj7JobwcO6c0=; b=xT6z2aDAfurO+6ezc2qkGqPiPH2Tlwc7tt5UFBf4WWnnbiF1AO/i+PPmCZIOM9ujkj A+hDTdCEkAsS0jrLWeRMiu78kpAwOXefETsTdHBGSj5/2KwXY/QUl2vKFWiSvmekmX+Z 9uXqdz3n/ccBReF5ddFfeB7S8d3OuuEBziNbOPRv59D8gT1ZG/OqWhCl9Vm6xgPUBtKv rRJDxG1kls+sGhzyWwTnqhCCPShFpdItv+t+JRIy5+77gvC8N7buldM/ojkBeU4ibRM9 glBhAOJwEan47oMPh5zVX1x+R2NFDFYBaooAnatx9iuu/weMGhIQSZBOIC2HLi1/L7SJ h49Q== X-Gm-Message-State: ACgBeo0dFqr4ROYDn2qaX1TIXa1/xlPoQQMa0tNru5NcKecBnQjROrtJ e7hI1FpjpqmBhAE52oBPmNs34mBiRml90Q== X-Google-Smtp-Source: AA6agR7UwSm3Q7+81c5+y+yuVkpuDg6upCGgssVdA6rx4xgMOT3vgb8ANDkIhMnefkRwch9N0btrig== X-Received: by 2002:adf:db06:0:b0:220:7a57:6665 with SMTP id s6-20020adfdb06000000b002207a576665mr1347411wri.55.1662539234599; Wed, 07 Sep 2022 01:27:14 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id l6-20020a05600c4f0600b003a3170a7af9sm19532096wmq.4.2022.09.07.01.27.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 07 Sep 2022 01:27:13 -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 v4 3/9] send-email docs: de-duplicate configuration sections Date: Wed, 7 Sep 2022 10:26:59 +0200 Message-Id: X-Mailer: git-send-email 2.37.3.1490.g9adf4224da0 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 Wed Sep 7 08:27:00 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: 12968623 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 30D92C38145 for ; Wed, 7 Sep 2022 08:27:32 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230000AbiIGI1a (ORCPT ); Wed, 7 Sep 2022 04:27:30 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40614 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229827AbiIGI1T (ORCPT ); Wed, 7 Sep 2022 04:27:19 -0400 Received: from mail-wm1-x32f.google.com (mail-wm1-x32f.google.com [IPv6:2a00:1450:4864:20::32f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6E340A2A9A for ; Wed, 7 Sep 2022 01:27:17 -0700 (PDT) Received: by mail-wm1-x32f.google.com with SMTP id d12-20020a05600c34cc00b003a83d20812fso9036433wmq.1 for ; Wed, 07 Sep 2022 01:27:17 -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:subject:date; bh=zwFfjSFkNH0td4rutJ0fUiJwA+6eKA/iIsNyTIHZy2A=; b=PhYyXO+tH2rM9Zh+9do0KoArcyADKA9zxLenfVLTud2O4xs98IQTZbcrtbND8Ozlu3 WQhVAno/92hke1LXMJ3ad2jtdjS410zdxtW84YhZTSmbmH9FBuEwSQKkkhThqXwE2uQN 9dNUEg75ZupWx/9RU1JAbq+1gfi0rM8qg2FrvXviQpPx0dp86MLhVpMYO2cs8LeE78QM bhmMr75N/nNRsDAJHvJgk0obrQKUGPwIH37RNKOVvOoLPXsWAoD9rgJq5HaBK2gZoyfb +kybqa5B6tu5UEH9mzDb9FwWGgsRTpl18qDLMTFLTX0l2lP0TfW+3kgL91Bv7dMkJTeg h9YQ== 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 :subject:date; bh=zwFfjSFkNH0td4rutJ0fUiJwA+6eKA/iIsNyTIHZy2A=; b=Uq/NOmXEZ1ItjDcErQwSBxZT62WkKwcFA9eZPHurSMg+xJGnQxFzSUDPpT2Fcw+9tk WzN7kJhUdGvsor4hBAzbdJqvEaBkMgTUfqW9VIJFtvRSRcpeTRk0ypc1HC86nDOBwq16 sD5lSJMu2z72s0X4HLejtQi03h2FR7i+/4bmF88kmeKNfbPH0bqbr6m1FLUvI1sqtEfN wO4yBTccqvKt+zehC99HjevL4AEbzw84Hm5THxcN2AIsW/AAJOKsNKZCTF3oSUVkGN3L Xnt6V8NZAeRp8t0ssRmpalgn8/mq5fF0ebZnYrQTTFfEFMrsfmx38ZfmHqhfVn8HZKiv hiig== X-Gm-Message-State: ACgBeo0aG7Jm3LtOkJsWTaxWY+oS+uoopJMudKUsT0lx0y1GpSpGhNSZ I6eejVViPDbXxHJQVB6YhhCrMy961hmAcQ== X-Google-Smtp-Source: AA6agR5jtlGxC19qUjc8tivFFxks/Ake4V7Rc19c7Vk88zTogBzrSU0uu3IjfyI2ye3pG0PYI2i2Wg== X-Received: by 2002:a05:600c:254:b0:3a5:a401:a1e2 with SMTP id 20-20020a05600c025400b003a5a401a1e2mr15334080wmj.14.1662539235689; Wed, 07 Sep 2022 01:27:15 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id l6-20020a05600c4f0600b003a3170a7af9sm19532096wmq.4.2022.09.07.01.27.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 07 Sep 2022 01:27:14 -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 v4 4/9] apply docs: de-duplicate configuration sections Date: Wed, 7 Sep 2022 10:27:00 +0200 Message-Id: X-Mailer: git-send-email 2.37.3.1490.g9adf4224da0 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 Wed Sep 7 08:27:01 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: 12968624 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 7EA62C54EE9 for ; Wed, 7 Sep 2022 08:27:33 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229917AbiIGI1c (ORCPT ); Wed, 7 Sep 2022 04:27:32 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40686 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229862AbiIGI1V (ORCPT ); Wed, 7 Sep 2022 04:27:21 -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 BC387A2A9D for ; Wed, 7 Sep 2022 01:27:18 -0700 (PDT) Received: by mail-wr1-x433.google.com with SMTP id bq9so6235836wrb.4 for ; Wed, 07 Sep 2022 01:27:18 -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:subject:date; bh=93xkCwwLhmP9Q5msCezyeEe9vGiYamLQ7ky3clngnn4=; b=CCy9X5FHy8y1VF873M+aYclCV6/nrUgHcNYvWt4yxmUqBr+cOjOwdNNth/JJsDnJ8M AyYx3+YPlFUToQ9LYb2Zz6Dqo6dXqwGNwBMFHgyCq3hmeBYEAtsG02eQtOTcw3UeeC9U d6TAXhAUW3k1qzotJdg6lk1scFbSrqQtFO9dIwf9sxrYzn5R/F7+PHHFXqDsfE185PZ8 FcbHVpI5mvoL0R5hamR4ZpyQvK31ipCBWPnNlcQ39i+WBNXFN/6BqevJVwfbOGVklABZ ZR/CgRy49sqBlKkA0+ze5cZdm+0Oju1MZG0YLdmEJCxA/EI+PQjep+EVKBHh82fNMXEq 3NnQ== 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 :subject:date; bh=93xkCwwLhmP9Q5msCezyeEe9vGiYamLQ7ky3clngnn4=; b=kuOtoiE1kE9KB1+d2Z6xi6+t8KWfA6EpTg2Ge70qefJx5YXMPXyrl6ybvHyCaGHa/n D/gOKIThNJYRyI5Y/aQvjyZ45EaJH4IiD8j0eRd8hqXJaMF+nDhxr4opLchW8b8u/JO2 sP7MQ1zw3LnOc2LOLyAETq55KEXKy2Y6CdieGZc5Ja/DmOQNgjarZi5n4p52dFlu2t8o ItL+JBm28ohwqw4wbVp+5N2MmKfHg5Nqxo16IjHmEZromQ+pTTXLXVREB11/K6h5dXNt yPiueS/fuSatPFvSos03Kcgmu3xZKw+Hm5PQp3pTvJ6H+HyPlmQ/PqKmSwjPg3qKGOb2 dmeA== X-Gm-Message-State: ACgBeo0VYo5K2CustYyRZ9Hww6sIz4+1J5LXUzCX7jElV1GMuw1uOWNV 4CVm2hiOVsTH+jZh3RzfzOjUmA08SlsMLA== X-Google-Smtp-Source: AA6agR7hk6vf3d9/rFNmmCj2TFr/C8oeHVloHD2styWxuuiQNyOqCMiJaAuOp9ZJq1cW+WBCTYZNBg== X-Received: by 2002:a5d:4d0c:0:b0:228:cd9f:5a4c with SMTP id z12-20020a5d4d0c000000b00228cd9f5a4cmr1374137wrt.138.1662539236633; Wed, 07 Sep 2022 01:27:16 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id l6-20020a05600c4f0600b003a3170a7af9sm19532096wmq.4.2022.09.07.01.27.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 07 Sep 2022 01:27:15 -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 v4 5/9] notes docs: de-duplicate and combine configuration sections Date: Wed, 7 Sep 2022 10:27:01 +0200 Message-Id: X-Mailer: git-send-email 2.37.3.1490.g9adf4224da0 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Combine the various "notes" configuration sections spread across Documentation/config/notes.txt and Documentation/git-notes.txt to live in the former, and to be included in the latter. We'll now forward link from "git notes" to the "CONFIGURATION" section below, rather than to "git-config(1)" when discussing configuration variables that are (also) discussed in that section. Signed-off-by: Ævar Arnfjörð Bjarmason --- Documentation/config/notes.txt | 43 +++++++++++++++----------- Documentation/git-log.txt | 16 ++-------- Documentation/git-notes.txt | 55 +++------------------------------- 3 files changed, 33 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 b1285aee3c2..410095e9a4f 100644 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@ -237,19 +237,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..efbc10f0f59 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" discussion in <>. See the "notes.rewrite." configuration for a way to carry notes across commands that rewrite commits. @@ -307,6 +307,7 @@ with 'git log', so if you use such notes, you'll probably need to write some special-purpose tools to do something useful with them. +[[CONFIGURATION]] CONFIGURATION ------------- @@ -316,57 +317,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 Wed Sep 7 08:27:02 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: 12968625 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 5C191ECAAD3 for ; Wed, 7 Sep 2022 08:27:34 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229964AbiIGI1d (ORCPT ); Wed, 7 Sep 2022 04:27:33 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40688 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229617AbiIGI1V (ORCPT ); Wed, 7 Sep 2022 04:27:21 -0400 Received: from mail-wr1-x431.google.com (mail-wr1-x431.google.com [IPv6:2a00:1450:4864:20::431]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BC46FAB050 for ; Wed, 7 Sep 2022 01:27:18 -0700 (PDT) Received: by mail-wr1-x431.google.com with SMTP id t14so11861466wrx.8 for ; Wed, 07 Sep 2022 01:27:18 -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:subject:date; bh=twjDJdyDzycPS/CPAcocpRilY98QzrHLOJMcwTaIjBw=; b=YUl+HQd8Eq3E4PTY/VYuNhvam5FiXqPfOzPcFKK2vrjz9cWU5KwDhqNFf56a+yucks ggxxokqz4tv1QcIr4nigfCww+NYgAq4+YGW28IySaiVuAIzelG4FimWurkS7eldXUXXL kCXv1oZQQxFHsIzB/ViAQdgAZUlDx8OqZLBOGK3wJ8eZfRJSeos3YWDfcR8qvQEsr6Da MyYhx6BtmrW99CasQ5WLePAkuwPLNcPpdyxO5bGRnndYRR22S5lxH8IAZgc4tfkd2J/j yUB36yhl0De7UYlts0/dt0tnBDT0aUJl2dB+Y0PjmBJZFeL351Ug0WBVPdq4Lvcuu2qJ 4YIg== 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 :subject:date; bh=twjDJdyDzycPS/CPAcocpRilY98QzrHLOJMcwTaIjBw=; b=DoVtOXj13T/9sveJqnXS0Dg1B5G42BUHKxD9nkVER3pqDpiXAffa1TilKyopRQ0fdn bBfPfZIWMOGZXj+pMYZBfZ+WY7lHCfp1Ob+0O+XxmG4atOhIQdx0HHIVouRm6xdplbQz AN3OYIy5EoN2eY1cAqS6+iivEfe1fiWLB7mKBEuXEI87TquTQX9ZbyYx0DJEZOtz5ABE AV3Zu3IGpXs/+xN4HQ2c6hJ/tabp2Tv9T3ulNrbj5dmviPkkw7KsQAKC8XQ0SRtqK+YV PIKGVGGlQ/tLithNP3KE0vFKFVNLDdnqUSROC7lczmCSNfpvXXBUxs17NlUB85KE4n3U M7xg== X-Gm-Message-State: ACgBeo3npS5HWaOrbXuRRvdNrX4zA1LfAN/XdGtCwHzXedlAHJRLYZkm Zx9XM3uTpAcLLxrwK06qqsG7Lty/o7uGNA== X-Google-Smtp-Source: AA6agR4GjJJp5ZraRw6Oj2ZxzAhpyvmx3YKyOI39PoPIT7GNietXZqGxBYOBbGuj63Vd1+SHMOc8Hg== X-Received: by 2002:a05:6000:713:b0:226:ea6c:2d7d with SMTP id bs19-20020a056000071300b00226ea6c2d7dmr1325404wrb.293.1662539237746; Wed, 07 Sep 2022 01:27:17 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id l6-20020a05600c4f0600b003a3170a7af9sm19532096wmq.4.2022.09.07.01.27.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 07 Sep 2022 01:27:16 -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 v4 6/9] difftool docs: de-duplicate configuration sections Date: Wed, 7 Sep 2022 10:27:02 +0200 Message-Id: X-Mailer: git-send-email 2.37.3.1490.g9adf4224da0 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 Wed Sep 7 08:27:03 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: 12968626 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 B0B67ECAAD3 for ; Wed, 7 Sep 2022 08:27:36 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229896AbiIGI1f (ORCPT ); Wed, 7 Sep 2022 04:27:35 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40926 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229884AbiIGI12 (ORCPT ); Wed, 7 Sep 2022 04:27:28 -0400 Received: from mail-wm1-x334.google.com (mail-wm1-x334.google.com [IPv6:2a00:1450:4864:20::334]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BFC33AB401 for ; Wed, 7 Sep 2022 01:27:20 -0700 (PDT) Received: by mail-wm1-x334.google.com with SMTP id ay12so8310196wmb.1 for ; Wed, 07 Sep 2022 01:27:20 -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:subject:date; bh=IEU+nj59wmjbCHiON6xmWoLa/T5gI739UJqe4MhHj2M=; b=qxZE2aWGWwvi/qSNTmlQUulVcaR/QbiPkt8NrrVyHFd4HrpDizmAe4yTtSX2P+CC3v l6QuaTPRdJuAMQQOoUaY+1a//3E8Xouf0RNCUx0hwZoIJPgyOQz+R/SvlrQEYUab2oK1 QboOXnj/+8hzvc2rq0eal7ba5h98cPit+ZvOmnLsOEBzYFH5+L+e86MkKKsW96qc3U/3 QMO2j/tpC4wcnSA2iY+vilUbP4OEA3qs5QTQFsM8Q/Uj9/QSxYGjWJgGPnJCtNYANOpS onLpxONc6VERIgkrrs0p3ivAiBratZdfV7F1Q58xlP7Ely6G9Sn3hktJ1wWILEfPejkq 5PHg== 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 :subject:date; bh=IEU+nj59wmjbCHiON6xmWoLa/T5gI739UJqe4MhHj2M=; b=KnDioFY9NHCnBnqukebT3QZUIVhreDK6DH3wmDf/fSf5C7XqeB7pYxdiKURn6MM8EL tk6uG7iLazr3qFU2YRF/X7jWpLi+VFamFEZGEFgDGOxqZ6AVWBTVtnPhRY8z9UIXVM3Z w7Lzg6/k5Q0AD6vl9MQ3103Da0h9eArjuzkAkM5NnPKUv5QvdALTixG2R/zPg3rpLVEu IgIiX+xHpGszsTMT8wdW33lXtEJIsXB3vcbmk4gpt74b26J9f/ABepAWSpuyRLbvHgFa zuk01i1To6bfdVRD4dZL7LWT2knlON9tmKLrtXJPcyaBtYsQjxm4cUtQLgTXA14BJbi9 XSCg== X-Gm-Message-State: ACgBeo3RyRmiveGggD+Q2wwwHR5q6wNPWmYPI6gbfFz1Atbn4UHKbsAT ZUbDvNolO6KxiJZmjxxk45A7HkSEYW+02w== X-Google-Smtp-Source: AA6agR6dHc35iETbBHrlRbMbQB6pzwOGwkYjxw2rVjehdxm+L2Zqba/AD58DRiiNloGBAuOUbDo/Yg== X-Received: by 2002:a05:600c:3d12:b0:3a5:f600:4fe9 with SMTP id bh18-20020a05600c3d1200b003a5f6004fe9mr16092683wmb.98.1662539238718; Wed, 07 Sep 2022 01:27:18 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id l6-20020a05600c4f0600b003a3170a7af9sm19532096wmq.4.2022.09.07.01.27.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 07 Sep 2022 01:27:18 -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 v4 7/9] log docs: de-duplicate configuration sections Date: Wed, 7 Sep 2022 10:27:03 +0200 Message-Id: X-Mailer: git-send-email 2.37.3.1490.g9adf4224da0 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 | 4 ++++ Documentation/git-log.txt | 30 ++---------------------------- 2 files changed, 6 insertions(+), 28 deletions(-) diff --git a/Documentation/config/log.txt b/Documentation/config/log.txt index 5250ba45fb4..bc63bc3939c 100644 --- a/Documentation/config/log.txt +++ b/Documentation/config/log.txt @@ -7,6 +7,10 @@ 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 diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt index 410095e9a4f..2a66cf88807 100644 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@ -209,36 +209,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 Wed Sep 7 08:27:04 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: 12968627 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 4127BC54EE9 for ; Wed, 7 Sep 2022 08:27:38 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230078AbiIGI1g (ORCPT ); Wed, 7 Sep 2022 04:27:36 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40970 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229938AbiIGI13 (ORCPT ); Wed, 7 Sep 2022 04:27:29 -0400 Received: from mail-wm1-x32d.google.com (mail-wm1-x32d.google.com [IPv6:2a00:1450:4864:20::32d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id CE815AB431 for ; Wed, 7 Sep 2022 01:27:21 -0700 (PDT) Received: by mail-wm1-x32d.google.com with SMTP id h1so8295977wmd.3 for ; Wed, 07 Sep 2022 01:27:21 -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:subject:date; bh=WNUJeWwSoOrE/4m5pccXfSLDKCodvBiAErFRIS+lx0M=; b=oUhO2h6zNV7INQHeK3hmbfZ8/K9iNyKcdTUQjs9qcxXDimMhOw8D47QHKKIhut36uw 2utXIvlo2os4mdtihAh5KAi/V1m8iVebj/DjsQWW0JPzggaoveOJcLluWi/GTTPESAR/ 5vJndTtrDd9H9NPUhIaj5JWw2d9qhD+9KNB3712N+zTuBRoaez0NlhiXnoQxRtH7Fekf q44hef4NkNSfJj+Rhdf2fBm5IZE/zYQboBV53LOrzgLvn2UfZTRbSj2m2LK+0gpoZKxn KJfTss0+LHXs1c5Euqe2AyJ6kTe3RI3LLZ4koo8Cjh8B50qHGlZLw6XZEz3zmp8ZWS38 bHVA== 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 :subject:date; bh=WNUJeWwSoOrE/4m5pccXfSLDKCodvBiAErFRIS+lx0M=; b=wxYLiILL/7UCXXaNorXFVuNUIg3OGBHjAZo9awGD+Mu26ze+MCD27l8RuBYIZCHEss PC4g5JaOaDBGEBWTbEzxH3HyXV9AYV+9LuneADu6hJ46OLF0ZvDlwwnq9cp3qH76VT73 pthwW4BSd4ZgieBmwixJd9ycPx+KrjbrlsFB+XcEgF9XnvXQmGvUp1q1Hc1QA9Z3I1ao uzYii4PMagTlj+HYpepUP3IyrlZ0xTaZNhUeJP9xvJPbC8HIvUx5yjs/SCHre8hxx9+u uHp6GcD6lJZedDbmniyfbvlob839g6X6inoVuBnYbhGtpdOo/Z1/eNZpQPTngz1lsIV8 75dA== X-Gm-Message-State: ACgBeo2p/lN5mDxkrYkd3QIT6wCSwPH7EfOwjjH4DK6Ul7cB7na06TjD 9Q4Ve18fWKMyjt/BXCxkf8duPCW4WNjcBg== X-Google-Smtp-Source: AA6agR4M+YSqUGqKWCsV7mvhlgYl4LwCZ6QwkYAuY1IeIVZGYNk9hQ4GKmr232U728XZHDCFkignuA== X-Received: by 2002:a05:600c:22c7:b0:3a6:68e4:1e5f with SMTP id 7-20020a05600c22c700b003a668e41e5fmr1283928wmg.46.1662539239701; Wed, 07 Sep 2022 01:27:19 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id l6-20020a05600c4f0600b003a3170a7af9sm19532096wmq.4.2022.09.07.01.27.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 07 Sep 2022 01:27:18 -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 v4 8/9] docs: add CONFIGURATION sections that map to a built-in Date: Wed, 7 Sep 2022 10:27:04 +0200 Message-Id: X-Mailer: git-send-email 2.37.3.1490.g9adf4224da0 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 9b37f356542..a030d33c6e7 100644 --- a/Documentation/git-add.txt +++ b/Documentation/git-add.txt @@ -433,6 +433,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 320da6c4f76..326276e51ce 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -258,6 +258,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 d032d971dd7..1c3d7017646 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -370,6 +370,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 047decdb65b..36fe56c2c71 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[] + FILE FORMAT ----------- 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 0105a54c1a5..5016755efb6 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -142,6 +142,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 Wed Sep 7 08:27:05 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: 12968628 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 D37CAECAAD3 for ; Wed, 7 Sep 2022 08:27:39 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230104AbiIGI1i (ORCPT ); Wed, 7 Sep 2022 04:27:38 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40908 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229864AbiIGI13 (ORCPT ); Wed, 7 Sep 2022 04:27:29 -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 C81B6AB4FB for ; Wed, 7 Sep 2022 01:27:22 -0700 (PDT) Received: by mail-wm1-x331.google.com with SMTP id z14-20020a7bc7ce000000b003a5db0388a8so331516wmk.1 for ; Wed, 07 Sep 2022 01:27:22 -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:subject:date; bh=ZvxZ/JISq8Fda5vvgs9fKX3Du4MVaRav5PtRnzxKqN8=; b=HEb2zrXd0P1+rVmi2WJxrPtX1I7RKfgSWZxe2QxEGZk78bJ484YaokJwCNPCdbGBa7 SitPSBoj9Z+L5TM0bk2OPYIBiHakofs375jdyxHttsE9bQa4QprHIu9fVKyQSifx2Xgb b+hJ85czV7ordtEpN7bY8I1WIvZmc+uPxOCFiC3hnDZFfnOGIS/NRTWXbnHOFATvqhXb nMJcbcY0MO9mjSavVBM6CoeAAg6tFQqbD0qgCbIf1zDLg2XrlJXiX8/EDbwubx41/aNF tEydxMSe5KxKFgGwTn2bTz6z/yVEVNW1N4GsS1wAqX9Ua9TExjR5PSIY3EUTecOB8Zhf v7lQ== 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 :subject:date; bh=ZvxZ/JISq8Fda5vvgs9fKX3Du4MVaRav5PtRnzxKqN8=; b=gebybw8mkOc0cQ9f9lvWXG3aICvcela5f+4CAnUe4X8F4VaqMwN3oMNGTk1yKYUN6u 50ZCNnPEmUGiVaaTO9cDPo1M2iD9JIwzfrWWTyQ1J6aILCxrtBX0yrA50Td6sw4beF2d vI3m0Fx5NGLSoK9n5XxGyopOmuLdvfLvo21F28vOTltz81bJTmRakzePHLaIKE19FWxb 5NXk4cpso17JJGCP18BOidL0Tr2MWeGWE0ffOB2hvmpqPrVZiIXZ//1DGztN66tozChN utVTMFbxIsjEEhX2hjXlpvgVkWEtjGlOWmuo5KoGALqHUztmJATOPGrEzkAGUJcl3xfn epAw== X-Gm-Message-State: ACgBeo2Mndy4SZMjH7XkPSj7m68Pdn4QutN5txG1NXVew+kmD5FgcvEu qms+iFARMI6dYqeyYVQeoY4BXAEIal85SQ== X-Google-Smtp-Source: AA6agR5zrQiGOa0xoG6Y7pLHb36OboEVIZkjp1K6kDdNkdLkz/nMepDuSTD3CEXM28r1TVimDtJQug== X-Received: by 2002:a05:600c:22c8:b0:3a5:c134:1f50 with SMTP id 8-20020a05600c22c800b003a5c1341f50mr16474749wmg.55.1662539240618; Wed, 07 Sep 2022 01:27:20 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id l6-20020a05600c4f0600b003a3170a7af9sm19532096wmq.4.2022.09.07.01.27.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 07 Sep 2022 01:27:19 -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 v4 9/9] docs: add CONFIGURATION sections that fuzzy map to built-ins Date: Wed, 7 Sep 2022 10:27:05 +0200 Message-Id: X-Mailer: git-send-email 2.37.3.1490.g9adf4224da0 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/checkout.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,remotes,credential}.txt: Configuration that affects how we talk to remote repositories is harder to untangle. We'll need to include some of this in git-{fetch,remote,push,ls-remote}.txt etc., but some of those only use a small subset of these options. Let's leave this for now. 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-init.txt | 7 +++++++ Documentation/git-switch.txt | 7 +++++++ 9 files changed, 54 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 1c3d7017646..d6434d262d6 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -375,6 +375,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-init.txt b/Documentation/git-init.txt index ad921fe782e..160dea1372c 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -169,6 +169,13 @@ $ git commit <3> <2> Add all existing files to the index. <3> Record the pristine state as the first commit in the history. +CONFIGURATION +------------- + +include::includes/cmd-config-section-all.txt[] + +include::config/init.txt[] + GIT --- Part of the linkgit:git[1] suite 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],