itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-09-25 11:14:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: mention how Cargo fetch git submodules (#15853)

Browse Source 
### What does this PR try to resolve?

Clarify how git submodules are handled in Cargo for `git` dependencies.

See
https://github.com/rust-lang/cargo/issues/4247#issuecomment-3160707916
This commit is contained in:
Eric Huss 2025-08-18 15:21:27 +00:00 committed by GitHub
commit 62537dd3ef
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/doc/src/reference/specifying-dependencies.md
View File

@ -301,6 +301,20 @@ See [Multiple locations](#multiple-locations) section below for detailed explana
> locations](#multiple-locations) section for a fallback alternative for `git`
> and `path` dependencies.
### Git submodules
When cloning a `git` dependency,
Cargo automatically fetches its submodules recursively
so that all required code is available for the build.
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.
[`submodule.<name>.update`]: https://git-scm.com/docs/gitmodules#Documentation/gitmodules.txt-submodulenameupdate
### Accessing private Git repositories
See [Git Authentication](../appendix/git-authentication.md) for help with Git authentication for private repos.