docs: mention how Cargo fetch git submodules #15853
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustbot
added
A-documenting-cargo-itself
epage
reviewed
Aug 18, 2025
Comment on lines
+310
to
+314
| To skip updates for a specific submodule, | ||
| Cargo respects the [`submodule.<name>.update`] setting in `.gitmodules`. | ||
| Setting it to `none` disables updates for that submodule if it isn't needed for the build. | ||
| This is usually set in the repository itself, | ||
| so changes require access to the dependency's repo. |
There was a problem hiding this comment.
The first paragraph talks in terms of behavior (fetch) while the second paragraph talks in terms of a git submodule specific term (update) that I worry may confuse users.
What do you think of:
Suggested change
| To skip updates for a specific submodule, | |
| Cargo respects the [`submodule.<name>.update`] setting in `.gitmodules`. | |
| Setting it to `none` disables updates for that submodule if it isn't needed for the build. | |
| This is usually set in the repository itself, | |
| so changes require access to the dependency's repo. | |
| To skip fetching submodules unrelated to the build, you can set [`submodule.<name>.update = none`] in the dependency repo's `.gitmodules`. | |
| This requires write access to the repo and will disable submodule updates more generally. |
There was a problem hiding this comment.
This seems a bit more concise and understandable!
rustbot
removed
the
S-waiting-on-review
github-merge-queue bot
pushed a commit
that referenced
this pull request
Aug 18, 2025
address <#15853 (comment)> r? epage
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR try to resolve?
Clarify how git submodules are handled in Cargo for
gitdependencies.See #4247 (comment)