diff options
| author |  Sebastian Schuberth <sschuberth@gmail.com> | 2017-04-19 09:15:15 +0000 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2017-04-19 20:03:56 -0700 |
| commit | 61e282425abd78605524322f05a49866b2c9e70e (patch) | |
| tree | fec5a8cb5114951ddb4bed519d1c1d0062fed630 | |
| parent | Prepare for 2.12.3 (diff) | |
| download | tgif-61e282425abd78605524322f05a49866b2c9e70e.tar.xz | |
gitmodules: clarify the ignore option values
Add more structure and describe each possible option in a self-contained
way, not referring to any of the previously described options.
Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/gitmodules.txt | 31 |
1 files changed, 20 insertions, 11 deletions
diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt index 8f7c50f330..470062413f 100644 --- a/Documentation/gitmodules.txt +++ b/Documentation/gitmodules.txt @@ -66,17 +66,26 @@ submodule.<name>.fetchRecurseSubmodules:: submodule.<name>.ignore:: Defines under what circumstances "git status" and the diff family show - a submodule as modified. When set to "all", it will never be considered - modified (but will nonetheless show up in the output of status and - commit when it has been staged), "dirty" will ignore all changes - to the submodules work tree and - takes only differences between the HEAD of the submodule and the commit - recorded in the superproject into account. "untracked" will additionally - let submodules with modified tracked files in their work tree show up. - Using "none" (the default when this option is not set) also shows - submodules that have untracked files in their work tree as changed. - If this option is also present in the submodules entry in .git/config of - the superproject, the setting there will override the one found in + a submodule as modified. The following values are supported: + + all;; The submodule will never be considered modified (but will + nonetheless show up in the output of status and commit when it has + been staged). + + dirty;; All changes to the submodule's work tree will be ignored, only + committed differences between the HEAD of the submodule and its + recorded state in the superproject are taken into account. + + untracked;; Only untracked files in submodules will be ignored. + Committed differences and modifications to tracked files will show + up. + + none;; No modifiations to submodules are ignored, all of committed + differences, and modifications to tracked and untracked files are + shown. This is the default option. + + If this option is also present in the submodules entry in .git/config + of the superproject, the setting there will override the one found in .gitmodules. Both settings can be overridden on the command line by using the "--ignore-submodule" option. The 'git submodule' commands are not |