Commit Graph

181 Commits

Author SHA1 Message Date
Ralf Jung 7743f0fca3
don't refer to the compile-time interpreter as "Miri" (#1471) 2022-09-26 18:07:23 +09:00
Tshepang Mbambo 6e1ac9dd04 renamed 2022-07-19 09:56:55 +02:00
Tshepang Mbambo 2802da7b37
replace misleading name (#1401) 2022-07-19 15:56:24 +09:00
Niko Matsakis 53395b0e3d add draft chapter 2022-07-17 23:34:12 +02:00
Tshepang Mbambo 048d925f0a
not obvious what Ex is, so rather get rid (#1372) 2022-06-21 22:25:34 +09:00
David Wood c4d5a69945 diagnostics: add translation documentation
- Add documentation on translation infrastructure and use of
  `SessionSubdiagnostic`.
- Update diagnostic examples on other pages to be translatable since
  this is preferred.

Signed-off-by: David Wood <david.wood@huawei.com>
2022-06-13 10:14:40 +02:00
Who? Me?! acb1fcb780
Document ErrorGuaranteed (#1316)
* document ErrorGuaranteed

* Fix typos

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Clarify Niko comment

Co-authored-by: Niko Matsakis <niko@alum.mit.edu>

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
2022-05-03 11:28:26 -03:00
Eric Huss 78dd6a4684
Reorganize and expand the testing chapters. (#1281)
* Reorganize and expand the testing chapters.

* Update tests chapters for review comments.

* Fix typo.
2022-01-18 14:44:26 -03:00
Amanieu d'Antras 4d46bd0c95
Add inline assembly internals (#1266) 2022-01-18 11:12:06 -03:00
Dylan MacKenzie a2fc963502
Describe drop elaboration (#1240) 2021-11-18 13:31:13 -05:00
Oli Scherer 013c8892dd Move log/tracing instructions to its own file 2021-10-08 15:41:06 -05:00
lcnr 82d4c5604d const generics update 2021-09-20 12:35:16 -05:00
Andrey Cherkashin d1f77858e7 Update SUMMARY.md 2021-09-08 15:13:44 -05:00
Fridtjof Stoldt 139b8fb11b
Documenting diagnostic items with their usage and naming conventions (#1192)
* Documenting diagnostic items with their usage and naming conventions

* Fixed typos in diagnostic items documentation

Co-authored-by: Camelid <camelidcamel@gmail.com>

Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-09-01 11:26:58 -07:00
Smitty 9a6bd9fc98 Remove docs for old -Z profile-queries flag 2021-08-16 08:20:03 -05:00
Joshua Nelson 33c1eff45e
Document lang items (#1119)
* Document lang items

* Apply suggestions from code review

Co-authored-by: Camelid <camelidcamel@gmail.com>

* Add an example of retrieving lang items

* Add two missing words

* Fix line lengths

Co-authored-by: Mikail Bagishov <bagishov.mikail@yandex.ru>
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-07-05 08:34:33 +02:00
LeSeulArtichaut 4c8fdcf511 Add stub about the THIR 2021-03-10 12:00:27 -05:00
Wesley Wiser 91f8f334f4
Add article on using WPA to profile rustc memory usage on Windows (#1074)
Document how to use WPA to profile rustc and what the normal workflow
should be for investigating bootstrap memory usage issues.

Co-authored-by: Ryan Levick <ryan.levick@gmail.com>
2021-03-09 04:42:56 +09:00
Camelid c431f8c29a Cleanup rustdoc chapters a bit
* Rename "The walking tour of rustdoc" to "Rustdoc overview",
  which I think is a more accurate name
* Use same name in sidebar TOC as in chapter text
* Make links between the two chapters prominent
* Convert a few `.html` links to `.md`

Probably we should just merge the chapters, but leaving that for later.
2021-02-28 16:35:20 -05:00
Eric Huss 95c3930c67
Add chapter on libs and metadata. (#1044) 2021-02-04 11:34:52 -05:00
Iñaki Garay 0a5bb7f5e6
Add context to dated information (#1013)
* Fixes #924 Add context to dated information

* Fixes #924 Addressed comments and some uses of 'currently'

* Update src/contributing.md

Co-authored-by: Joshua Nelson <joshua@yottadb.com>

* Update src/salsa.md

Co-authored-by: Joshua Nelson <joshua@yottadb.com>

* Fixes #924 Addressed comments

* Fixes #924 Fixed line lengths.

Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-10 19:23:22 -03:00
Rich Kadel 9f612dace6 Adds a dev guide section on Rust Coverage 2020-12-07 14:22:45 -05:00
jumbatm f7d7e48874 Document SessionDiagnostic 2020-12-02 22:34:16 -06:00
Joshua Nelson 792ccb1523
Move the bootstrapping section later in the guide (#975)
Now that `x.py build` works in most cases, I don't think we need to
teach people all the intricacies of bootstrap right away. This moves it
to the 'overview of the compiler' section instead.
2020-11-30 20:08:17 -03:00
Camelid 72eca8fcc5 Document how to modify feature gates
How to remove them and how to rename them.

cc <https://github.com/rust-lang/rust/pull/79336#discussion_r528627318>
cc @varkor
2020-11-26 20:43:36 -05:00
Camelid 30c298dd7c
Clean up `compiletest` chapter (#935) 2020-10-26 11:58:00 +09:00
Jakob Degen c26ab70782 Incorporated suggestions into git page and edit for more brevity.
The Advanced Rebasing section has been mostly rewritten to include
both a major suggestion from jyn and a general rewrite. Additional
thanks to camelid for some suggestions!
2020-09-30 10:13:42 -04:00
Jakob Degen be11a5201d Edit using git page for brevity and clarity.
The previous iteration of the page was often wordy and
occasionally unclear. This has been cleaned up in places.

Additionally, the TODO in the no-merge policy section has been
removed and addressed.
2020-09-30 10:13:42 -04:00
Jakob Degen 328bd35e7d Add a section on using git.
This section addresses the biggest issues that new contributors,
especially those with limited familiarity with git, are likely to
face. This is still a WIP.

Thanks to jyn for the recommended improvements!
2020-09-30 10:13:42 -04:00
Camelid 1a547f7568 Fix typo in table of contents 2020-09-17 11:35:14 -04:00
LeSeulArtichaut d91788c71d Add a chapter on all the identifiers used through `rustc` 2020-09-14 17:42:19 -05:00
Dylan MacKenzie ed3d255153 Initial draft of MIR dataflow framework docs 2020-09-13 15:58:02 -04:00
LeSeulArtichaut e616159576 Add a chapter on useful `@rustbot` commands 2020-09-12 12:07:04 -04:00
Yuki Okushi 76d7b6ac70
Remove duplicate MIR chapter entry (#830) 2020-08-19 11:46:02 +00:00
Matthew Jasper 6ff87f49ba Document serialization in rustc 2020-08-16 14:14:35 -05:00
Yuki Okushi d89c8c9b12 Rename `HAIR` to `THIR` 2020-08-02 08:39:33 -05:00
Jake Goulding 5bde3efd90
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
Yuki Okushi e20ac5d64b
Add RISC-V notification group instructions (#814)
* Clean-up notification groups instructions

* Add RISC-V notification group instructions

* Re-order summary of notification groups

* Add a list of the notification groups

* Apply review suggestion
2020-07-28 19:06:07 +02:00
Federico Ponzi 63536944b0
Fixes menu for rustdoc page (#804) 2020-07-18 19:18:06 +09:00
Yuki Okushi 37ab8da24d Fix distortions of "representation" 2020-07-14 14:26:41 -05:00
Takayuki Nakata d3e682e590
Fix the difference of title in appendix A (#793) 2020-07-14 10:06:22 +09:00
mark b1198eff6b move CONTRIBUTING.md to rustc-dev-guide 2020-07-01 22:07:52 -05:00
mark fe7856889a fix file name 2020-06-30 16:04:28 -05:00
Who? Me?! 99745b9931 Move Getting Started to a "prefix chapter" 2020-06-30 16:04:10 -05:00
Who? Me?! fd4c83f4ab Move Errors and Lints to Analysis 2020-06-30 16:03:50 -05:00
Who? Me?! 093b9032de
Upgrade to mdbook 0.4 and switch to book parts (#764)
* upgrade to mdbook 0.4 and switch to book parts

* update linkcheck

* fix links, update about-this-guide
2020-06-24 14:47:50 -03:00
Joshua Nelson 4329b8e91a Split up rustdoc page 2020-06-23 17:40:16 -05:00
Joshua Nelson b8065faa0f Move rustdoc to 'How to build the compiler'
The old layout was less about rustdoc and more about the compiler:
"Here is an example of a project using rustc_interface".
This gives focus to rustdoc on something you might want to work on for
its own sake. It also makes the page much easier to find for newcomers.
2020-06-23 17:40:16 -05:00
Florian Gilcher f85ef8ec94 Add prerequisite page 2020-06-23 12:42:06 -05:00
Who? Me?! a10ba12047
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