]> git.ipfire.org Git - thirdparty/git.git/commit - Documentation/git-merge.txt
docs: add and use include template for config/* includes
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>
Wed, 7 Sep 2022 08:26:57 +0000 (10:26 +0200)
committerJunio C Hamano <gitster@pobox.com>
Wed, 7 Sep 2022 16:46:05 +0000 (09:46 -0700)
commit18d89fe25c80de269e8c6d14213ff400bc480e96
treee5dd0714169336229803d5e257f28fa5e9877798
parent23b219f8e3f2adfb0441e135f0a880e6124f766c
docs: add and use include template for config/* includes

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 <avarab@gmail.com>
Reviewed-by: Matheus Tavares <matheus.bernardino@usp.br>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/Makefile
Documentation/git-fsck.txt
Documentation/git-gc.txt
Documentation/git-imap-send.txt
Documentation/git-merge.txt
Documentation/git-mergetool.txt
Documentation/git-rebase.txt
Documentation/includes/cmd-config-section-all.txt [new file with mode: 0644]
Documentation/includes/cmd-config-section-rest.txt [new file with mode: 0644]