Skip to content

Commit 16f6b0d

Browse files
avargitster
authored andcommitted
docs: add CONFIGURATION sections that map to a built-in
Add a CONFIGURATION section to the documentation of various built-ins, for those cases where the relevant config/NAME.txt describes configuration that is only used by the relevant built-in documented in git-NAME.txt. Subsequent commits will handle more complex cases. 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 00c8053 commit 16f6b0d

13 files changed

+88
-0
lines changed

Documentation/git-add.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -431,6 +431,13 @@ they will make the patch impossible to apply:
431431
* deleting context or removal lines
432432
* modifying the contents of context or removal lines
433433

434+
CONFIGURATION
435+
-------------
436+
437+
include::includes/cmd-config-section-all.txt[]
438+
439+
include::config/add.txt[]
440+
434441
SEE ALSO
435442
--------
436443
linkgit:git-status[1]

Documentation/git-am.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,13 @@ This command can run `applypatch-msg`, `pre-applypatch`,
261261
and `post-applypatch` hooks. See linkgit:githooks[5] for more
262262
information.
263263

264+
CONFIGURATION
265+
-------------
266+
267+
include::includes/cmd-config-section-all.txt[]
268+
269+
include::config/am.txt[]
270+
264271
SEE ALSO
265272
--------
266273
linkgit:git-apply[1].

Documentation/git-clean.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,13 @@ help::
133133

134134
Show brief usage of interactive git-clean.
135135

136+
CONFIGURATION
137+
-------------
138+
139+
include::includes/cmd-config-section-all.txt[]
140+
141+
include::config/clean.txt[]
142+
136143
SEE ALSO
137144
--------
138145
linkgit:gitignore[5]

Documentation/git-clone.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,13 @@ $ cd my-linux
363363
$ git clone --bare -l /home/proj/.git /pub/scm/proj.git
364364
------------
365365

366+
CONFIGURATION
367+
-------------
368+
369+
include::includes/cmd-config-section-all.txt[]
370+
371+
include::config/clone.txt[]
372+
366373

367374
GIT
368375
---

Documentation/git-commit-graph.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,13 @@ $ git show-ref -s | git commit-graph write --stdin-commits
142142
$ git rev-parse HEAD | git commit-graph write --stdin-commits --append
143143
------------------------------------------------
144144

145+
CONFIGURATION
146+
-------------
147+
148+
include::includes/cmd-config-section-all.txt[]
149+
150+
include::config/commitgraph.txt[]
151+
145152

146153
GIT
147154
---

Documentation/git-commit.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -557,6 +557,10 @@ The editor used to edit the commit log message will be chosen from the
557557
`VISUAL` environment variable, or the `EDITOR` environment variable (in that
558558
order). See linkgit:git-var[1] for details.
559559

560+
include::includes/cmd-config-section-rest.txt[]
561+
562+
include::config/commit.txt[]
563+
560564
HOOKS
561565
-----
562566
This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,

Documentation/git-fast-import.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1564,6 +1564,13 @@ operator can use this facility to peek at the objects and refs from an
15641564
import in progress, at the cost of some added running time and worse
15651565
compression.
15661566

1567+
CONFIGURATION
1568+
-------------
1569+
1570+
include::includes/cmd-config-section-all.txt[]
1571+
1572+
include::config/fastimport.txt[]
1573+
15671574
SEE ALSO
15681575
--------
15691576
linkgit:git-fast-export[1]

Documentation/git-mailinfo.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,13 @@ If no such configuration option has been set, `warn` will be used.
115115
<patch>::
116116
The patch extracted from e-mail.
117117

118+
CONFIGURATION
119+
-------------
120+
121+
include::includes/cmd-config-section-all.txt[]
122+
123+
include::config/mailinfo.txt[]
124+
118125
GIT
119126
---
120127
Part of the linkgit:git[1] suite

Documentation/git-maintenance.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,13 @@ If you want to customize the background tasks, please rename the tasks
397397
so future calls to `git maintenance (start|stop)` do not overwrite your
398398
custom tasks.
399399

400+
CONFIGURATION
401+
-------------
402+
403+
include::includes/cmd-config-section-all.txt[]
404+
405+
include::config/maintenance.txt[]
406+
400407

401408
GIT
402409
---

Documentation/git-push.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -692,6 +692,13 @@ a `git gc` command on the origin repository.
692692

693693
include::transfer-data-leaks.txt[]
694694

695+
CONFIGURATION
696+
-------------
697+
698+
include::includes/cmd-config-section-all.txt[]
699+
700+
include::config/push.txt[]
701+
695702
GIT
696703
---
697704
Part of the linkgit:git[1] suite

0 commit comments

Comments
 (0)