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,188 Commits 3 Branches 0 Tags 114 MiB
Commit Graph

207 Commits

Author SHA1 Message Date
Tshepang Mbambo 991f770374 share link target (#1740) 2023-08-27 09:58:58 +09:00
Ethan Brierley a3c226d660 Suggest enabling patch-binaries-for-nix in `shell.nix` (#1774) 
Bootstraps nix detection isn't always perfect:
- https://rust-lang.zulipchat.com/#narrow/stream/122651-general/topic/Bootstrapping.20on.20NixOS
- https://github.com/rust-lang/rust/issues/115073
 2023-08-22 17:50:21 -04:00
Absobel 4285421cd2 Update suggested.md 
I imagine that the book meant that a full build isn't needed since it gave as an example the addition of a debug! statement
 2023-08-21 06:45:47 +02:00
İsmail Arılık 74d4d9ca74 fix(suggested): remove an unnecessary and confusing statement 
This statement is not about Visual Studio Code; it is about Neovim and it is already in that section. And it is also confusing for a VS Code user. So I think it is better to remove it.
 2023-07-14 20:41:09 +02:00
Tshepang Mbambo cd6372d916 make it read better 2023-07-14 08:39:30 +02:00
İsmail Arılık 6fece074be fix(how-to-build-and-run): fix a typo ("fromer" -> "former") 
I think it is a typo, isn't it? 🤔
 2023-07-14 08:39:30 +02:00
İsmail Arılık 14db9a3d53 fix(how-to-build-and-run): remove a wrong paragraph 
This paragraph says that given README section have instructions on how to install Python and other prerequisites but it doesn't.

Other than that "Dependencies" section in the README is already given in this section of the rustc-dev-guide: https://rustc-dev-guide.rust-lang.org/building/prerequisites.html#dependencies
So this paragraph seems not necessary.
 2023-07-13 11:37:29 +02:00
sslime336 44d8b7916a Try to avoid confusion 2023-07-01 08:14:17 +02:00
Tshepang Mbambo 3e328f0ef1 typo 2023-06-30 23:11:14 +02:00
sslime336 e2487ebdc4 Change `x.py` into `x`, add explanation for `x` 2023-06-30 23:11:14 +02:00
sslime336 a04ad82e3c Change `./x.py` into `./x` 2023-06-30 23:11:14 +02:00
jyn 3630392566 Improve Windows docs 2023-06-29 10:05:10 -05:00
jyn 6de921aef4 Inline alternate x.py invocations from the rust-lang/rust readme 
I'm going to make a follow-up PR shortly linking from rust-lang/rust to the dev guide so this info isn't duplicated.
 2023-06-29 10:05:10 -05:00
Eric Huss 1b6f93987d Fix some links 2023-06-29 06:43:19 +02:00
Zachary Whiteley 93fc2f3c01 Include information about setup defaults in how-to-build guide (#1694) 2023-06-21 18:13:53 +09:00
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