Commit Graph

192 Commits

Author SHA1 Message Date
Joshua Nelson 6dd6d868e5 Update prerequisites, with an eye towards windows (#863)
* Update prerequisites, with an eye towards windows

* Address review comments

- Say version of MSVC needed
- Link to more details windows section
- Fix grammar
2020-09-09 16:24:01 +00:00
Joshua Nelson 808774289f Fix broken hyperlink (#862)
* Fix broken hyperlink

* Link to previous pages instead of skipping ahead

* Fix line lengths
2020-09-09 16:22:56 +00:00
Joshua Nelson 8623da3dab Add information about default stages for x.py 2020-09-09 11:05:26 -04:00
Joshua Nelson 794b32feac Fix typo 2020-09-09 16:58:05 +02:00
Joshua Nelson 1b40f033d2 Consolidate information about bootstrapping into one place (#851)
Previously, 'How to build and run' had a long section on the different
stages of boostrap. But new contributors aren't interested in bootstrap;
they want to start their build (because they heard it takes forever and
want to start it so they aren't waiting more than necessary).

This moves the section on stages into the bootstrapping page, and links
there instead of discussing it on the main page.
2020-09-07 15:25:11 +00:00
Tshepang Lekhonkhobe 68407cbe37 Update src/building/how-to-build-and-run.md 2020-09-07 08:55:08 -04:00
Joshua Nelson 5fac3dca3d Link to 'prerequisites' immediately
Several of the commands on 'how to build' use python.
But we haven't yet told the user how to install it!
Do that first before going into detail on how x.py works.
2020-09-07 08:55:08 -04:00
Joshua Nelson 4411cf2001 Use fewer stages in bootstrapping docs
After https://github.com/rust-lang/rust/pull/73964, they're redundant.
2020-08-31 05:19:36 +02:00
Joshua Nelson f6b1f9d49d Fix misguided suggestions in config.toml
- `verbose-tests` is for debugging the test harness, not the tests
themselves. See also https://github.com/rust-lang/rust/pull/76141
- `codegen-units` defaults to `256` whenever `incremental = true`. So
there's no need to explicitly set it to `0` if we already recommend
incremental. See also https://github.com/rust-lang/rustc-dev-guide/pull/795#discussion_r479762977.
2020-08-31 05:18:50 +02:00
mark 89f0b60ccc fix links and names after compiler mv to compiler/ 2020-08-31 05:12:13 +02:00
Aleksey Kladov 776e14a3f0 Document how to use build task for x.py check (#828) 2020-08-17 23:10:29 +09:00
Yuki Okushi 68a2b034c5 Rename `src/libstd` to `library/std` etc. (#815) 2020-07-30 22:47:22 +09:00
Jake Goulding 38aef99f68 Add basic steps for a new target (#805)
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-07-29 04:41:28 +09:00
Joshua Nelson 879ca582de Update docs to match the new x.py defaults (#813) 2020-07-29 04:20:00 +09:00
Santiago Pastorino a93d729018 Resync config.toml and suggest better settings 2020-07-14 15:03:16 -05:00
Nadrieril 6889dcc7d5 Suggest selectively disabling optimizations 2020-07-04 18:06:41 -05:00
Eric Huss 434631397b Minor updates to stage docs. (#781) 2020-07-04 00:28:44 +09:00
Joshua Nelson 089dd18f03 Fix line lengths 2020-06-28 12:15:23 -05:00
Joshua Nelson e4d6bfe303 Improve wording and fix typos
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-06-28 12:15:23 -05:00
Joshua Nelson 38e0461def Revamp bootstrapping section
- Move most of the overview to building/bootstrapping.md
- Add things besides stages to bootstrapping.md
2020-06-28 12:15:23 -05:00
Who? Me?! 7884fdfdb0 Fix formatting 2020-06-24 21:38:54 -05:00
mark 93c21dd722 address review comments 2020-06-23 12:42:06 -05:00
Florian Gilcher 59e5e68074 Add prerequisite page 2020-06-23 12:42:06 -05:00
ThePuzzlemaker c398a14f33 Add information about size for building the Rust Compiler
The Rust codebase is large, not to mention the submodules. It would be helpful for some to have a warning or note about storage required before they spend possible hours to build, only to get a message in some form that they are running out/already out of storage. I did a stage1 build incrementally and it produced a build directory of about 14 gigabytes.
2020-06-22 15:48:14 -05:00
Who? Me?! 8011445536 Fix master branch links (#757)
* fix links

* some debugging

* more debugging

* fix git checkout in ci

* try again

* already tests with a merge

* Typo

Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>

Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-06-21 20:25:43 +02:00
Joshua Nelson b5be6012f6 Don't give `x.py clean` as the first x.py example
This command shouldn't be used very often, and it has its own whole
section below anyway.
2020-06-18 04:41:59 +02:00
LeSeulArtichaut c4590c0644 Add more info on useful workflows (#727)
* Add more info on useful workflows

* Apply suggestions from code review

Co-authored-by: mark-i-m <mark-i-m@users.noreply.github.com>
Co-authored-by: spastorino <spastorino@gmail.com>

Co-authored-by: mark-i-m <mark-i-m@users.noreply.github.com>
Co-authored-by: spastorino <spastorino@gmail.com>
2020-06-03 22:46:04 +02:00
LeSeulArtichaut 2b3522a840 Document `RUSTFLAGS_STAGE_` bootstrap environment variables (#728)
* Document `RUSTFLAGS_STAGE_`

* Fix typos

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-05-30 01:20:24 +09:00
Jade McGough 05aee3ef6c Add missing closing paren (#705) 2020-05-16 21:19:52 -04:00
Jan-Erik Rediger 3b6defe682 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>
2020-04-17 21:16:56 +09:00
Paul Daniel Faria ef8048d986 Add ids to all glossary items, make existing glossary links point to glossary, add links for def id in query.md 2020-04-05 12:46:22 -05:00
LeSeulArtichaut cb99cfcc1e Rename `librustc` to `librustc_middle` 2020-03-31 15:43:14 -05:00
DillionMango b504d9c3a7 quote some commands by to make the style more consistent (#611) 2020-03-16 17:43:48 +09:00
Who? Me?! 412384a1aa More info about using local LLVM (#547)
* more info about llvm-config

* typo

Co-Authored-By: Santiago Pastorino <spastorino@gmail.com>

Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
2019-12-31 09:46:49 -03:00
Who? Me?! 3190f2a1e4 Document rustc internal env vars a little bit (#513) 2019-12-21 08:00:09 -05:00
Hanif Bin Ariffin 5306b68e05 Couple of changes to code so that its safe
Specifically, `> $1` causes it to write into the file $1 if it exist
And `> ./x.py` is particularly bad because it overwrite the script with
empty spaces...
2019-11-26 17:18:04 -06:00
Tshepang Lekhonkhobe b99a1d9554 trim down "Document rustc" 2019-11-08 10:19:32 -06:00
Tshepang Lekhonkhobe a1b8f5a26a whitespace 2019-11-08 10:19:32 -06:00
Tshepang Lekhonkhobe 847eeeaf92 fix typo 2019-11-08 10:15:21 -06:00
Who? Me?! b228631798 Fix diagram src 2019-11-05 21:57:14 -06:00
Mark Mansi 6fee93dc25 fix links 2019-11-05 21:45:49 -06:00
Mark Mansi a7633a140a breakup the building chapter 2019-11-05 21:45:49 -06:00