mirror of
https://github.com/git/git
synced 2024-08-24 18:26:02 +00:00
gitsubmodules doc: invoke 'ls-files' with '--recurse-submodules'
`git ls-files` was never taught to respect the `submodule.recurse` configuration variable, and it is too late now to change that [1], but still the command is mentioned in 'gitsubmodules(7)' as if it does respect that config. Adjust the call in 'gitsubmodules(7)' by calling 'ls-files' with the '--recurse-submodules' option. While at it, uniformize the capitalization in that file, and use backticks instead of quotes for Git commands and configuration variables. [1] https://lore.kernel.org/git/pull.732.git.1599707259907.gitgitgadget@gmail.com/T/#u Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
ab4691b67b
commit
7d15fdbe4c
|
@ -225,10 +225,10 @@ presence of the .url field.
|
||||||
Workflow for a third party library
|
Workflow for a third party library
|
||||||
----------------------------------
|
----------------------------------
|
||||||
|
|
||||||
# add a submodule
|
# Add a submodule
|
||||||
git submodule add <url> <path>
|
git submodule add <url> <path>
|
||||||
|
|
||||||
# occasionally update the submodule to a new version:
|
# Occasionally update the submodule to a new version:
|
||||||
git -C <path> checkout <new version>
|
git -C <path> checkout <new version>
|
||||||
git add <path>
|
git add <path>
|
||||||
git commit -m "update submodule to new version"
|
git commit -m "update submodule to new version"
|
||||||
|
@ -246,20 +246,23 @@ Workflow for an artificially split repo
|
||||||
# regular commands recurse into submodules by default
|
# regular commands recurse into submodules by default
|
||||||
git config --global submodule.recurse true
|
git config --global submodule.recurse true
|
||||||
|
|
||||||
# Unlike the other commands below clone still needs
|
# Unlike most other commands below, clone still needs
|
||||||
# its own recurse flag:
|
# its own recurse flag:
|
||||||
git clone --recurse <URL> <directory>
|
git clone --recurse <URL> <directory>
|
||||||
cd <directory>
|
cd <directory>
|
||||||
|
|
||||||
# Get to know the code:
|
# Get to know the code:
|
||||||
git grep foo
|
git grep foo
|
||||||
git ls-files
|
git ls-files --recurse-submodules
|
||||||
|
|
||||||
|
[NOTE]
|
||||||
|
`git ls-files` also requires its own `--recurse-submodules` flag.
|
||||||
|
|
||||||
# Get new code
|
# Get new code
|
||||||
git fetch
|
git fetch
|
||||||
git pull --rebase
|
git pull --rebase
|
||||||
|
|
||||||
# change worktree
|
# Change worktree
|
||||||
git checkout
|
git checkout
|
||||||
git reset
|
git reset
|
||||||
|
|
||||||
|
@ -267,12 +270,12 @@ Implementation details
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
When cloning or pulling a repository containing submodules the submodules
|
When cloning or pulling a repository containing submodules the submodules
|
||||||
will not be checked out by default; You can instruct 'clone' to recurse
|
will not be checked out by default; you can instruct `clone` to recurse
|
||||||
into submodules. The 'init' and 'update' subcommands of 'git submodule'
|
into submodules. The `init` and `update` subcommands of `git submodule`
|
||||||
will maintain submodules checked out and at an appropriate revision in
|
will maintain submodules checked out and at an appropriate revision in
|
||||||
your working tree. Alternatively you can set 'submodule.recurse' to have
|
your working tree. Alternatively you can set `submodule.recurse` to have
|
||||||
'checkout' recursing into submodules (note that 'submodule.recurse' also
|
`checkout` recursing into submodules (note that `submodule.recurse` also
|
||||||
affects other git commands, see linkgit:git-config[1] for a complete list).
|
affects other Git commands, see linkgit:git-config[1] for a complete list).
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
|
|
Loading…
Reference in a new issue