Browse Source

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 <avarab@gmail.com>
Reviewed-by: Matheus Tavares <matheus.bernardino@usp.br>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Ævar Arnfjörð Bjarmason 3 years ago committed by Junio C Hamano
parent
commit
16f6b0d1aa
  1. 7
      Documentation/git-add.txt
  2. 7
      Documentation/git-am.txt
  3. 7
      Documentation/git-clean.txt
  4. 7
      Documentation/git-clone.txt
  5. 7
      Documentation/git-commit-graph.txt
  6. 4
      Documentation/git-commit.txt
  7. 7
      Documentation/git-fast-import.txt
  8. 7
      Documentation/git-mailinfo.txt
  9. 7
      Documentation/git-maintenance.txt
  10. 7
      Documentation/git-push.txt
  11. 7
      Documentation/git-revert.txt
  12. 7
      Documentation/git-show-branch.txt
  13. 7
      Documentation/git-stash.txt

7
Documentation/git-add.txt

@ -431,6 +431,13 @@ they will make the patch impossible to apply:
* deleting context or removal lines * deleting context or removal lines
* modifying the contents of 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 SEE ALSO
-------- --------
linkgit:git-status[1] linkgit:git-status[1]

7
Documentation/git-am.txt

@ -261,6 +261,13 @@ This command can run `applypatch-msg`, `pre-applypatch`,
and `post-applypatch` hooks. See linkgit:githooks[5] for more and `post-applypatch` hooks. See linkgit:githooks[5] for more
information. information.


CONFIGURATION
-------------

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

include::config/am.txt[]

SEE ALSO SEE ALSO
-------- --------
linkgit:git-apply[1]. linkgit:git-apply[1].

7
Documentation/git-clean.txt

@ -133,6 +133,13 @@ help::


Show brief usage of interactive git-clean. Show brief usage of interactive git-clean.


CONFIGURATION
-------------

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

include::config/clean.txt[]

SEE ALSO SEE ALSO
-------- --------
linkgit:gitignore[5] linkgit:gitignore[5]

7
Documentation/git-clone.txt

@ -363,6 +363,13 @@ $ cd my-linux
$ git clone --bare -l /home/proj/.git /pub/scm/proj.git $ git clone --bare -l /home/proj/.git /pub/scm/proj.git
------------ ------------


CONFIGURATION
-------------

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

include::config/clone.txt[]



GIT GIT
--- ---

7
Documentation/git-commit-graph.txt

@ -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 $ git rev-parse HEAD | git commit-graph write --stdin-commits --append
------------------------------------------------ ------------------------------------------------


CONFIGURATION
-------------

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

include::config/commitgraph.txt[]



GIT GIT
--- ---

4
Documentation/git-commit.txt

@ -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 `VISUAL` environment variable, or the `EDITOR` environment variable (in that
order). See linkgit:git-var[1] for details. order). See linkgit:git-var[1] for details.


include::includes/cmd-config-section-rest.txt[]

include::config/commit.txt[]

HOOKS HOOKS
----- -----
This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`, This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,

7
Documentation/git-fast-import.txt

@ -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 import in progress, at the cost of some added running time and worse
compression. compression.


CONFIGURATION
-------------

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

include::config/fastimport.txt[]

SEE ALSO SEE ALSO
-------- --------
linkgit:git-fast-export[1] linkgit:git-fast-export[1]

7
Documentation/git-mailinfo.txt

@ -115,6 +115,13 @@ If no such configuration option has been set, `warn` will be used.
<patch>:: <patch>::
The patch extracted from e-mail. The patch extracted from e-mail.


CONFIGURATION
-------------

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

include::config/mailinfo.txt[]

GIT GIT
--- ---
Part of the linkgit:git[1] suite Part of the linkgit:git[1] suite

7
Documentation/git-maintenance.txt

@ -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 so future calls to `git maintenance (start|stop)` do not overwrite your
custom tasks. custom tasks.


CONFIGURATION
-------------

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

include::config/maintenance.txt[]



GIT GIT
--- ---

7
Documentation/git-push.txt

@ -692,6 +692,13 @@ a `git gc` command on the origin repository.


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


CONFIGURATION
-------------

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

include::config/push.txt[]

GIT GIT
--- ---
Part of the linkgit:git[1] suite Part of the linkgit:git[1] suite

7
Documentation/git-revert.txt

@ -145,6 +145,13 @@ EXAMPLES
changes. The revert only modifies the working tree and the changes. The revert only modifies the working tree and the
index. index.


CONFIGURATION
-------------

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

include::config/revert.txt[]

SEE ALSO SEE ALSO
-------- --------
linkgit:git-cherry-pick[1] linkgit:git-cherry-pick[1]

7
Documentation/git-show-branch.txt

@ -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 Without `--list`, the output also shows how these tips are
topologically related with each other. topologically related with each other.


CONFIGURATION
-------------

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

include::config/showbranch.txt[]

GIT GIT
--- ---
Part of the linkgit:git[1] suite Part of the linkgit:git[1] suite

7
Documentation/git-stash.txt

@ -382,6 +382,13 @@ grep commit | cut -d\ -f3 |
xargs git log --merges --no-walk --grep=WIP xargs git log --merges --no-walk --grep=WIP
---------------------------------------------------------------- ----------------------------------------------------------------


CONFIGURATION
-------------

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

include::config/stash.txt[]



SEE ALSO SEE ALSO
-------- --------

Loading…
Cancel
Save