Commit Graph

266 Commits

Author SHA1 Message Date
许杰友 Jieyou Xu (Joe) 141a8a1962 rustc-dev-guide: document `COMPILER` and `COMPILER_FOR` tracing targets 2025-02-16 18:47:57 +08:00
Jakub Beránek 470a207ef0 Document bootstrap profiling 2025-02-13 13:36:31 +01:00
Yuki Okushi 9350966973
Merge pull request #2236 from rust-lang/rustc-pull 2025-02-02 17:31:01 +09:00
Matthias Krüger 30c56c6e2b
Rollup merge of #135992 - madsmtm:new-target-docs, r=jieyouxu
Improve documentation when adding a new target

https://github.com/rust-lang/rust/pull/133631#issuecomment-2607877936 shows that it can be a bit difficult process-wise to add a new target.

I've added a bit of text to the docs, suggesting that users add the target defintion/spec first, and later work on `std` support.

I also found that we have two places where we document how to add a new target. I've linked these for now, but they should probably be merged somehow in the future.

`@rustbot` label A-docs
r? compiler
CC `@workingjubilee` who's worked a lot on target specs IIRC.
2025-01-31 12:28:16 +01:00
chiichen 72ceb939b3 feat: modify developing with nix section 2025-01-30 18:03:27 +08:00
chiichen a14bbfbea9 chore: discard padding white space 2025-01-30 18:02:58 +08:00
许杰友 Jieyou Xu (Joe) a86a368f0f rustc-dev-guide: update bootstrap tracing docs 2025-01-27 01:24:53 +08:00
Mads Marquart 2e060866f0 Cross-link documentation for adding a new target
Both the target tier policy and the rustc-dev-guide has documentation on
this, let's make sure people see both.
2025-01-24 14:40:12 +01:00
许杰友 Jieyou Xu (Joe) a58b85a26c rustc-dev-guide: document `BOOTSTRAP_TRACING` and bootstrap `tracing` setup 2025-01-13 13:46:20 +08:00
Jakub Beránek 280d73878a Update rustc-dev-guide 2025-01-07 19:10:03 +01:00
clubby789 b746f63983 completions: Zsh is now supported (#2173) 2024-12-27 09:03:10 +08:00
Ryan Mehri 421c7282e1 Fix some typos 2024-12-18 07:56:30 +02:00
Eric Huss 766fbbbe3d Add suggestion for `--keep-stage 0` (#2164) 2024-12-18 01:00:38 +08:00
Sam Estep 67dc382ac5 Note Rustfmt for separate rust-analyzer directory (#2134) 2024-11-13 21:37:25 +08:00
Stuart Cook 93738ab172 Describe why and how to use a separate build directory for rust-analyzer (#2106) 2024-10-29 18:16:11 +08:00
Tbkhi f1f5ec1b21 Update bootstrapping.md (#1900)
Co-authored-by: Jieyou Xu <39484203+jieyouxu@users.noreply.github.com>
Co-authored-by: Tbkhi <me.stole546@silomails.com>
2024-10-13 17:51:38 +08:00
Kajetan Puchalski ab71898fc7 building: Update instructions for ./x setup editor 2024-10-07 10:03:36 +02:00
Yoh Deadfall 0a9b996970 Fixed links to rust-analyzer configs for Emacs and Helix (#2087) 2024-10-06 09:43:08 +09:00
Onur Özkan 454dc454c1 update `x install` documentation (#2084) 2024-10-04 00:43:40 +08:00
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