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-18 12:35:15 -0500
committerWho? Me?! <mark-i-m@users.noreply.github.com>2020-06-23 12:42:06 -0500
commitde85be491f9e14964a354fc1c720536aac44ef88 (patch)
treeeb08d745f78baac7db92a099735646d456ba927f /src/doc/rustc-dev-guide
parent5fefd83bd133e9893a9aa6e243766aedd391115e (diff)
downloadrust-de85be491f9e14964a354fc1c720536aac44ef88.tar.gz
rust-de85be491f9e14964a354fc1c720536aac44ef88.zip
address review comments
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/building/prerequisites.md37
1 files changed, 32 insertions, 5 deletions
diff --git a/src/doc/rustc-dev-guide/src/building/prerequisites.md b/src/doc/rustc-dev-guide/src/building/prerequisites.md
index 9db18778d39..3224c6dab64 100644
--- a/src/doc/rustc-dev-guide/src/building/prerequisites.md
+++ b/src/doc/rustc-dev-guide/src/building/prerequisites.md
@@ -1,15 +1,42 @@
 # Prerequisites
 
+## Dependencies
+
 Before building the compiler, you need the following things installed:
 
-* Python
-* A C/C++ compiler toolchain
-* cmake
-* rustc
+* `g++` 5.1 or later or `clang++` 3.5 or later
+* `python` 3 or 2.7
+* GNU `make` 3.81 or later
+* `cmake` 3.4.3 or later
+* `curl`
+* `git`
+* `ssl` which comes in `libssl-dev` or `openssl-devel`
+* `pkg-config` if you are compiling on Linux and targeting Linux
+
+Additionally, if you want to build `rustc` with your system's LLVM, you will
+need `llvm-config`. See [this section for more info][sysllvm].
+
+[sysllvm]: ./suggested.md#building-with-system-llvm
+
+## Hardware
+
+These are not so much requirements as _recommendations_:
+
+* ~15GB of free disk space (~25GB or more if doing incremental builds).
+* >= 8GB RAM
+* >= 4 cores
+* Internet access
+
+Beefier machines will lead to much faster builds. If your machine is not very
+powerful, a common strategy is to only use `./x.py check` on your local machine
+and let the CI build test your changes when you push to a PR branch.
 
 ## `rustc` and toolchain installation
 
-Follow the installation given in the [Rust book](https://doc.rust-lang.org/book/ch01-01-installation.html) to install a working `rustc` and the necessary C/++ toolchain on your platform.
+Follow the installation given in the [Rust book][install] to install a working
+`rustc` and the necessary C/++ toolchain on your platform.
+
+[install]: https://doc.rust-lang.org/book/ch01-01-installation.html
 
 ## Platform specific instructions