]> git.ipfire.org Git - thirdparty/git.git/commitdiff
docs: add CONFIGURATION sections that map to a built-in
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>
Wed, 7 Sep 2022 08:27:04 +0000 (10:27 +0200)
committerJunio C Hamano <gitster@pobox.com>
Wed, 7 Sep 2022 16:46:06 +0000 (09:46 -0700)
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 <avarab@gmail.com>
Reviewed-by: Matheus Tavares <matheus.bernardino@usp.br>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
13 files changed:
Documentation/git-add.txt
Documentation/git-am.txt
Documentation/git-clean.txt
Documentation/git-clone.txt
Documentation/git-commit-graph.txt
Documentation/git-commit.txt
Documentation/git-fast-import.txt
Documentation/git-mailinfo.txt
Documentation/git-maintenance.txt
Documentation/git-push.txt
Documentation/git-revert.txt
Documentation/git-show-branch.txt
Documentation/git-stash.txt

index 11eb70f16c7287d53b567368754a19f33d4c7fb2..36da8bf9b511ca0281f5713ec09ac9272b76dc0b 100644 (file)
@@ -431,6 +431,13 @@ they will make the patch impossible to apply:
 * deleting context or removal lines
 * modifying the contents of context or removal lines
 
+CONFIGURATION
+-------------
+
+include::includes/cmd-config-section-all.txt[]
+
+include::config/add.txt[]
+
 SEE ALSO
 --------
 linkgit:git-status[1]
index 09107fb106703d14c9e695685e93f59e15362fc3..7ccb46b660c51cc50c31541d02c13568450fa40d 100644 (file)
@@ -261,6 +261,13 @@ This command can run `applypatch-msg`, `pre-applypatch`,
 and `post-applypatch` hooks.  See linkgit:githooks[5] for more
 information.
 
+CONFIGURATION
+-------------
+
+include::includes/cmd-config-section-all.txt[]
+
+include::config/am.txt[]
+
 SEE ALSO
 --------
 linkgit:git-apply[1].
index a7f309dff5a327ba14b38b63b931060582c53c28..91742633fa878922d23bc78e1aeec9a638994d38 100644 (file)
@@ -133,6 +133,13 @@ help::
 
   Show brief usage of interactive git-clean.
 
+CONFIGURATION
+-------------
+
+include::includes/cmd-config-section-all.txt[]
+
+include::config/clean.txt[]
+
 SEE ALSO
 --------
 linkgit:gitignore[5]
index 632bd1348ea14deb067144f187e7f57c0cf2ae60..b9ee8a872383b6ec1737b0fa257ee555fa7321a1 100644 (file)
@@ -363,6 +363,13 @@ $ cd my-linux
 $ git clone --bare -l /home/proj/.git /pub/scm/proj.git
 ------------
 
+CONFIGURATION
+-------------
+
+include::includes/cmd-config-section-all.txt[]
+
+include::config/clone.txt[]
+
 
 GIT
 ---
index e1f48c95b3ca37e67af88e634a44db88dd1ca6a9..5225f674546a4a388be7819351749f205f4ccd00 100644 (file)
@@ -142,6 +142,13 @@ $ git show-ref -s | git commit-graph write --stdin-commits
 $ git rev-parse HEAD | git commit-graph write --stdin-commits --append
 ------------------------------------------------
 
+CONFIGURATION
+-------------
+
+include::includes/cmd-config-section-all.txt[]
+
+include::config/commitgraph.txt[]
+
 
 GIT
 ---
index 6c60bf98f9f73ad9a892337c23c5a7f9b31b3eec..225c6c9f2e5f8f513e1e56ae77bc45d8c2097da4 100644 (file)
@@ -557,6 +557,10 @@ The editor used to edit the commit log message will be chosen from the
 `VISUAL` environment variable, or the `EDITOR` environment variable (in that
 order).  See linkgit:git-var[1] for details.
 
+include::includes/cmd-config-section-rest.txt[]
+
+include::config/commit.txt[]
+
 HOOKS
 -----
 This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
index 39cfa05b28b0126544b5ed8b89e0fd1b697c3e09..8b5dd6add006d111688fc1193d77ebe6b45422a5 100644 (file)
@@ -1564,6 +1564,13 @@ operator can use this facility to peek at the objects and refs from an
 import in progress, at the cost of some added running time and worse
 compression.
 
+CONFIGURATION
+-------------
+
+include::includes/cmd-config-section-all.txt[]
+
+include::config/fastimport.txt[]
+
 SEE ALSO
 --------
 linkgit:git-fast-export[1]
index 3fcfd965fdec62613567278dbd7b08b0080778c7..28060283c703a991d4d2aa36b99b867b8d6c8d43 100644 (file)
@@ -115,6 +115,13 @@ If no such configuration option has been set, `warn` will be used.
 <patch>::
        The patch extracted from e-mail.
 
+CONFIGURATION
+-------------
+
+include::includes/cmd-config-section-all.txt[]
+
+include::config/mailinfo.txt[]
+
 GIT
 ---
 Part of the linkgit:git[1] suite
index e56bad28c6551f0f0a1990f245da4f551df74178..9c630efe19c68ec4b25fee1cf716c5a2073e2f51 100644 (file)
@@ -397,6 +397,13 @@ If you want to customize the background tasks, please rename the tasks
 so future calls to `git maintenance (start|stop)` do not overwrite your
 custom tasks.
 
+CONFIGURATION
+-------------
+
+include::includes/cmd-config-section-all.txt[]
+
+include::config/maintenance.txt[]
+
 
 GIT
 ---
index 2f25aa3a291b529be87823765e295934f62484e6..def7657ef9cb71b5da3eb36b2b8f439f172651a3 100644 (file)
@@ -692,6 +692,13 @@ a `git gc` command on the origin repository.
 
 include::transfer-data-leaks.txt[]
 
+CONFIGURATION
+-------------
+
+include::includes/cmd-config-section-all.txt[]
+
+include::config/push.txt[]
+
 GIT
 ---
 Part of the linkgit:git[1] suite
index 8463fe9cf75a3e9aa9cd2dced9907c6c00a87693..700f937f60ae05137f50dcc0db880c45d2cc8627 100644 (file)
@@ -145,6 +145,13 @@ EXAMPLES
        changes. The revert only modifies the working tree and the
        index.
 
+CONFIGURATION
+-------------
+
+include::includes/cmd-config-section-all.txt[]
+
+include::config/revert.txt[]
+
 SEE ALSO
 --------
 linkgit:git-cherry-pick[1]
index 5cc2fcefbab1bcc80b33192e7ac06a3a5a92efd2..e5ec6b467f9f3f765d31949725ddc0c7c634391f 100644 (file)
@@ -199,6 +199,13 @@ shows 10 reflog entries going back from the tip as of 1 hour ago.
 Without `--list`, the output also shows how these tips are
 topologically related with each other.
 
+CONFIGURATION
+-------------
+
+include::includes/cmd-config-section-all.txt[]
+
+include::config/showbranch.txt[]
+
 GIT
 ---
 Part of the linkgit:git[1] suite
index 6e15f47525765ce3da66b793ab519abd1cd90784..c5d70918283836d9a57c1af4710ce69fba78e3f1 100644 (file)
@@ -382,6 +382,13 @@ grep commit | cut -d\  -f3 |
 xargs git log --merges --no-walk --grep=WIP
 ----------------------------------------------------------------
 
+CONFIGURATION
+-------------
+
+include::includes/cmd-config-section-all.txt[]
+
+include::config/stash.txt[]
+
 
 SEE ALSO
 --------