gitmodules.txt: fix 'GIT_WORK_TREE' variable name
'gitmodules.txt' is a guide about the '.gitmodules' file that describes submodule properties, and that file must exist at the root of the repository. This was clarified in e5b5c1d2cf (Document clarification: gitmodules, gitattributes, 2008-08-31). However, that commit mistakenly uses the non-existing environment variable 'GIT_WORK_DIR' to refer to the root of the repository. Fix that by using the correct variable, 'GIT_WORK_TREE'. Take the opportunity to modernize and improve the formatting of that guide, and fix a grammar mistake. Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com> Acked-by: Martin Ågren <martin.agren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Philippe Blain committed
Jan 3, 2021 at 17:42 UTC
1f4e9319c7ce25efbb4e8469eff11c53dd079318
1 file changed
+15
-15
Documentation/gitmodules.txt
+15
-15
@@ -7,7 +7,7 @@ gitmodules - Defining submodule properties
7
8
SYNOPSIS
9
--------
10
-$GIT_WORK_DIR/.gitmodules
10
+$GIT_WORK_TREE/.gitmodules
11
12
13
DESCRIPTION
@@ -27,19 +27,19 @@ submodule.<name>.path::
27
Defines the path, relative to the top-level directory of the Git
28
working tree, where the submodule is expected to be checked out.
29
The path name must not end with a `/`. All submodule paths must
30
- be unique within the .gitmodules file.
30
+ be unique within the `.gitmodules` file.
31
32
submodule.<name>.url::
33
Defines a URL from which the submodule repository can be cloned.
34
This may be either an absolute URL ready to be passed to
35
- linkgit:git-clone[1] or (if it begins with ./ or ../) a location
35
+ linkgit:git-clone[1] or (if it begins with `./` or `../`) a location
36
relative to the superproject's origin repository.
37
38
In addition, there are a number of optional keys:
39
40
submodule.<name>.update::
41
Defines the default update procedure for the named submodule,
42
- i.e. how the submodule is updated by "git submodule update"
42
+ i.e. how the submodule is updated by the `git submodule update`
43
command in the superproject. This is only used by `git
44
submodule init` to initialize the configuration variable of
45
the same name. Allowed values here are 'checkout', 'rebase',
@@ -49,7 +49,7 @@ submodule.<name>.update::
49
50
submodule.<name>.branch::
51
A remote branch name for tracking updates in the upstream submodule.
52
- If the option is not specified, it defaults to the remote 'HEAD'.
52
+ If the option is not specified, it defaults to the remote `HEAD`.
53
A special value of `.` is used to indicate that the name of the branch
54
in the submodule should be the same name as the current branch in the
55
current repository. See the `--remote` documentation in
@@ -57,14 +57,14 @@ submodule.<name>.branch::
57
58
submodule.<name>.fetchRecurseSubmodules::
59
This option can be used to control recursive fetching of this
60
- submodule. If this option is also present in the submodules entry in
61
- .git/config of the superproject, the setting there will override the
62
- one found in .gitmodules.
60
+ submodule. If this option is also present in the submodule's entry in
61
+ `.git/config` of the superproject, the setting there will override the
62
+ one found in `.gitmodules`.
63
Both settings can be overridden on the command line by using the
64
- "--[no-]recurse-submodules" option to "git fetch" and "git pull".
64
+ `--[no-]recurse-submodules` option to `git fetch` and `git pull`.
65
66
submodule.<name>.ignore::
67
- Defines under what circumstances "git status" and the diff family show
67
+ Defines under what circumstances `git status` and the diff family show
68
a submodule as modified. The following values are supported:
69
+
70
--
@@ -73,7 +73,7 @@ submodule.<name>.ignore::
73
been staged).
74
75
dirty;; All changes to the submodule's work tree will be ignored, only
76
- committed differences between the HEAD of the submodule and its
76
+ committed differences between the `HEAD` of the submodule and its
77
recorded state in the superproject are taken into account.
78
79
untracked;; Only untracked files in submodules will be ignored.
@@ -84,12 +84,12 @@ submodule.<name>.ignore::
84
differences, and modifications to tracked and untracked files are
85
shown. This is the default option.
86
87
-If this option is also present in the submodules entry in .git/config
87
+If this option is also present in the submodule's entry in `.git/config`
88
of the superproject, the setting there will override the one found in
89
-.gitmodules.
89
+`.gitmodules`.
90
91
Both settings can be overridden on the command line by using the
92
-"--ignore-submodules" option. The 'git submodule' commands are not
92
+`--ignore-submodules` option. The `git submodule` commands are not
93
affected by this setting.
94
--
95
@@ -102,7 +102,7 @@ submodule.<name>.shallow::
102
EXAMPLES
103
--------
104
105
-Consider the following .gitmodules file:
105
+Consider the following `.gitmodules` file:
106
107
----
108
[submodule "libfoo"]