Commit Graph

247 Commits

Author SHA1 Message Date
Kajetan Puchalski 34a13c2e52 building/suggested: Add instructions for Emacs & Helix (#2080)
Co-authored-by: 许杰友 Jieyou Xu (Joe) <39484203+jieyouxu@users.noreply.github.com>
2024-09-28 20:09:48 +08:00
Noratrieb eca2a904d1 elaborate on warnings 2024-09-24 20:59:54 +02:00
Yuri Astrakhan 9303d5b017 Apply suggestions from code review
Co-authored-by: 许杰友 Jieyou Xu (Joe) <39484203+jieyouxu@users.noreply.github.com>
2024-09-24 20:59:54 +02:00
Yuri Astrakhan c923ae6187 Clarify how to disable warnings in deps 2024-09-24 20:59:54 +02:00
Felix Rath cd32af3b6a feat: Add section about partial clones with `git clone --filter='blob:none'` 2024-09-24 19:59:44 +02:00
Marco Ieni a66f8b1a36 chore: add missing `.` (#2074) 2024-09-23 20:51:33 +08:00
许杰友 Jieyou Xu (Joe) baf5c020a3 Add remark on required free disk space (#2073) 2024-09-23 20:11:47 +08:00
joculatrix 0810cd3c34 Edit a sentence for clarity (#2071) 2024-09-23 12:02:25 +08:00
Tshepang Mbambo 80c0794aae missing char (#2047) 2024-08-22 22:43:28 +02:00
onur-ozkan 06ca6d1e6e use "bootstrap" instead of "rustbuild"
Let's stick with the single name "bootstrap" to refer to the bootstrap project to avoid confusion.

Signed-off-by: onur-ozkan <work@onurozkan.dev>
2024-07-06 23:28:20 +02:00
Arjun Patel 722e2539e6 Fix grammar issue in optimize-build.md (#2009) 2024-07-02 11:05:55 +08:00
Urgau 194f5fe227 Update new target check-cfg instructions 2024-07-01 12:51:26 +02:00
DianQK 3f1e015a75 provide `libstdc++.so.6` through `LD_LIBRARY_PATH` 2024-06-27 16:15:59 +02:00
Yosh 079c8d4d7a Rename `wasm32-wasi` to `wasm32-wasip1` 2024-06-23 20:21:42 +02:00
onur-ozkan f3618f3dd5 tell about `STAGE0_MISSING_TARGETS` for new targets
We just realized that the bootstrap target sanity check isn't documented anywhere,
and it would be quite exhausting to learn this manually through a series of failing CI builds.

Signed-off-by: onur-ozkan <work@onurozkan.dev>
2024-06-16 08:39:57 +02:00
听寒 06a3f3bed1 should use `&` to load completions for PowerShell (#1978) 2024-06-04 06:31:05 +01:00
onur-ozkan 1f915f11d8 sync the stage0 filename
Signed-off-by: onur-ozkan <work@onurozkan.dev>
2024-05-25 15:42:06 -07:00
surechen e5c589981c fix some typos 2024-05-21 11:56:12 +02:00
Prashanth Mundkur 4065bd5d9d Fix some broken links under bootstrapping. (#1958)
* Fix some broken links under bootstrapping.

* Fix more broken links for bootstrapping.
2024-04-06 20:55:06 +01:00
Nilstrieb cc608ba78e Add quickstart for how to build and run the compiler (#1951)
* Add quickstart for how to build and run the compiler

The chapter is quite long, and a lot of the information is, while
valuable, not very important for newcomers. I think it makes sense to
have a condensed version for anyone just wanting to get started with
only the most important information.

* A few improvements to quickstart
2024-03-31 06:23:21 +02:00
JohnEndson 69c820a470 Fix some comments
Signed-off-by: JohnEndson <jiayuzhen@outlook.com>
2024-03-28 13:58:43 +02:00
Christopher B. Speir 562d701eb8 Fix broken link in chapter '1. How to build and run the compiler'
The 'read this chapter' link under the 'What is x.py?' section
returned a Document not found (404) error.
2024-03-22 10:49:12 +02:00
许杰友 Jieyou Xu (Joe) 1d2ddcf7d1 Extract Bootstrap into its own section (#1939)
* Extract Bootstrap into its own section

Add brief explanation for `Step` and `Builder::ensure` as core
Bootstrap internal concepts.

* Drop common commands page (use `x --help` instead)

* Add `make` as an alternative entry point

* Add src/bootstrap/README.md link
2024-03-13 18:18:29 -03:00
Tshepang Mbambo 5ced644d1f typos
Also
- use proper case for rust-analyzer
- reformat a bit, for sembr
2024-03-13 04:28:30 +01:00
Nilstrieb 22c2f7ce79 make shell.nix better (#1858)
* make shell.nix better

* Mention using RUST_BOOTSTRAP_CONFIG

* Move things to `buildInputs` and add `glibc.out glibc.static`

This fixes the nofile-limit.rs UI test.

* short lines for the short line fans

* Fix pkgs
2024-03-01 21:26:19 +01:00
Yukang b88a4c5275 Add notes on tweak rust-analyzer.check.overrideCommand (#1890) 2024-02-21 12:18:39 -03:00
Eric Huss ae9c529137 Update for upcoming markdown changes. (#1880) 2024-02-07 10:23:35 -03:00
the8472 e334398243 update link to rustc dependencies (#1869) 2024-01-28 12:42:18 +01:00
onur-ozkan ca6139dd0d update old bootstrap docs
Signed-off-by: onur-ozkan <work@onurozkan.dev>
2024-01-15 19:44:49 +02:00
Nadrieril ce67594f02 Suggest `gcc_multi` to make `mir_opts` run on nixos (#1841) 2023-12-19 19:07:35 +09:00
Martin Nordholts af59355e3e bootstrapping: Clarify that stage0 std code is not executed to produce stage1 compiler (#1840) 2023-12-19 19:02:34 +09:00
jyn d53f2f6cc4 add a mailmap 2023-12-17 18:21:38 +01:00
Krasimir Georgiev c80cf8cddf Update how-to-build-and-run.md
Trying out the old example command gave me:
```
error: the argument '--target <TARGET>' cannot be used multiple times
```
2023-11-28 15:13:36 +02:00
Onur Özkan 641a617c61 remove change-id from sample build configuration (#1813) 2023-10-30 02:16:41 +09:00
Ethan Brierley 95f806352d [suggested.md] `changelog-seen` -> `change-id`` in `shell.nix`
`changelog-seen` was deprecated in https://github.com/rust-lang/rust/pull/115898

```
WARNING: The use of `changelog-seen` is deprecated. Please refer to `change-id` option in `config.example.toml` instead.
WARNING: The `change-id` is missing in the `config.toml`. This means that you will not be able to track the major changes made to the bootstrap configurations.
note: to silence this warning, add `change-id = 115898` at the top of `config.toml`
```
2023-10-11 08:30:26 +02:00
Jakub Beránek f7e8378ca1 Modify build instructions for optimized build (#1795) 2023-09-22 01:33:41 +09:00
Jakub Beránek 3b0eb4cd62 Review changes 2023-09-05 23:14:26 +02:00
Jakub Beránek 665bd2cdcc Add section about building an optimized version of `rustc` 2023-09-05 23:14:26 +02:00
Ken 7463a803be Update minor how-to-build-and-run.md spelling mistake
As of <!-- date-check --> Aug 2023, found:
The spelling mistake "guilde" should be "guide"

This PR only makes this minor correction
2023-08-31 07:28:52 +02:00
Ethan Brierley e836be4123 Reword sentence about using `./x` over `./x.py`
The current sentence was confusing when I first read it. I've reworded it to hopefully make it more clear.
2023-08-28 07:06:58 +02:00
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