Commit Graph

192 Commits

Author SHA1 Message Date
Joshua Nelson 4dcc29161b Remove docs on Assemble step (#1233) 2021-10-18 02:17:19 +09:00
Noah Lev 632f2b7484 Recommend `rustfmt --edition=2021` 2021-10-10 08:28:12 -05:00
Frank Steffahn 99e53983ad Make indentation consistent in example vscode config file 2021-09-17 16:52:56 -05:00
Frank Steffahn ee4b32b958 Suggests `--edition=2018` argument when using stage0/bin/rustfmt directly 2021-09-17 14:53:44 -05:00
Andrey Cherkashin 6b747c6cf2 remove ctag section 2021-09-08 15:13:44 -05:00
Andrey Cherkashin ce27f4801d Update suggested.md 2021-09-08 15:13:44 -05:00
Andrey Cherkashin 4105934b90 Move ctag section to "Suggested Workflow" 2021-09-08 15:13:44 -05:00
Andrey Cherkashin 7c4410ed50 Delete ctags.md 2021-09-08 15:13:44 -05:00
Joshua Nelson 8b64a80ccc Add rustc-source to suggested rust-analyzer config (#1189)
This allows loading the sources for crates loaded from the sysroot.
2021-08-31 10:13:18 -07:00
Rahul Butani 6893645e60 Remove a dead link in `new-target.md` + other nits (#1186) 2021-08-10 20:41:44 +09:00
Ben Reeves a7f22be835 Fix typo in building/bootstrapping.md (#1175) 2021-07-26 00:37:28 +02:00
Jade 18493f62b0 Add suggested settings note for coc (#1144) 2021-06-13 01:17:06 +09:00
二手掉包工程师 3f01b29957 Unified CPU Requirements (#1126) 2021-05-10 13:38:24 +09:00
Joshua Nelson 90e1d1fa43 Add sample nix shell
This also suggests using `x.py setup` instead of copying config.toml.
2021-04-27 08:52:22 -04:00
Ralf Jung 6bace78929 more RA config suggestions (#1114) 2021-04-26 18:34:50 -04:00
AngelicosPhosphoros fd8f1fee4e Mention CI build of LLVM in build instruction 2021-04-03 22:28:35 -04:00
Wesley Wiser 0c6cccc215 Update cmake version in prerequisites.md (#1077)
LLVM requires at least cmake 3.13.4.

https://www.llvm.org/docs/CMake.html
2021-03-09 20:00:12 +01:00
Camelid d6f81b211f Restore instructions for using system LLVM
They were removed in #1030, but are still useful.
2021-02-26 15:38:01 -05:00
Camelid 4895d26d5e Update some out-of-date information 2021-02-26 15:38:01 -05:00
dmezh c6cf4c04da Fix typo (#1063) 2021-02-18 19:37:43 +01:00
Joshua Nelson 2e19c8ecc0 Document how to stabilize a library feature (#1036)
* Move 'force-unstable-if-unmarked' to the bootstrapping chapter

* Document how to stabilize a library feature

Note that features can't be stabilized until they go through FCP and
that FCP happens on the tracking issue, not the PR.

* Fix wrong glob

By default `**` behaves the same as two `*` side by side, i.e. it only
globs file paths, not directories. `shopt -s globstar` needs to be set
for it to mean a directory. I didn't notice this before now because
`globstar` is set by default in interactive mode, but not otherwise.
2021-02-01 19:31:00 +01:00
Henry Boisdequin 21745b2014 put `x.py` in ticks 2021-01-30 10:59:57 +02:00
Joshua Nelson 53a45a9a19 Remove "Skipping LLVM build" section
`download-ci-llvm` is available and enabled by default for all tier 1
platforms, so there is no need to change it. Using system LLVM over CI
llvm is still supported, but is not recommended. Building LLVM from
source is still supported.

This also notes that you need to explicitly disable downloading LLVM
when updating the submodule.
2021-01-20 13:45:05 -05:00
Iñaki Garay 7a80b01e01 Add mdbook-toc, markers, and documentation (#1028)
* Add mdbook-toc to travis, book.toml  and documentation

* Add toc markers

* Whitespace cleanup and some punctuation

* Addressed comments
2021-01-20 14:33:11 -03:00
Joshua Nelson 403521f1b9 Note that `--check` now allows using any stage 2021-01-17 05:51:00 +02:00
Joshua Nelson c74f970ae3 Clarify that `check` uses a different stage than `build` (#999) 2021-01-01 20:59:23 +00:00
Joshua Nelson 43fa1342f0 Document what 'sysroot' means 2020-11-29 20:02:55 -05:00
Gabriel de Perthuis ced315b860 Update bootstrap documentation with the new envvars for RUSTFLAGS
This follows <https://github.com/rust-lang/rust/pull/63722>.
2020-11-24 09:06:33 -05:00
Casey Rodarmor d7bb0ad45d Update src/building/how-to-build-and-run.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-11-09 09:07:41 +02:00
Casey Rodarmor 79d3ceb2fa Fix install command 2020-11-09 09:07:41 +02:00
Casey Rodarmor ac0b94deff Document `src/tools/x`, an `x.py` wrapper
Document the newly added `x` binary that wraps `x.py`, which can be
installed system-wide, and can be run from any subdirectory of a rust
repo checkout.
2020-11-09 09:07:41 +02:00
Yuki Okushi e55ee68ed0 Improve prerequisites section for Windows (#934)
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-26 08:15:21 +09:00
Joshua Nelson d056730692 Recommend debug-logging instead of debug
This makes the compiler faster to running without sacrificing too much
performance. It still shows logging so contributors aren't confused by
`debug!` doing nothing.
2020-10-08 16:15:06 -05:00
Justus K 1ae9303960 Update more occurrences of system llvm link 2020-10-08 11:47:32 -04:00
Cass 9ccc69f152 Add section describing git hook functionality
This is a companion to [this PR](https://github.com/rust-lang/rust/pull/76356), which deals with including functionality for automatically running `tidy --bless` on each commit.

Undo editor auto-formatting and clarify git hook renaming

a word

Phrasing

Apply suggestions from code review

Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-07 22:30:24 -04:00
Joshua Nelson 5fabea540a Document `Assemble` 2020-10-04 11:59:58 -04:00
Joshua Nelson fcc93a7043 Explain stages in terms of the compiler currently running (take N+1) (#857)
* Explain stages in terms of the compiler currently running

- Address some confusing points
  + stage N+1 -> stage N artifacts
  + Use more likely examples of an ABI break
  + stage N -> stage N compiler

- Mention why rustc occasionally uses `cfg(bootstrap)`
- Note that stage1 is built using two different versions

- Add lots of examples
  + `test src/test/ui` and `test compiler/rustc` run different compilers 😢
  + Separate examples of what to do from examples of what not to do

- 'ship stage 1 artifacts' -> 'ship stage 2 compiler'

  This is hopefully less confusing.

* build -> x.py build

* Add section on build artifacts

* Improve wording

Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>

* uplifted -> assembled

Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-04 16:25:02 +02:00
Who? Me?! 3b4462f582 Link to .md files, rather than .html
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-04 10:14:22 -04:00
mark 42173ef770 address lingering reviewer comments 2020-10-04 10:14:22 -04:00
Gus Wynn 08d244e06c Apply suggestions from code review
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-04 10:14:22 -04:00
Gus Wynn 58255429d8 add note 2020-10-04 10:14:22 -04:00
Gus Wynn c3a67e32dc add suggested workflow to setup nightly rustup for rustc 2020-10-04 10:14:22 -04:00
Aleksey Kladov d1651dbd5e Document new way to not build LLVM
Implemented in https://github.com/rust-lang/rust/pull/76349
2020-10-03 20:39:32 -04:00
Joshua Nelson 81f52ce0db Fix other library commands 2020-09-10 23:56:41 -04:00
Joshua Nelson 86e02cda81 Fix incorrect docs about stages
`build library/core` builds the compiler, not just the standard library.
2020-09-10 23:56:41 -04:00
Joshua Nelson 185f43c746 Use imprecise times, because the time to build depends on your computer
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-09-09 20:58:30 -04:00
Camelid 350ee4b260 Minor cleanup for "How to build and run" 2020-09-09 20:58:30 -04:00
Joshua Nelson f3b5db1057 Fix nit 2020-09-09 21:39:55 +02:00
Tshepang Lekhonkhobe dc0cff54bb Update src/building/new-target.md 2020-09-09 21:39:55 +02:00
Joshua Nelson 059ad38ddf Document how to promote a target from cross-compiled to hosted 2020-09-09 21:39:55 +02:00
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