Skip to content

Commit 9536d1b

Browse files
committed
Merge branch 'pb/doc-modules-git-work-tree-typofix' into maint
Doc fix. * pb/doc-modules-git-work-tree-typofix: gitmodules.txt: fix 'GIT_WORK_TREE' variable name
2 parents 9874ff5 + 1f4e931 commit 9536d1b

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

Documentation/gitmodules.txt

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ gitmodules - Defining submodule properties
77

88
SYNOPSIS
99
--------
10-
$GIT_WORK_DIR/.gitmodules
10+
$GIT_WORK_TREE/.gitmodules
1111

1212

1313
DESCRIPTION
@@ -27,19 +27,19 @@ submodule.<name>.path::
2727
Defines the path, relative to the top-level directory of the Git
2828
working tree, where the submodule is expected to be checked out.
2929
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.
3131

3232
submodule.<name>.url::
3333
Defines a URL from which the submodule repository can be cloned.
3434
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
3636
relative to the superproject's origin repository.
3737

3838
In addition, there are a number of optional keys:
3939

4040
submodule.<name>.update::
4141
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`
4343
command in the superproject. This is only used by `git
4444
submodule init` to initialize the configuration variable of
4545
the same name. Allowed values here are 'checkout', 'rebase',
@@ -49,22 +49,22 @@ submodule.<name>.update::
4949

5050
submodule.<name>.branch::
5151
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`.
5353
A special value of `.` is used to indicate that the name of the branch
5454
in the submodule should be the same name as the current branch in the
5555
current repository. See the `--remote` documentation in
5656
linkgit:git-submodule[1] for details.
5757

5858
submodule.<name>.fetchRecurseSubmodules::
5959
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`.
6363
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`.
6565

6666
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
6868
a submodule as modified. The following values are supported:
6969
+
7070
--
@@ -73,7 +73,7 @@ submodule.<name>.ignore::
7373
been staged).
7474

7575
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
7777
recorded state in the superproject are taken into account.
7878

7979
untracked;; Only untracked files in submodules will be ignored.
@@ -84,12 +84,12 @@ submodule.<name>.ignore::
8484
differences, and modifications to tracked and untracked files are
8585
shown. This is the default option.
8686

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`
8888
of the superproject, the setting there will override the one found in
89-
.gitmodules.
89+
`.gitmodules`.
9090

9191
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
9393
affected by this setting.
9494
--
9595

@@ -102,7 +102,7 @@ submodule.<name>.shallow::
102102
EXAMPLES
103103
--------
104104

105-
Consider the following .gitmodules file:
105+
Consider the following `.gitmodules` file:
106106

107107
----
108108
[submodule "libfoo"]

0 commit comments

Comments
 (0)