about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authormark <markm@cs.wisc.edu>2020-06-05 11:25:48 -0500
committerWho? Me?! <mark-i-m@users.noreply.github.com>2020-06-18 12:16:00 -0500
commit286f8bcd7ac3604f126fbf7d09f25c1ff6ee8daa (patch)
tree9a179fd3ff213f83cded0991914b656c9e99c868 /src/doc/rustc-dev-guide
parent8cf37d29d5aad56c6a989a5691c846b135195346 (diff)
downloadrust-286f8bcd7ac3604f126fbf7d09f25c1ff6ee8daa.tar.gz
rust-286f8bcd7ac3604f126fbf7d09f25c1ff6ee8daa.zip
add note on submodules
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/getting-started.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/src/doc/rustc-dev-guide/src/getting-started.md b/src/doc/rustc-dev-guide/src/getting-started.md
index 2d11edf8e0a..d5a4c51b394 100644
--- a/src/doc/rustc-dev-guide/src/getting-started.md
+++ b/src/doc/rustc-dev-guide/src/getting-started.md
@@ -97,7 +97,16 @@ You can just do a normal git clone:
 git clone https://github.com/rust-lang/rust.git
 ```
 
-You don't need to clone the submodules at this time.
+You don't need to clone the submodules at this time. But if you want to, you
+can do the following:
+
+```sh
+# first time
+git submodule update --init --recursive
+
+# subsequent times (to pull new commits)
+git submodule update
+```
 
 **Pro tip**: if you contribute often, you may want to look at the git worktrees
 tip in [this chapter][suggested].