config.txt: move submodule part out to a separate file
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Nguyễn Thái Ngọc Duy committed
Aug 22, 2018 at 18:06 UTC
6014363f0bd054be99e9e452929c95b6f8d56f4b
2 files changed
+83
-82
Documentation/config.txt
+1
-82
@@ -2800,88 +2800,7 @@ stash.showStat::
2800
option will show diffstat of the stash entry. Defaults to true.
2801
See description of 'show' command in linkgit:git-stash[1].
2802
2803
-submodule.<name>.url::
2804
- The URL for a submodule. This variable is copied from the .gitmodules
2805
- file to the git config via 'git submodule init'. The user can change
2806
- the configured URL before obtaining the submodule via 'git submodule
2807
- update'. If neither submodule.<name>.active or submodule.active are
2808
- set, the presence of this variable is used as a fallback to indicate
2809
- whether the submodule is of interest to git commands.
2810
- See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2811
-
2812
-submodule.<name>.update::
2813
- The method by which a submodule is updated by 'git submodule update',
2814
- which is the only affected command, others such as
2815
- 'git checkout --recurse-submodules' are unaffected. It exists for
2816
- historical reasons, when 'git submodule' was the only command to
2817
- interact with submodules; settings like `submodule.active`
2818
- and `pull.rebase` are more specific. It is populated by
2819
- `git submodule init` from the linkgit:gitmodules[5] file.
2820
- See description of 'update' command in linkgit:git-submodule[1].
2821
-
2822
-submodule.<name>.branch::
2823
- The remote branch name for a submodule, used by `git submodule
2824
- update --remote`. Set this option to override the value found in
2825
- the `.gitmodules` file. See linkgit:git-submodule[1] and
2826
- linkgit:gitmodules[5] for details.
2827
-
2828
-submodule.<name>.fetchRecurseSubmodules::
2829
- This option can be used to control recursive fetching of this
2830
- submodule. It can be overridden by using the --[no-]recurse-submodules
2831
- command-line option to "git fetch" and "git pull".
2832
- This setting will override that from in the linkgit:gitmodules[5]
2833
- file.
2834
-
2835
-submodule.<name>.ignore::
2836
- Defines under what circumstances "git status" and the diff family show
2837
- a submodule as modified. When set to "all", it will never be considered
2838
- modified (but it will nonetheless show up in the output of status and
2839
- commit when it has been staged), "dirty" will ignore all changes
2840
- to the submodules work tree and
2841
- takes only differences between the HEAD of the submodule and the commit
2842
- recorded in the superproject into account. "untracked" will additionally
2843
- let submodules with modified tracked files in their work tree show up.
2844
- Using "none" (the default when this option is not set) also shows
2845
- submodules that have untracked files in their work tree as changed.
2846
- This setting overrides any setting made in .gitmodules for this submodule,
2847
- both settings can be overridden on the command line by using the
2848
- "--ignore-submodules" option. The 'git submodule' commands are not
2849
- affected by this setting.
2850
-
2851
-submodule.<name>.active::
2852
- Boolean value indicating if the submodule is of interest to git
2853
- commands. This config option takes precedence over the
2854
- submodule.active config option. See linkgit:gitsubmodules[7] for
2855
- details.
2856
-
2857
-submodule.active::
2858
- A repeated field which contains a pathspec used to match against a
2859
- submodule's path to determine if the submodule is of interest to git
2860
- commands. See linkgit:gitsubmodules[7] for details.
2861
-
2862
-submodule.recurse::
2863
- Specifies if commands recurse into submodules by default. This
2864
- applies to all commands that have a `--recurse-submodules` option,
2865
- except `clone`.
2866
- Defaults to false.
2867
-
2868
-submodule.fetchJobs::
2869
- Specifies how many submodules are fetched/cloned at the same time.
2870
- A positive integer allows up to that number of submodules fetched
2871
- in parallel. A value of 0 will give some reasonable default.
2872
- If unset, it defaults to 1.
2873
-
2874
-submodule.alternateLocation::
2875
- Specifies how the submodules obtain alternates when submodules are
2876
- cloned. Possible values are `no`, `superproject`.
2877
- By default `no` is assumed, which doesn't add references. When the
2878
- value is set to `superproject` the submodule to be cloned computes
2879
- its alternates location relative to the superprojects alternate.
2880
-
2881
-submodule.alternateErrorStrategy::
2882
- Specifies how to treat errors with the alternates for a submodule
2883
- as computed via `submodule.alternateLocation`. Possible values are
2884
- `ignore`, `info`, `die`. Default is `die`.
2803
+include::submodule-config.txt[]
2804
2805
tag.forceSignAnnotated::
2806
A boolean to specify whether annotated tags created should be GPG signed.
Documentation/submodule-config.txt
new
+82
@@ -0,0 +1,82 @@
1
+submodule.<name>.url::
2
+ The URL for a submodule. This variable is copied from the .gitmodules
3
+ file to the git config via 'git submodule init'. The user can change
4
+ the configured URL before obtaining the submodule via 'git submodule
5
+ update'. If neither submodule.<name>.active or submodule.active are
6
+ set, the presence of this variable is used as a fallback to indicate
7
+ whether the submodule is of interest to git commands.
8
+ See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
9
+
10
+submodule.<name>.update::
11
+ The method by which a submodule is updated by 'git submodule update',
12
+ which is the only affected command, others such as
13
+ 'git checkout --recurse-submodules' are unaffected. It exists for
14
+ historical reasons, when 'git submodule' was the only command to
15
+ interact with submodules; settings like `submodule.active`
16
+ and `pull.rebase` are more specific. It is populated by
17
+ `git submodule init` from the linkgit:gitmodules[5] file.
18
+ See description of 'update' command in linkgit:git-submodule[1].
19
+
20
+submodule.<name>.branch::
21
+ The remote branch name for a submodule, used by `git submodule
22
+ update --remote`. Set this option to override the value found in
23
+ the `.gitmodules` file. See linkgit:git-submodule[1] and
24
+ linkgit:gitmodules[5] for details.
25
+
26
+submodule.<name>.fetchRecurseSubmodules::
27
+ This option can be used to control recursive fetching of this
28
+ submodule. It can be overridden by using the --[no-]recurse-submodules
29
+ command-line option to "git fetch" and "git pull".
30
+ This setting will override that from in the linkgit:gitmodules[5]
31
+ file.
32
+
33
+submodule.<name>.ignore::
34
+ Defines under what circumstances "git status" and the diff family show
35
+ a submodule as modified. When set to "all", it will never be considered
36
+ modified (but it will nonetheless show up in the output of status and
37
+ commit when it has been staged), "dirty" will ignore all changes
38
+ to the submodules work tree and
39
+ takes only differences between the HEAD of the submodule and the commit
40
+ recorded in the superproject into account. "untracked" will additionally
41
+ let submodules with modified tracked files in their work tree show up.
42
+ Using "none" (the default when this option is not set) also shows
43
+ submodules that have untracked files in their work tree as changed.
44
+ This setting overrides any setting made in .gitmodules for this submodule,
45
+ both settings can be overridden on the command line by using the
46
+ "--ignore-submodules" option. The 'git submodule' commands are not
47
+ affected by this setting.
48
+
49
+submodule.<name>.active::
50
+ Boolean value indicating if the submodule is of interest to git
51
+ commands. This config option takes precedence over the
52
+ submodule.active config option. See linkgit:gitsubmodules[7] for
53
+ details.
54
+
55
+submodule.active::
56
+ A repeated field which contains a pathspec used to match against a
57
+ submodule's path to determine if the submodule is of interest to git
58
+ commands. See linkgit:gitsubmodules[7] for details.
59
+
60
+submodule.recurse::
61
+ Specifies if commands recurse into submodules by default. This
62
+ applies to all commands that have a `--recurse-submodules` option,
63
+ except `clone`.
64
+ Defaults to false.
65
+
66
+submodule.fetchJobs::
67
+ Specifies how many submodules are fetched/cloned at the same time.
68
+ A positive integer allows up to that number of submodules fetched
69
+ in parallel. A value of 0 will give some reasonable default.
70
+ If unset, it defaults to 1.
71
+
72
+submodule.alternateLocation::
73
+ Specifies how the submodules obtain alternates when submodules are
74
+ cloned. Possible values are `no`, `superproject`.
75
+ By default `no` is assumed, which doesn't add references. When the
76
+ value is set to `superproject` the submodule to be cloned computes
77
+ its alternates location relative to the superprojects alternate.
78
+
79
+submodule.alternateErrorStrategy::
80
+ Specifies how to treat errors with the alternates for a submodule
81
+ as computed via `submodule.alternateLocation`. Possible values are
82
+ `ignore`, `info`, `die`. Default is `die`.