Skip to content

Commit 9274dea

Browse files
avargitster
authored andcommitted
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 <[email protected]> Reviewed-by: Matheus Tavares <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 16f6b0d commit 9274dea

File tree

9 files changed

+54
-0
lines changed

9 files changed

+54
-0
lines changed

Documentation/git-blame.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,12 @@ MAPPING AUTHORS
241241

242242
See linkgit:gitmailmap[5].
243243

244+
CONFIGURATION
245+
-------------
246+
247+
include::includes/cmd-config-section-all.txt[]
248+
249+
include::config/blame.txt[]
244250

245251
SEE ALSO
246252
--------

Documentation/git-branch.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,10 @@ CONFIGURATION
336336
`--list` is used or implied. The default is to use a pager.
337337
See linkgit:git-config[1].
338338

339+
include::includes/cmd-config-section-rest.txt[]
340+
341+
include::config/branch.txt[]
342+
339343
EXAMPLES
340344
--------
341345

Documentation/git-checkout.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -600,6 +600,13 @@ $ edit frotz
600600
$ git add frotz
601601
------------
602602

603+
CONFIGURATION
604+
-------------
605+
606+
include::includes/cmd-config-section-all.txt[]
607+
608+
include::config/checkout.txt[]
609+
603610
SEE ALSO
604611
--------
605612
linkgit:git-switch[1],

Documentation/git-clone.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -368,6 +368,8 @@ CONFIGURATION
368368

369369
include::includes/cmd-config-section-all.txt[]
370370

371+
include::config/init.txt[]
372+
371373
include::config/clone.txt[]
372374

373375

Documentation/git-column.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,13 @@ v2.4.3 v2.4.4 v2.4.5 v2.4.6 v2.4.7
7474
v2.4.8 v2.4.9
7575
------------
7676

77+
CONFIGURATION
78+
-------------
79+
80+
include::includes/cmd-config-section-all.txt[]
81+
82+
include::config/column.txt[]
83+
7784
GIT
7885
---
7986
Part of the linkgit:git[1] suite

Documentation/git-diff.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,13 @@ $ git diff -R <2>
213213
rewrites (very expensive).
214214
<2> Output diff in reverse.
215215

216+
CONFIGURATION
217+
-------------
218+
219+
include::includes/cmd-config-section-all.txt[]
220+
221+
include::config/diff.txt[]
222+
216223
SEE ALSO
217224
--------
218225
diff(1),

Documentation/git-fetch.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,13 @@ linkgit:git-gc[1]).
285285

286286
include::transfer-data-leaks.txt[]
287287

288+
CONFIGURATION
289+
-------------
290+
291+
include::includes/cmd-config-section-all.txt[]
292+
293+
include::config/fetch.txt[]
294+
288295
BUGS
289296
----
290297
Using --recurse-submodules can only fetch new commits in submodules that are

Documentation/git-init.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,13 @@ $ git commit <3>
169169
<2> Add all existing files to the index.
170170
<3> Record the pristine state as the first commit in the history.
171171

172+
CONFIGURATION
173+
-------------
174+
175+
include::includes/cmd-config-section-all.txt[]
176+
177+
include::config/init.txt[]
178+
172179
GIT
173180
---
174181
Part of the linkgit:git[1] suite

Documentation/git-switch.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,13 @@ always create a new name for it (without switching away):
265265
$ git switch -c good-surprises
266266
------------
267267

268+
CONFIGURATION
269+
-------------
270+
271+
include::includes/cmd-config-section-all.txt[]
272+
273+
include::config/checkout.txt[]
274+
268275
SEE ALSO
269276
--------
270277
linkgit:git-checkout[1],

0 commit comments

Comments
 (0)