mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
2,090 Commits 3 Branches 0 Tags 114 MiB
Commit Graph

192 Commits

Author SHA1 Message Date
clubby789 c07f051fa5 Add note about shell completion scripts 2023-05-17 21:44:05 -05:00
Brian Kung b8cf5aaaa0 Fix links in how-to-build-and-run.md (#1679) 2023-04-22 20:48:44 +09:00
Ezra Shaw 4a5e46f8ab docs: document new `suggest-tests` tool 2023-04-16 13:56:19 +02:00
jyn bea76af07d Clarify cfg(bootstrap) docs 2023-04-09 21:38:54 +02:00
jyn e379577fd0 Improve the landing page for contributing to the libstd docs (#1666) 2023-04-09 12:10:27 +09:00
y21 297817bf1f fix line length 2023-04-05 19:29:18 -05:00
y21 42b4a3b105 mention `git clone --depth` 2023-04-05 19:29:18 -05:00
Joshua Nelson 1fd8ddbdc2 add a few more TOC sections 2023-04-03 06:42:31 -05:00
Joshua Nelson 774a20130a Move some info from "Getting Started" to "How to build and run" 
"Getting Started" is already *very* long; this shrinks it a bit, and
puts similar info closer together.
 2023-04-03 06:42:31 -05:00
Shahar Dawn Or 266ca693c0 bootsrapping stages overview list 2023-03-23 15:36:00 +02:00
Thom Chiovoloni 31991ba0cb Rename `config.toml.example` to `config.example.toml` 2023-03-13 04:42:00 +02:00
clubby789 88a1bdd470 Fix Rust Analyzer settings location 
This file was moved in https://github.com/rust-lang/rust/pull/108618
 2023-03-08 00:21:21 +02:00
The 8472 54fe64b775 bootstrap now creates a usable toolchain when building stage0 std 2023-02-19 13:43:56 +01:00
Tshepang Mbambo a326b2525f impl review suggestion 
See https://github.com/rust-lang/rustc-dev-guide/pull/1605#discussion_r1110388310
 2023-02-18 05:04:44 +02:00
Tshepang Mbambo fcd74f99a3 lower-case "Compiler" in headings, for consistency (and looks) 2023-02-18 05:04:44 +02:00
clubby789 41680031f8 Add link to vscode settings in Rust repo (#1591) 2023-02-15 15:46:19 -03:00
Tshepang Mbambo 9f02d33a1c Fix a typo (#1597) 2023-02-14 15:43:48 +09:00
Christopher Smyth b4689c9511 Add Neovim configuration information (#1545) 
* Add Neovim configuration information
The JSON provided for VSCode works with coc and nlsp-settings.
This is verified by
9d8bdb9290/README.md
for coc, and feeding the JSON in to this schema
215b537cfb/schemas/_generated/rust_analyzer.json
for validating nlsp-settings.

* Make the steps clear
First open a Rust buffer
Then update RA settings
If you don't open a buffer first then nothing will happen. This is because
the plugin makes a raw LSP RPC, so RA must be attached.

* Use separate sections for VSCode and Nvim
* Add a short section on the VSCode tasks.
 2023-02-13 23:16:01 -06:00
clubby789 b4c465275c Replace settings.json with x.py setup note (#1588) 2023-02-08 14:26:58 -06:00
Onur 347b3633f1 update bootstrap guide (#1583) 
Signed-off-by: ozkanonur <work@onurozkan.dev>
 2023-02-04 16:53:38 -06:00
Nixon Enraght-Moony 69ef8a3924 Use host symlink for custom rustup toolchain 2023-02-04 01:01:48 +02:00
Zephaniah Ong 118246c17e Update rustfmt path 
As per https://github.com/rust-lang/rust/pull/107297#discussion_r1092764740, the change broke the rust-analyzer config. Hence, changing the docs to match the new path
 2023-02-01 18:59:30 -06:00
Tshepang Mbambo 343194d258 fix wrong heading level (#1573) 2023-02-01 07:29:15 +09:00
ozkanonur f0dbe6cec7 fix incorrect position of topic 
Right now "Clarification of build command's stdout" topic
shows up under the "Environment Variables" which is not correct.
This commit aims to fix this problem.

Signed-off-by: ozkanonur <work@onurozkan.dev>
 2023-01-31 22:57:27 +02:00
ozkanonur 375adf22dc extend bootstrap related documentations 
Signed-off-by: ozkanonur <work@onurozkan.dev>
 2023-01-31 12:42:30 -06:00
jyn c154a90ec5 Link to the youtube recording of my talk, not the summary (#1554) 2023-01-13 07:46:15 +09:00
Albert Larsan d4ec98736e Change `src/test` to `tests` (#1547) 2023-01-13 07:31:47 +09:00
Joshua Nelson a1418a804c Update sentence about LLVM to match the new defaults 2022-12-31 23:20:21 -06:00
Joshua Nelson 91d2393626 Move information about dependencies to the rust-lang/rust readme 
This avoids having to maintain the information in two places.
 2022-12-31 23:20:21 -06:00
Joshua Nelson 966d6e97a7 Move "create a config.toml" after the section explaning x.py 2022-12-31 23:20:21 -06:00
Joshua Nelson b36e2ff71d Remove unnecessary detail in building chapter 
Most of these details were not helpful or necessary for building the compiler for the first time.
This section comes very early in the guide and is meant to be a tutorial, so being concise is very important.
 2022-12-31 23:20:21 -06:00
Joshua Nelson 84eea0d580 Remove initial section on submodules 
It's not necessary and it takes up valuable space at the very start of the guide.
 2022-12-31 23:20:21 -06:00
Joshua Nelson bd26e3aae5 Replace `$TARGET` with `host` 
This avoids having to manually modify the configuration in the docs.
 2022-12-31 18:23:52 -06:00
Joshua Nelson 5d2d898534 Fix broken link 
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
 2022-11-28 19:00:24 -08:00
Joshua Nelson 4f846480db Don't use "incremental" to refer to `--keep-stage` 
`-C incremental` is sound and --keep-stage is not.
 2022-11-28 19:00:24 -08:00
Joshua Nelson 19df867789 Link directly to the section on `--keep-stage` 2022-11-28 19:00:24 -08:00
Noah Lev 010ab13460 Triage some date-check items (#1513) 2022-11-26 22:25:58 +09:00
Chris Denton ffec7d7474 Remove `--bless` from pre-push hook suggestion 
According to 8873e33806

> Running with --bless causes the push to succeed if there are fixable
formatting changes, but the changes don't make it into the push.
>
> We should have the user rerun with --bless (or x.py fmt) and commit the
changes themselves (they might want to amend a particular commit, for
instance).
 2022-10-27 20:36:34 +02:00
Lukas Wirth 2cfe23241b Update rust-analyzer suggestions (#1487) 2022-10-24 19:41:55 +09:00
Sergio de Carvalho 94dec079f7 Add missing prerequisite for some Linux distros (#1481) 2022-10-12 08:52:48 +09:00
Lukas Wirth 21a8552e40 Update r-a config suggestions 
The proc-macro server path is required for proc-macros to properly work in r-a when working on rustc.
Pointing the sysroot to the stage0 one is more correct than using the system installed one.
 2022-10-01 15:48:54 -05:00
Waffle Maybe b18b3edd4d Add a note about building `rust-analyzer-proc-macro-srv` (#1467) 2022-09-19 15:50:02 +09:00
Tshepang Mbambo cf7c209ce2 remove stray ** 2022-09-14 09:09:28 -07:00
Joshua Nelson 5fe399e27f fix typos and formatting 
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
 2022-09-12 18:48:21 -05:00
Joshua Nelson 277044dea7 Say "bootstrap" instead of "rustbuild"; the latter is not explained anywhere and is not much more clear. 2022-09-12 18:48:21 -05:00
Joshua Nelson dd57806c2b Rewrite the section on passing flags to subcommands 
- Move the reference for directories and actions to the very end; it's the most rare to need to know
- Add `RUSTDOCFLAGS*`, `CARGOFLAGS*`, `-vvv`, and `--test-args`
- Remove the incorrect `--on-fail` command
 2022-09-12 18:48:21 -05:00
Joshua Nelson 7bda73f627 Remove the diagram of all outputs generated by x.py 
These are already present in the table below, there's no need to repeat it.
Having it near the middle of the page makes it feel more overwhelming.
 2022-09-12 18:48:21 -05:00
Joshua Nelson 150bafb8d0 "symbol names" => ABI 
ABI is more general and gives a better idea of what goes wrong.
 2022-09-12 18:48:21 -05:00
Samyak Sarnayak e1b4fba955 Add reference for updating Windows PATH and fix typo 
Yes, the reference is a page on Java's documentation but that's the most complete and most official looking reference I could find.
 2022-09-03 06:11:07 +02:00
Eric Huss 4123cb2cd9 Update for removal of RLS (#1450) 2022-09-02 23:03:15 +09:00