@matheusbsbs / matheus-bagliano / commits / 9274dea3d9

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>

Ævar Arnfjörð Bjarmason committed Sep 7, 2022 at 10:27 UTC 9274dea3d95365c1ed0cd5ef46a9b677ae5c478f
9 files changed +54
Documentation/git-blame.txt
+6
@@ -241,6 +241,12 @@ MAPPING AUTHORS
241
242 See linkgit:gitmailmap[5].
243
244 +CONFIGURATION
245 +-------------
246 +
247 +include::includes/cmd-config-section-all.txt[]
248 +
249 +include::config/blame.txt[]
250
251 SEE ALSO
252 --------
Documentation/git-branch.txt
+4
@@ -336,6 +336,10 @@ CONFIGURATION
336 `--list` is used or implied. The default is to use a pager.
337 See linkgit:git-config[1].
338
339 +include::includes/cmd-config-section-rest.txt[]
340 +
341 +include::config/branch.txt[]
342 +
343 EXAMPLES
344 --------
345
Documentation/git-checkout.txt
+7
@@ -600,6 +600,13 @@ $ edit frotz
600 $ git add frotz
601 ------------
602
603 +CONFIGURATION
604 +-------------
605 +
606 +include::includes/cmd-config-section-all.txt[]
607 +
608 +include::config/checkout.txt[]
609 +
610 SEE ALSO
611 --------
612 linkgit:git-switch[1],
Documentation/git-clone.txt
+2
@@ -368,6 +368,8 @@ CONFIGURATION
368
369 include::includes/cmd-config-section-all.txt[]
370
371 +include::config/init.txt[]
372 +
373 include::config/clone.txt[]
374
375
Documentation/git-column.txt
+7
@@ -74,6 +74,13 @@ v2.4.3 v2.4.4 v2.4.5 v2.4.6 v2.4.7
74 v2.4.8 v2.4.9
75 ------------
76
77 +CONFIGURATION
78 +-------------
79 +
80 +include::includes/cmd-config-section-all.txt[]
81 +
82 +include::config/column.txt[]
83 +
84 GIT
85 ---
86 Part of the linkgit:git[1] suite
Documentation/git-diff.txt
+7
@@ -213,6 +213,13 @@ $ git diff -R <2>
213 rewrites (very expensive).
214 <2> Output diff in reverse.
215
216 +CONFIGURATION
217 +-------------
218 +
219 +include::includes/cmd-config-section-all.txt[]
220 +
221 +include::config/diff.txt[]
222 +
223 SEE ALSO
224 --------
225 diff(1),
Documentation/git-fetch.txt
+7
@@ -285,6 +285,13 @@ linkgit:git-gc[1]).
285
286 include::transfer-data-leaks.txt[]
287
288 +CONFIGURATION
289 +-------------
290 +
291 +include::includes/cmd-config-section-all.txt[]
292 +
293 +include::config/fetch.txt[]
294 +
295 BUGS
296 ----
297 Using --recurse-submodules can only fetch new commits in submodules that are
Documentation/git-init.txt
+7
@@ -169,6 +169,13 @@ $ git commit <3>
169 <2> Add all existing files to the index.
170 <3> Record the pristine state as the first commit in the history.
171
172 +CONFIGURATION
173 +-------------
174 +
175 +include::includes/cmd-config-section-all.txt[]
176 +
177 +include::config/init.txt[]
178 +
179 GIT
180 ---
181 Part of the linkgit:git[1] suite
Documentation/git-switch.txt
+7
@@ -265,6 +265,13 @@ always create a new name for it (without switching away):
265 $ git switch -c good-surprises
266 ------------
267
268 +CONFIGURATION
269 +-------------
270 +
271 +include::includes/cmd-config-section-all.txt[]
272 +
273 +include::config/checkout.txt[]
274 +
275 SEE ALSO
276 --------
277 linkgit:git-checkout[1],