diff options
| author | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2022-09-07 10:27:05 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2022-09-07 09:46:07 -0700 |
| commit | 9274dea3d95365c1ed0cd5ef46a9b677ae5c478f (patch) | |
| tree | 1c82fb1c2db8f2328dc7bb79d86a7305f525afb3 | |
| parent | 16f6b0d1aa598d665ada827cf89bda2112853680 (diff) | |
| download | git-9274dea3d95365c1ed0cd5ef46a9b677ae5c478f.tar.gz | |
docs: add CONFIGURATION sections that fuzzy map to built-ins
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 <avarab@gmail.com>
Reviewed-by: Matheus Tavares <matheus.bernardino@usp.br>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/git-blame.txt | 6 | ||||
| -rw-r--r-- | Documentation/git-branch.txt | 4 | ||||
| -rw-r--r-- | Documentation/git-checkout.txt | 7 | ||||
| -rw-r--r-- | Documentation/git-clone.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-column.txt | 7 | ||||
| -rw-r--r-- | Documentation/git-diff.txt | 7 | ||||
| -rw-r--r-- | Documentation/git-fetch.txt | 7 | ||||
| -rw-r--r-- | Documentation/git-init.txt | 7 | ||||
| -rw-r--r-- | Documentation/git-switch.txt | 7 |
9 files changed, 54 insertions, 0 deletions
diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index d7a46cc674..4400a17330 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 ae82378349..12c5f84e3b 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 9f37e22e13..4cb9d555b4 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 b9ee8a8723..43955a3b50 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -368,6 +368,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 6cea9ab463..18431647a2 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 6236c75c9b..85ae6d6d08 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 e9d364669a..63d9569e16 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 ad921fe782..160dea1372 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 bbcbdceb45..c60fc9c138 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], |