From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS3215 2.6.0.0/16 X-Spam-Status: No, score=-3.5 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from out1.vger.email (out1.vger.email [IPv6:2620:137:e000::1:20]) by dcvr.yhbt.net (Postfix) with ESMTP id 4BA6B1F54E for ; Wed, 7 Sep 2022 08:27:20 +0000 (UTC) Authentication-Results: dcvr.yhbt.net; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="p/679pMV"; dkim-atps=neutral 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?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= To: git@vger.kernel.org Cc: Junio C Hamano , Matheus Tavares , =?UTF-8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= 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 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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: -- 2.37.3.1490.g9adf4224da0