diff options
author | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2022-09-07 10:26:57 +0200 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2022-09-07 09:46:05 -0700 |
commit | 18d89fe25c80de269e8c6d14213ff400bc480e96 (patch) | |
tree | e5dd0714169336229803d5e257f28fa5e9877798 /Documentation/git-gc.txt | |
parent | 23b219f8e3f2adfb0441e135f0a880e6124f766c (diff) | |
download | git-18d89fe25c80de269e8c6d14213ff400bc480e96.tar.gz |
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>
Diffstat (limited to 'Documentation/git-gc.txt')
-rw-r--r-- | Documentation/git-gc.txt | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt index 0af7540a0c..a65c9aa62d 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[] |