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 18:46:05 +0200 |
| commit | 18d89fe25c80de269e8c6d14213ff400bc480e96 (patch) | |
| tree | e5dd0714169336229803d5e257f28fa5e9877798 /Documentation/includes | |
| parent | Sync with 'maint' (diff) | |
| download | git-18d89fe25c80de269e8c6d14213ff400bc480e96.tar.xz git-18d89fe25c80de269e8c6d14213ff400bc480e96.zip | |
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/includes')
| -rw-r--r-- | Documentation/includes/cmd-config-section-all.txt | 3 | ||||
| -rw-r--r-- | Documentation/includes/cmd-config-section-rest.txt | 3 |
2 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/includes/cmd-config-section-all.txt b/Documentation/includes/cmd-config-section-all.txt new file mode 100644 index 0000000000..296a239f2a --- /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 0000000000..b1e7682c1d --- /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: |