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 /Documentation/git-switch.txt | |
| 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>
Diffstat (limited to 'Documentation/git-switch.txt')
| -rw-r--r-- | Documentation/git-switch.txt | 7 |
1 files changed, 7 insertions, 0 deletions
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], |