about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorJan-Erik Rediger <badboy@archlinux.us>2020-04-17 14:16:56 +0200
committerGitHub <noreply@github.com>2020-04-17 21:16:56 +0900
commit6984d17a5eda87cbfeb46f2e7dccef0de862af57 (patch)
treef838ca3aae73629b54deeb4af7e0991003cc5e4f /src/doc/rustc-dev-guide
parentab1948fdb9f5ffbe44c2391460700ee38007a846 (diff)
downloadrust-6984d17a5eda87cbfeb46f2e7dccef0de862af57.tar.gz
rust-6984d17a5eda87cbfeb46f2e7dccef0de862af57.zip
Start with the basics (#675)
* The very first step should be to clone the repository

* Make the command copy-able

By having the plain command users can select and copy the text and paste
it, without needing to fiddle around to remove extra characters.

Now that the previous command switched directories it is not necessary
to be called out here again either.

* Update src/building/how-to-build-and-run.md

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/building/how-to-build-and-run.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/src/doc/rustc-dev-guide/src/building/how-to-build-and-run.md b/src/doc/rustc-dev-guide/src/building/how-to-build-and-run.md
index dbe1f4c7ae4..5171e5f31fd 100644
--- a/src/doc/rustc-dev-guide/src/building/how-to-build-and-run.md
+++ b/src/doc/rustc-dev-guide/src/building/how-to-build-and-run.md
@@ -6,6 +6,15 @@ be hacking on `rustc`, you'll want to tweak the configuration of the compiler.
 The default configuration is oriented towards running the compiler as a user,
 not a developer.
 
+## Get the source code
+
+The very first step to work on `rustc` is to clone the repository:
+
+```bash
+git clone https://github.com/rust-lang/rust.git
+cd rust
+```
+
 ## Create a config.toml
 
 To start, copy [`config.toml.example`] to `config.toml`:
@@ -13,8 +22,7 @@ To start, copy [`config.toml.example`] to `config.toml`:
 [`config.toml.example`]: https://github.com/rust-lang/rust/blob/master/config.toml.example
 
 ```bash
-> cd $RUST_CHECKOUT
-> cp config.toml.example config.toml
+cp config.toml.example config.toml
 ```
 
 Then you will want to open up the file and change the following