Commit Graph

1787 Commits

Author SHA1 Message Date
Jacob Hoffman-Andrews ddccb87b0d Update rustdoc internals
Use current paths when discussing source files.
Update cheat sheet section with download-rustc.
Add "use cases" section.
2021-12-09 16:05:48 -06:00
Noah Lev 51146cd309 Update HIR chapter to use `HirId` instead of `NodeId`
`NodeId`s are no longer used in the HIR. See #50928 for more information.
2021-12-09 09:11:48 -06:00
Noah Lev 7c8d7c57a4 Fix some broken links 2021-12-09 09:11:48 -06:00
Lucas Kent 99ced2e883 Update src/getting-started.md
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-12-09 09:09:36 -06:00
Lucas Kent 08bc5de96a Improve documentation on r? 2021-12-09 09:09:36 -06:00
Rich Kadel 2531a18d3b Update LLVM coverage mapping format version supported by rustc (#1267)
rust-lang/rust#91207 updates the coverage mapping format to Version 5 or
6, depending on the built-in version of LLVM (12 or 13, respectively).

This change updates the dev guide to match the recent changes.
2021-12-03 09:26:47 -08:00
Lucas Kent 9074afb8da Improve 'Running tests manually' section 2021-11-27 03:45:39 -05:00
Yuki Okushi a7abb26bfe Fix some links 2021-11-24 10:23:07 -05:00
Eric Huss 499f9b9fc9 Update for review comments. 2021-11-24 10:22:37 -05:00
Eric Huss 4aff2ba309 Document rustfix-only-machine-applicable 2021-11-24 10:22:37 -05:00
Eric Huss 9bde256126 Apply suggestions from pierwill
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
2021-11-24 10:22:37 -05:00
Eric Huss c042df7cae Document more compiletest headers. 2021-11-24 10:22:37 -05:00
Dylan MacKenzie 6643adf704 Describe drop elaboration (#1240) 2021-11-18 13:31:13 -05:00
Ken Matsui d4f300263e Fix an invalid link on Diagnostic Items (#1261) 2021-11-16 10:45:40 -03:00
Yuki Okushi 8047e19802 Fix broken links related to `rustc_borrowck` (#1259)
* Fix broken links in region_inference.md

* Fix broken links in lifetime_parameters.md
2021-11-16 10:43:17 -03:00
Ken Matsui e1babf580d Unify `x.py` usage (#1258) 2021-11-16 07:44:50 +09:00
Lucas Kent 363f6ce09c Spelling fixes 2021-11-15 08:23:01 -06:00
Lucas Kent 7b93c858f0 Fix compare-mode documentation 2021-11-14 17:01:35 -06:00
Noah Lev e0ddc301da Fix broken link in "Bootstrapping"
The italics added in #1239 broke the implicitly-resolved link.
2021-11-09 21:46:27 -06:00
chubei 7335f28334 Fix typo: [upv.rs_mentioned] -> [upvars_mentioned] 2021-11-07 07:48:47 -06:00
asquared31415 42e31a049e Add note to emphasize replacing TARGET_TRIPLE (#1250) 2021-11-06 18:32:55 +09:00
Eric Huss b4570015e5 Remove some legacy test suites. 2021-11-04 14:18:39 -05:00
Dmitry Savintsev 07dcb9e148 tiny capitalization fix 2021-11-04 14:15:06 -05:00
Noah Lev 98fe056d6c Fix date
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2021-11-04 09:33:03 -07:00
Noah Lev b1f655d972 Update some date-check comments
I removed one of them because it doesn't seem necessary.
2021-11-04 09:33:03 -07:00
Caleb Cartwright b26499d1ff enhance subtree docs, link to clippy docs 2021-11-02 20:09:23 -05:00
pierwill b547c04d8e Edit introduction to bootstrapping
Use paragraphs instead of bullet-points.
Edits throughout for clarity.
Use semantic line breaks in edited sections.

Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-11-02 15:06:56 -05:00
xFrednet c0c8c133c7 Some minor adjustments to the diagnostic documentation 2021-10-29 21:51:05 -05:00
pierwill f85c21465f Edit "About this guide" for semantic line feeds
This is work toward #1241.
2021-10-28 15:30:08 -05:00
Janggun Lee d03c7b8626 Fix `rustc_mir` related links (#1228)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: nhamovitz <18648574+nhamovitz@users.noreply.github.com>
2021-10-29 00:58:26 +09:00
Ramon de C Valle 0d3af84fc0 Add documentation for LLVM CFI support
This commit adds initial documentation for LLVM Control Flow Integrity
(CFI) support to the Rust compiler (see rust-lang/rust#89652 and
rust-lang/rust#89653).
2021-10-27 08:55:16 -05:00
Rémy Rakic 2cd36a4f65 Describe how to trigger perf runs (#1237) 2021-10-22 01:00:27 +09:00
Joshua Nelson 4dcc29161b Remove docs on Assemble step (#1233) 2021-10-18 02:17:19 +09:00
Yusuke Abe 48e6d474cc Update some docs from 2021-10 date triage (#1230) 2021-10-12 08:52:21 +09:00
Noah Lev 632f2b7484 Recommend `rustfmt --edition=2021` 2021-10-10 08:28:12 -05:00
Tomasz Miąsko 62955f53ac Update sanitizer documentation 2021-10-08 15:49:53 -05:00
Tomasz Miąsko 84e40d7cbb Mention needs-sanitizer-hwaddress directive 2021-10-08 15:49:53 -05:00
Oli Scherer af8c2d2c7d Address review comments 2021-10-08 15:41:06 -05:00
Oli Scherer 3657acea97 Document tracing awesomeness 2021-10-08 15:41:06 -05:00
Oli Scherer 1620515e37 Move log/tracing instructions to its own file 2021-10-08 15:41:06 -05:00
Eric Holk e0cfc8c17a Update src/closure.md
Co-authored-by: Joshua Nelson <github@jyn.dev>
2021-10-07 17:48:12 -05:00
Eric Holk ebbb329734 Fix accidental HTML tag
The markdown parser was interpreting the `<something>` in `adjust_upvar_borrow_kind_for_<something>` as an HTML tag that was hidden in the rendered text. This minor edit fixes that.
2021-10-07 17:48:12 -05:00
Janggun Lee 3e63f3615c Update links to `rustc_mir` in Two Phase Borrows (#1226)
https://github.com/rust-lang/rust/pull/80522 split the `rustc_mir` crates into 5 crates, effectively invalidating all the direct links to `rustc_mir` in the docs.

I found this while looking at the Two Phase Borrows doc, which is why I am giving out this PR to fix this.
2021-10-06 09:07:51 -03:00
Noah Lev 81201b80eb Update some docs from 2021-10 date triage (#1224) 2021-10-05 17:24:24 -03:00
Dave Farnham 5926c7e6f4 Fix a typo on closure.md (#1218) 2021-09-24 12:00:29 +09:00
lcnr 7a476c07e1 const generics update 2021-09-20 12:35:16 -05:00
Tomasz Miąsko ee746de3af s/--blessed/--bless/ 2021-09-19 10:36:26 -05:00
Frank Steffahn 99e53983ad Make indentation consistent in example vscode config file 2021-09-17 16:52:56 -05:00
Frank Steffahn ee4b32b958 Suggests `--edition=2018` argument when using stage0/bin/rustfmt directly 2021-09-17 14:53:44 -05:00
lcnr 212a89205b `ty::Unevaluated`: dealing with unused substs (#1190)
* unused ct substs

* q

* q

* Update src/constants.md

Co-authored-by: Niko Matsakis <niko@alum.mit.edu>
2021-09-17 15:50:26 -04:00
Sl1mb0 d82208c6f4 Parallel codegen (#1206)
* Described underlying data structures in parallel code generation and crates they are used in
* Added links
* replace crate information with description of types
2021-09-16 20:58:07 -05:00
Eric Huss 428670ca01 Clarify difference of a help vs note diagnostic. 2021-09-12 11:50:44 -05:00
Andrey Cherkashin 6b747c6cf2 remove ctag section 2021-09-08 15:13:44 -05:00
Andrey Cherkashin ce27f4801d Update suggested.md 2021-09-08 15:13:44 -05:00
Andrey Cherkashin af8961775a Update SUMMARY.md 2021-09-08 15:13:44 -05:00
Andrey Cherkashin 4105934b90 Move ctag section to "Suggested Workflow" 2021-09-08 15:13:44 -05:00
Andrey Cherkashin 7c4410ed50 Delete ctags.md 2021-09-08 15:13:44 -05:00
Noah Lev ef35a84098 Clarify paragraph in "Keeping things up to date" 2021-09-08 12:36:10 -05:00
Timothy Maloney f1b5e50437 Docs: added section on rustdoc 2021-09-07 11:08:38 -05:00
Timothy Maloney 3d4f0d91e3 Docs: made suggested fix 2021-09-07 11:08:38 -05:00
Timothy Maloney 0f657e23aa Docs: deleted copy 2021-09-07 11:08:38 -05:00
Timothy Maloney 720084903e Docs: added section discussing core ideas 2021-09-07 11:08:38 -05:00
Timothy Maloney a22f7be4e7 Docs: delete redundant use of correctness 2021-09-07 11:08:38 -05:00
Timothy Maloney 4ebe82a278 Docs: consolidated parallelism information 2021-09-07 11:08:38 -05:00
Dezhi Wu 8887cd3d50 Add links to overview.md (#1202) 2021-09-06 18:34:16 -03:00
sjud 1ffee15da9 Spelling change intermidiate to intermediate
Very importent change.
2021-09-05 12:11:19 -05:00
Dezhi Wu 03420385e1 Fix a typo (#1200) 2021-09-05 09:40:35 -03:00
Fridtjof Stoldt 46fa9e7283 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
Noah Lev dd1feeb7a2 Add link to `Span` 2021-08-31 12:38:30 -05:00
Joshua Nelson 8b64a80ccc Add rustc-source to suggested rust-analyzer config (#1189)
This allows loading the sources for crates loaded from the sysroot.
2021-08-31 10:13:18 -07:00
Noah Lev 5c36f8e2ad Fix typo, clarify backtick wording, and use inline code 2021-08-31 12:08:01 -05:00
Frank Steffahn d789b1c701 Trailing date comments in a line inside of a paragraph caused beginning of a new paragraph. (#1196)
This PR fixes the 2 occurrences of that.
(I'm not sure if there's an underlying issue with mdbook or if this is working as intended.)
2021-08-28 08:26:16 -03:00
Frank Steffahn c98c707872 Fix a code block containing ```rust
This wasn't displayed correctly.
Changing `` ```rust `` to `` ```rust`` made it a code block again,
but the leading space was rendered as-well.
(This may be an issue in mdbook, but I'm not sure.)

This commit changes it to use HTML-syntax in order to get the desired result.
2021-08-27 15:13:38 -05:00
Frank Steffahn 5bfa8c9a9c Fix typo “a Rc” → “an Rc” (#1191) 2021-08-22 11:47:02 -03:00
Smittyvb cfffdd92ea Expand THIR section with more details (#1183)
* Expand THIR section with more details
* Remove incorrect reference to `HirId`s

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2021-08-21 19:55:56 -04:00
Smitty b5814b34da Remove docs for old -Z profile-queries flag 2021-08-16 08:20:03 -05:00
Rahul Butani 6893645e60 Remove a dead link in `new-target.md` + other nits (#1186) 2021-08-10 20:41:44 +09:00
Bryan Cantrill cb2c542217 Add description of -opt-bisect-limit LLVM option (#1182) 2021-08-07 10:12:22 +02:00
Yoh Deadfall 98d9084c4f Fixed team responsible for stabilization (#1181) 2021-08-05 13:41:16 +02:00
the8472 a6e37389d8 Add S-Inactive PRs as another source of things contributors could work on (#1177) 2021-07-29 06:05:19 +02:00
Dave f0900b2e0f git.md: Fix No-Merge Policy link 2021-07-28 09:45:23 -04:00
Ben Reeves a7f22be835 Fix typo in building/bootstrapping.md (#1175) 2021-07-26 00:37:28 +02:00
Noah Lev f03ae32895 Link directly to stabilization report comments (#1173)
Previously, readers had to scroll through tons of comments to find the
report.
2021-07-20 17:39:41 -07:00
bjorn3 a9dd88ec4c Update for merge of CrateDisambiguator into StableCrateId 2021-07-13 12:45:58 -04:00
Eric Holk 03faa9b900 Minor capitalization fix (#1170) 2021-07-08 01:27:47 +02:00
Yoh Deadfall 0ead7b154f Fixed typos in inline code 2021-07-05 11:21:03 -04:00
Joshua Nelson 9304642bde 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
Ryan Levick b756d157e8 More specifics on what future-incompatible lints are used for 2021-07-04 23:21:24 -04:00
Ryan Levick 7cfaceec67 Fix line lens 2021-07-04 23:21:24 -04:00
Ryan Levick e0f39fce3a Update information on lints particularly on future-incompatible 2021-07-04 23:21:24 -04:00
Ryan Levick 7a6cf5ce55 Update section of lint store 2021-07-04 23:21:24 -04:00
Ryan Levick 1d25c44b9a Update around half of the January 2021 date references (#1155) 2021-07-02 10:43:34 +02:00
Ryan Levick 6f1c331e94 Create issues for many TODOs (#1163)
* Create issues for many TODOs

* Update src/crates-io.md

Co-authored-by: Joshua Nelson <github@jyn.dev>

* Update src/backend/inline-asm.md

Co-authored-by: Yuki Okushi <jtitor@2k36.org>

Co-authored-by: Joshua Nelson <github@jyn.dev>
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2021-07-02 10:43:12 +02:00
Josh Triplett 76c1d45ae5 Links from rustc-dev-guide to std-dev-guide (#1152) 2021-07-01 13:19:06 +02:00
Smittyvb 6641226ba8 Document how to mark features as incomplete (#1151)
* Document how to mark features as incomplete

This was changed in https://github.com/rust-lang/rust/pull/86446 so that
incompleteness is included in the delcaration.

* Footerify link
2021-06-29 18:41:13 +02:00
Jesús Hernández c62c96ee6f Remove requests or suggestions about rebase and fixup contradictory to rust-highfive bot comment (#1111) 2021-06-25 01:50:50 +09:00
Smittyvb 3db8af26f9 Generate glossary table correctly (#1146)
Co-authored-by: Yuki Okushi <yuki.okushi@huawei.com>
2021-06-24 13:57:37 +09:00
二手掉包工程师 5a5098a2a5 Correct the wrong serial number (#1147) 2021-06-23 15:14:09 +09:00
Yuki Okushi a4bbc6547f Update "Inference variables" section (#1145) 2021-06-21 21:50:12 +02:00
Yuki Okushi 1373d5beed Document how to run unit tests (#1141) 2021-06-17 17:25:28 -03:00
Oli Scherer ae62be50bd We stopped using allow_internal_unstable a while ago (#1142)
Co-authored-by: Ralf Jung <post@ralfj.de>
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2021-06-15 17:04:54 +09:00
Jade 3559fa7fef Change the feature used as an example of stabilizing lib features (#1143) 2021-06-15 05:57:10 +09:00
Santiago Pastorino 29aeb0b2ae We use HIR to do type inference, trait solving and type checking (#1139)
* We use HIR to do type inference, trait solving and type checking

* Update src/overview.md

Co-authored-by: Yuki Okushi <jtitor@2k36.org>

* Update src/overview.md

Co-authored-by: Yuki Okushi <jtitor@2k36.org>

* Update src/overview.md

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

* Fix type checking brief explanation

Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2021-06-14 20:35:38 +02:00
Jade 18493f62b0 Add suggested settings note for coc (#1144) 2021-06-13 01:17:06 +09:00
Gus Wynn 5e61e50c17 move 7/8 to prose 2021-06-09 14:43:20 -04:00
Gus Wynn 7bfcf8763b Add a section on keeping things up to date in the git section 2021-06-09 14:43:20 -04:00
Yuki Okushi 5154ef98ec Fix some links (#1137)
* Fix some links

* Address review comment
2021-06-04 09:08:56 +02:00
Ralf Jung f4e82623b2 explain Miri engine vs Miri-the-tool 2021-05-30 02:18:51 +02:00
Michael Woerister faaaaf955c Add more information about no_hash query modifier. (#1133) 2021-05-28 17:23:27 +02:00
Ralf Jung 3d9d15d1f5 improve section introduction 2021-05-26 06:24:44 -04:00
Ralf Jung 1353f7fe08 not all tools require waiting for a nightly release before they can be fixed 2021-05-26 06:24:44 -04:00
Eric Huss fe4887b0e2 Describe the difference of rustc_lint vs rustc_lint_defs. 2021-05-25 21:37:21 -04:00
Caleb Cartwright 2d3cc2a192 update rustfmt references to reflect change from submod to subtree (#1129)
* update rustfmt references to reflect change to subtree

* clarify broken toolstate hypothetical scenario
2021-05-20 15:02:20 +02:00
Justus K da1c7b423c Remove `--stage 1` argument from `doc` invocations (#1125) 2021-05-18 19:10:39 +02:00
Rich Kadel 412d1a75ab Update coverage docs (#1122) 2021-05-13 19:19:43 -07:00
Smittyvb 1e1ffdba44 Document -Zunpretty=thir-tree (#1128)
* document -Zunpretty=thir-tree

* Update position/wording
2021-05-13 20:51:43 +02:00
二手掉包工程师 3f01b29957 Unified CPU Requirements (#1126) 2021-05-10 13:38:24 +09:00
Ralf Jung c1e84b6c94 add 'waiting-for-review' incantation to main contrib page (#1124) 2021-05-05 13:53:42 +02:00
Camelid 9ba3b4b62c Suggest using `git range-diff` (#1092)
I have found it to be very helpful when rebasing.
2021-04-27 12:35:37 -07:00
Joshua Nelson 90e1d1fa43 Add sample nix shell
This also suggests using `x.py setup` instead of copying config.toml.
2021-04-27 08:52:22 -04:00
Ralf Jung 6bace78929 more RA config suggestions (#1114) 2021-04-26 18:34:50 -04:00
Nixon Enraght-Moony 8c522aa732 Add Polymorphisation paper (#1093) 2021-04-24 10:53:30 +09:00
Smitty e0055323fd Mention unpretty=mir-cfg for debugging MIR 2021-04-23 16:25:11 -04:00
Camelid 0822830537 Improve formatting and update info in "method lookup" section 2021-04-09 18:12:21 -04:00
Waffle Lapkin ee9bb8e48d Change wording a bit: `module` => `crate`
It seems more correct
2021-04-09 10:34:26 -04:00
Waffle Lapkin 727f212e9a fix typo (#1107) 2021-04-09 12:30:04 +02:00
Waffle Lapkin 88a4aa5308 fix typo 2021-04-08 17:29:13 -04:00
AngelicosPhosphoros fd8f1fee4e Mention CI build of LLVM in build instruction 2021-04-03 22:28:35 -04:00
二手掉包工程师 98c50aacd2 Fix rustdocs test command typo (#1103) 2021-04-04 01:41:35 +09:00
Yuki Okushi 3b9c325e72 Update the "LLVM updates" section 2021-04-02 05:57:57 -04:00
Yuki Okushi 3a25c80892 Fix a link about Rustdoc internals 2021-04-02 05:25:14 -04:00
Camelid 892e9091cb Add quickstart for adding a new optimization (#1094) 2021-04-01 19:24:44 +02:00
Joshua Nelson fd97123fbc Add back example of {{cwd}} (#1099)
I force-pushed this in the last commit and accidentally deleted the
github suggestion.
2021-04-01 04:04:46 +09:00
Joshua Nelson ec260c8f5c Document test input normalization 2021-03-31 14:51:19 -04:00
JohnTitor ae4208314d Add notes about nightly rustc version for the rustc-driver examples 2021-03-28 13:33:56 -04:00
Santiago Pastorino 081624ceaa Fix rust compiler meeting info (#1087)
* Remove dead link
* Make general text a bit better
* Fix Zulip link
* Improve description of what the compiler meeting is about
2021-03-19 19:11:43 -04:00
Santiago Pastorino 1b0372be77 Remove extra the (#1088) 2021-03-11 13:36:25 -08:00
Camelid d6bd146507 Fix double-word typos (#1084)
Inspired by #1079. I used this command to find these typos:

    rg --multiline --pcre2 '\b([a-zA-Z]+) \1\b' src -tmd

There were a couple false positives of the form "that that" meaning
"that it" or "that this".
2021-03-12 03:29:19 +09:00
Santiago Pastorino b8fb35151f I-nominated are nominated for discussion (#1080)
* I-nominated are nominated for discussion

* Generalize meeting expression

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

Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-03-11 19:05:02 +01:00
Santiago Pastorino 126ea58714 Complete unfinished statement 2021-03-11 13:01:44 -05:00
Léo Lanteri Thauvin 6753e20cbe Update lins 2021-03-10 12:00:27 -05:00
Léo Lanteri Thauvin 9692e9e9a1 Apply suggestions from code review
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-03-10 12:00:27 -05:00
LeSeulArtichaut d29b1c39cb Add stub about the THIR 2021-03-10 12:00:27 -05:00
Santiago Pastorino 4163ac0d6a Adjust a bit better P- label text 2021-03-10 11:35:23 -05:00
Santiago Pastorino b70deb1f65 Fix typos (#1079) 2021-03-10 23:56:51 +09:00
Wesley Wiser 0c6cccc215 Update cmake version in prerequisites.md (#1077)
LLVM requires at least cmake 3.13.4.

https://www.llvm.org/docs/CMake.html
2021-03-09 20:00:12 +01:00
Chayim Refael Friedman 2f006eabe1 Fix typo: suceed -> succeed 2021-03-09 12:37:10 -05:00
Wesley Wiser 4ddb696206 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
Tomasz Miąsko 0319b90a25 Use more accurate estimate of generated LLVM IR with llvm-lines
The `--emit=llvm-ir` emits an optimized LLVM IR. For optimized builds it will be
highly inaccurate estimate of the amount IR generated initially.  While the
inaccuracy can be somewhat reduce after disabling the optimization, that in turn
has other unintended consequences, since opt-level controls the emission of
lifetime markers, sharing of generics between crates, instantiation of inline
functions, etc.

Use `-Csave-temps` and `no-opt` bitcode as a basis for more accurate estimate of
initial work handed of to the LLVM.
2021-03-07 10:57:13 -05:00
Camelid a959fee323 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
Yuki Okushi 295234161c Fix broken links 2021-02-28 11:01:07 -05:00
Camelid 47722b22e9 Document how to enable CI LLVM without using `x.py setup` 2021-02-26 15:38:01 -05:00
Camelid 15c1f01c2f Remove some unrelated changes 2021-02-26 15:38:01 -05:00
Camelid 44f4197fa5 Fix typos 2021-02-26 15:38:01 -05:00
Camelid d6f81b211f Restore instructions for using system LLVM
They were removed in #1030, but are still useful.
2021-02-26 15:38:01 -05:00
Camelid 4895d26d5e Update some out-of-date information 2021-02-26 15:38:01 -05:00
Daniel Santos 7fde8950cf Fixes typo in getting started guide 2021-02-24 21:20:36 -05:00
Camelid 9539f6c271 Fix formatting of more date references (#1067) 2021-02-22 18:22:23 +09:00
Hirochika Matsumoto b4b1fb0058 Fix broken links in query.md (#1068) 2021-02-21 09:51:34 +01:00
Camelid 7f5a39d318 Update docs from date triage for 2021-02 (#1048)
The biggest change was updating the list of rustdoc passes. Several new
ones have been added since that documentation was written, so I added
those, and I also sorted the list so it is roughly alphabetical (except
for the part for the `strip-*` passes, which I left in the same order
since one of the list items has two passes so there's no "correct"
order).
2021-02-20 19:27:24 -08:00
Camelid f7049a868c Fix date-check comment formatting (#1066)
I realized that the format I had been previously using for date-checks

    (as of January 2021 <!-- date: 2021-01 -->)

left a space before the closing parenthesis in the rendered output,
which looks weird.

I could fix this by removing the space between `2021` and `<!-- ...`,
but that looks weird in the source. So I ended up deciding on changing
it to

    (as of <!-- date: 2021-01 --> January 2021)
2021-02-20 19:24:01 -08:00
r00ster 4f0142ce11 Make "URL" show up (#1065)
* Make "URL" show up

* Use `<URL>`

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2021-02-20 13:58:22 +01:00
Yuki Okushi 50e53ccffa Point to main branch on llvm-project's links 2021-02-19 20:25:36 -05:00
dmezh c6cf4c04da Fix typo (#1063) 2021-02-18 19:37:43 +01:00
bstrie 87b317f966 Update running.md 2021-02-17 17:13:07 -05:00
pierwill 1ab6279cea Add Oxide paper to bibliography 2021-02-15 10:14:03 -05:00
Camelid 4f16f7cc1d Fix typo 2021-02-07 22:12:28 -05:00
Yusuke Tanaka b0ff83f007 Fix typo in Bug Fix Procedure (#1050) 2021-02-07 11:15:54 -05:00
Eric Huss 768f07b196 Add chapter on libs and metadata. (#1044) 2021-02-04 11:34:52 -05:00
Camelid 6e02970f7f Add lots of date-check annotations
Also added dates for things that previously said "as of now" or "as of
this writing" and cleaned up a couple of things along the way.
2021-02-03 19:29:07 -05:00
Joshua Nelson 2e19c8ecc0 Document how to stabilize a library feature (#1036)
* Move 'force-unstable-if-unmarked' to the bootstrapping chapter

* Document how to stabilize a library feature

Note that features can't be stabilized until they go through FCP and
that FCP happens on the tracking issue, not the PR.

* Fix wrong glob

By default `**` behaves the same as two `*` side by side, i.e. it only
globs file paths, not directories. `shopt -s globstar` needs to be set
for it to mean a directory. I didn't notice this before now because
`globstar` is set by default in interactive mode, but not otherwise.
2021-02-01 19:31:00 +01:00
Eric Huss f6e4a5f851 Update test suite descriptions. (#1042) 2021-01-30 20:12:01 +09:00
Henry Boisdequin 21745b2014 put `x.py` in ticks 2021-01-30 10:59:57 +02:00
LeSeulArtichaut 470d5afe98 Update links to `librustc_llvm` and `rustllvm` 2021-01-24 08:18:34 -05:00
Joshua Nelson 584ccc7608 Add link to promotion.md (#1033)
* Add link to promotion.md

* Improve link text

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

Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-01-22 11:49:52 +01:00
Camelid 7547e6af9a Add missing period 2021-01-21 14:26:25 -05:00
Joshua Nelson 53a45a9a19 Remove "Skipping LLVM build" section
`download-ci-llvm` is available and enabled by default for all tier 1
platforms, so there is no need to change it. Using system LLVM over CI
llvm is still supported, but is not recommended. Building LLVM from
source is still supported.

This also notes that you need to explicitly disable downloading LLVM
when updating the submodule.
2021-01-20 13:45:05 -05:00
Iñaki Garay 7a80b01e01 Add mdbook-toc, markers, and documentation (#1028)
* Add mdbook-toc to travis, book.toml  and documentation

* Add toc markers

* Whitespace cleanup and some punctuation

* Addressed comments
2021-01-20 14:33:11 -03:00
Joshua Nelson d8d5bbcfe3 Link to `feature_err` in stability section (#1022) 2021-01-19 11:47:45 -08:00
Martin Geisler b2d6a16e58 Fix typo (#1027) 2021-01-17 11:50:04 -03:00
Joshua Nelson 403521f1b9 Note that `--check` now allows using any stage 2021-01-17 05:51:00 +02:00
ashosive 4bb7ee493f improved the readablity of a line 2021-01-16 12:04:07 -05:00
saki-osive f7e62ecccb Fixed a grammatical error in hardawre requirements section 2021-01-16 10:03:23 -05:00
saki-osive eeb696d8a4 Corrected MIR file path and fixed a typo (#1020) 2021-01-14 14:10:08 -08:00
Yuki Okushi 261ec50fa9 Add a note about UI test entry limitation (#1019) 2021-01-12 07:55:13 +09:00
Iñaki Garay cd437dc04f 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
Camelid 296a37bf7b Update 'Workspace structure' section (#1017)
* Update description of `src/`
* Note that `library/` also contains the Rust runtime
2021-01-10 16:19:39 -05:00
Camelid afaa42043c Point to `HirId` instead of `NodeId` 2021-01-09 21:05:10 -05:00
Camelid c16ce78347 Fix typo (#1016)
"currenty"!
2021-01-09 17:18:57 -08:00
Ryan Levick 1db26c008c Break up long line 2021-01-05 16:13:58 -05:00
Ryan Levick d01012ada8 Remove backticks and comment about possible bug 2021-01-05 16:13:58 -05:00
Ryan Levick 8a8bb49afa Update src/compiler-debugging.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2021-01-05 16:13:58 -05:00
Ryan Levick 27174ca131 Make instructions for configuring compiler for debug more explicit 2021-01-05 16:13:58 -05:00
Camelid 8bb02718e9 Remove old sentence that should have been removed
It was mistakenly not removed in #997.
2021-01-04 22:43:03 -05:00
Yuki Okushi 37a1ca9416 Fix "Potential incomplete link" error on compiler-debugging.md 2021-01-04 20:12:37 -05:00
Ryan Levick 5ca0f2dc26 Add link to rust-analyzer docs on getting started page 2021-01-04 10:09:49 -05:00
Sebastian Widua 1b4d37b32b Fix some typos 2021-01-04 10:02:33 -05:00
Camelid a0cdbb5675 Tweak wording around provider purity 2021-01-03 22:31:09 -05:00
Laurențiu Nicola d225a12cab Fix typo (reflex -> reflect) 2021-01-02 09:25:03 -05:00
Joshua Nelson c74f970ae3 Clarify that `check` uses a different stage than `build` (#999) 2021-01-01 20:59:23 +00:00
Yuki Okushi 8a8749228b Fix broken link for `BoundRegion` (#998) 2020-12-31 01:13:49 +01:00
Camelid 4142cf8b8d Update logging section and explain `RUSTC_LOG_COLOR` (#997)
* Update logging section and explain `RUSTC_LOG_COLOR`

* Small fixes

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

* Mention that prefixes of paths work as log filters

* `=debug` matches `debug!` *and higher*

* Note that `MIRI_LOG_COLOR` only applies to logs from Miri

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-31 01:08:00 +01:00
Joshua Nelson 659281e739 Fix broken link in the contributing guide (#996) 2020-12-29 21:08:55 +01:00
Iñaki Garay 7268945c0f rustc invocation standarized (#992)
* rustc invocation standarized

* Addressed comments

* Addressed comments

* Addressed comments

* Updated command output
2020-12-28 23:34:51 +01:00
Wesley Wiser e0425a9563 Update glossary.md (#994)
* Update glossary.md

- Added additional information to some of the definitions.

- Made term capitalization consistent so that only terms which refer to acronyms or concrete types are capitalized. Please let me know if that isn't desirable for some reason.

* Update src/appendix/glossary.md

Co-authored-by: Joshua Nelson <jyn514@gmail.com>

* Update src/appendix/glossary.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

* Update src/appendix/glossary.md

Co-authored-by: Joshua Nelson <jyn514@gmail.com>
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-28 20:05:06 +01:00
Iñaki Garay 2f9696bdeb [Fixes #778] Added and reorganized lecture links (#993)
* Added and reorganized lecture links

* Addressed comments

* Addressed comments
2020-12-27 20:50:53 +01:00
Yuki Okushi cb0b7b64ee Document `error-pattern` header (#989)
* Document `error-pattern` header

* Address some reviews
2020-12-12 16:06:30 +01:00
Yuki Okushi 4e871ea1db Fix some link failures and typos 2020-12-11 16:00:15 -05:00
Nixon Enraght-Moony a801509b43 All links to rustdoc-internals.md 2020-12-10 14:51:04 -05:00
Camelid 0265b964a7 Add a section on identifiers in the MIR (#951)
* Add a section on identifiers in the MIR

* Better wording

* Use loose lists; fix typo; fix link

* Update info

* Note how you can retrieve the associated data

Suggested by @LeSeulArtichaut.

* Update src/identifiers.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

* Add TODO for `Promoted` re `GlobalId`

Co-authored-by: Oli Scherer <github35764891676564198441@oli-obk.de>
Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-07 20:56:25 +01:00
Rich Kadel a7c82e3ba9 Adds a dev guide section on Rust Coverage 2020-12-07 14:22:45 -05:00
Siddharth 2adddd99f2 Edit the Mir page to fix infelicities. (#984)
* Edit the Mir page to fix infelicities.

- Remove dead reference to Mir. reflow sentence to talk about
  `Body::local_decls`
- Fix broken links to render properly.
- Add links for `Terminator`, `RETURN_PLACE`, `ProjectionElem`.

* Update src/mir/index.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

* Edit the Mir page to fix infelicities.

- Remove dead reference to Mir. reflow sentence to talk about
  `Body::local_decls`
- Fix broken links to render properly.
- Add links for `Terminator`, `RETURN_PLACE`, `ProjectionElem`.

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-06 15:36:52 +01:00
Siddharth a4871f5013 Add links to the rust documentation for all MIR structs (#982)
* Add links to the rust documentation for all MIR structs

* Update src/mir/index.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

* Update src/mir/index.md

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>

Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2020-12-06 14:40:45 +01:00
Joshua Nelson 903f6277f4 Link to the Rustdoc book in the rustdoc chapter (#981)
This makes a) makes it easier to find info about rustdoc's features and
b) redirects people in the wrong place to where they should be looking.
2020-12-04 18:23:46 +01:00
mark b3fc04e298 fix a couple links 2020-12-03 00:06:19 -05:00
jumbatm e98d87a670 Use shorter [][]-style link to not pass 100 chars. 2020-12-02 22:34:16 -06:00
jumbatm dc31ca1ca8 Apply suggestions from review.
Co-authored-by: Camelid <camelidcamel@gmail.com>
2020-12-02 22:34:16 -06:00
jumbatm 0e7f5c08b1 Document SessionDiagnostic 2020-12-02 22:34:16 -06:00
Camelid d89703684b Use shorter 'rustbot label' command
'rustbot modify labels: ...' -> 'rustbot label ...'
2020-12-01 13:56:48 -05:00
Joshua Nelson f6f9e0957c 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
Ben Striegel 5661848ab9 Address feedback 2020-11-30 18:06:43 -05:00
Ben Striegel 680e35a172 Add notes about running the UI test suite 2020-11-30 18:06:43 -05:00
Joshua Nelson 43fa1342f0 Document what 'sysroot' means 2020-11-29 20:02:55 -05:00
Joshua Nelson 844ca6f14d Don't imply that the name of the fork always needs to be changed 2020-11-29 10:42:20 -05:00
Joshua Nelson 1f25130a83 Add information about common git issues 2020-11-29 10:42:20 -05:00
Hirochika Matsumoto 98fdbf9406 Fix a typo 2020-11-28 14:09:03 -05:00
Camelid 5dce3301d4 Link to feature-stabilization docs 2020-11-26 20:43:36 -05:00
Camelid ff24e31a36 Move instructions for adding a feature gate to "Feature Gates" 2020-11-26 20:43:36 -05:00
Camelid ea6df8f903 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 c63305c6e8 Document when errors should have an associated error code (#967)
Document when errors should have an associated error code
2020-11-24 17:09:59 -08:00
Gabriel de Perthuis ced315b860 Update bootstrap documentation with the new envvars for RUSTFLAGS
This follows <https://github.com/rust-lang/rust/pull/63722>.
2020-11-24 09:06:33 -05:00
Camelid 2fa114e07d Update `param_env` link
`rustc_ty` was recently [renamed] to `rustc_ty_utils`, so this link has
to be updated.

[renamed]: f59d03038c
2020-11-23 18:40:46 -05:00
cjkenn 49069a0233 add small explanation of why fuel can be useful for debugging 2020-11-22 08:43:00 -05:00
cjkenn ed89d6f643 add mir-opt section for optimization fuel 2020-11-22 08:43:00 -05:00
hosseind88 b2a34704a6 add string interning wikipedia link (#960) 2020-11-15 12:14:06 -05:00
Camelid 661ba74612 Provide a brief example of a data-flow analysis 2020-11-12 11:53:00 -05:00
Camelid 3e4c0c70f2 Explain the purpose of the bottom value 2020-11-12 11:53:00 -05:00
Camelid 6a4c0ee05f Add a section on data-flow convergence 2020-11-12 11:53:00 -05:00
Alexis Bourget 4b00bfb892 Links to htmldocck/@has/matches for searchability 2020-11-11 19:02:37 -05:00
Olivier FAURE 7497da24ca Update src/compiler-debugging.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-11-11 10:39:15 -05:00
Olivier FAURE 4da49360a6 Update link in compiler-debugging.md
Link didn't point to latest version of `env_logger` crate.

Add an explanation to disambiguate the RUSTC_LOG syntax.
2020-11-11 10:39:15 -05:00
Casey Rodarmor d7bb0ad45d Update src/building/how-to-build-and-run.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-11-09 09:07:41 +02:00
Casey Rodarmor 79d3ceb2fa Fix install command 2020-11-09 09:07:41 +02:00
Casey Rodarmor ac0b94deff Document `src/tools/x`, an `x.py` wrapper
Document the newly added `x` binary that wraps `x.py`, which can be
installed system-wide, and can be run from any subdirectory of a rust
repo checkout.
2020-11-09 09:07:41 +02:00
Joshua Nitschke 3f33422aab correct minor grammar mistake (#944)
correct `a lots to `a lot` on implementing_new_features.md
2020-11-08 19:15:22 +01:00
Yuki Okushi 3de0132a0d Use `provide_both` link instead of `provide(_extern)` 2020-11-06 19:18:15 -06:00
Camelid 17c77b296e Use new-style mdBook internal links in glossary 2020-10-28 18:33:30 -04:00
Camelid 5b6f343c87 Put `TyCtxt` at the right position
It should now be at its alphabetical position.

Also fixed link to `TyCtxt` anchor.
2020-10-28 18:33:30 -04:00
Camelid bbcf9282ac Fix broken tags in glossary 2020-10-28 18:33:30 -04:00
Santiago Pastorino c2606a6d54 Small improvements (#936)
* Fix typo errros -> errors

* an -> a

* hir -> hir()
2020-10-27 19:34:28 +01:00
Camelid bec1897ef7 Add "ctxt" and `TyCtxt` to the glossary (#937) 2020-10-27 19:30:20 +01:00
Camelid e58307a28e Clean up `compiletest` chapter (#935) 2020-10-26 11:58:00 +09:00
Yuki Okushi e55ee68ed0 Improve prerequisites section for Windows (#934)
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-26 08:15:21 +09:00
Nadrieril f0cd34e615 Explain lint renaming/removing 2020-10-22 20:41:09 -04:00
Yuki Okushi 61feec113f Add reference PRs for `r?` and `r+` comments (#928) 2020-10-21 23:53:32 +02:00
Yuki Okushi a6279510e2 Replace links to `buildbot2.r-l.o` with `bors.r-l.o` 2020-10-21 17:34:07 -04:00
Joshua Nelson ee849ff66e Revert "Remove outdated build rustdoc --stage 1"
This reverts commit cd35d2b594.
2020-10-19 23:17:17 -04:00
Ivan Tham e4a7be5779 Remove outdated build rustdoc --stage 1
It builds with stage 1 by default.
2020-10-19 22:23:59 -04:00
Santiago Pastorino 269158b77e Fix typo errros -> errors 2020-10-19 14:11:19 -04:00
Nadrieril d859c9924e Explain why exhaustiveness is necessary for soundness 2020-10-16 18:26:10 -04:00
Nadrieril 5ddfd9bfe9 Explain pattern exhaustiveness checking 2020-10-16 18:26:10 -04:00
Yuki Okushi 2b1e754e83 Fix a link on git.md 2020-10-15 23:11:33 -04:00
1c3t3a 5f06872226 Added description of word Scrutinee to the glossary (#921) 2020-10-13 01:57:18 +09:00
LeSeulArtichaut 66649d9c81 Apply suggestions from code review
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-10 12:12:44 -04:00
LeSeulArtichaut eee78ac90f Talk about git submodules 2020-10-10 12:12:44 -04:00
Joshua Nelson d056730692 Recommend debug-logging instead of debug
This makes the compiler faster to running without sacrificing too much
performance. It still shows logging so contributors aren't confused by
`debug!` doing nothing.
2020-10-08 16:15:06 -05:00
Justus K 1ae9303960 Update more occurrences of system llvm link 2020-10-08 11:47:32 -04:00
Stu ac6fb7efa1 Fix broken "system LLVM" link 2020-10-08 11:47:32 -04:00
mautamu db41bec0c9 Fix typos (#916)
Fixed two typos.
2020-10-08 16:19:56 +09:00
Cass 9ccc69f152 Add section describing git hook functionality
This is a companion to [this PR](https://github.com/rust-lang/rust/pull/76356), which deals with including functionality for automatically running `tidy --bless` on each commit.

Undo editor auto-formatting and clarify git hook renaming

a word

Phrasing

Apply suggestions from code review

Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-07 22:30:24 -04:00
Joshua Nelson 5fabea540a Document `Assemble` 2020-10-04 11:59:58 -04:00
Joshua Nelson fcc93a7043 Explain stages in terms of the compiler currently running (take N+1) (#857)
* Explain stages in terms of the compiler currently running

- Address some confusing points
  + stage N+1 -> stage N artifacts
  + Use more likely examples of an ABI break
  + stage N -> stage N compiler

- Mention why rustc occasionally uses `cfg(bootstrap)`
- Note that stage1 is built using two different versions

- Add lots of examples
  + `test src/test/ui` and `test compiler/rustc` run different compilers 😢
  + Separate examples of what to do from examples of what not to do

- 'ship stage 1 artifacts' -> 'ship stage 2 compiler'

  This is hopefully less confusing.

* build -> x.py build

* Add section on build artifacts

* Improve wording

Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>

* uplifted -> assembled

Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-04 16:25:02 +02:00
Who? Me?! 3b4462f582 Link to .md files, rather than .html
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-04 10:14:22 -04:00
mark 42173ef770 address lingering reviewer comments 2020-10-04 10:14:22 -04:00
Gus Wynn 08d244e06c Apply suggestions from code review
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-04 10:14:22 -04:00
Gus Wynn 58255429d8 add note 2020-10-04 10:14:22 -04:00
Gus Wynn c3a67e32dc add suggested workflow to setup nightly rustup for rustc 2020-10-04 10:14:22 -04:00
Julian Wollersberger 9a46f17fab Did more measurements on what exactly affects llvm-lines:
optimize, codegen-units and mir-opt do, but debug-assertions doesn't.
2020-10-04 10:12:47 -04:00
Julian Wollersberger 476dd40f63 Document the usage of cargo-llvm-lines and -Ztimings. 2020-10-04 10:12:47 -04:00
Aleksey Kladov d1651dbd5e Document new way to not build LLVM
Implemented in https://github.com/rust-lang/rust/pull/76349
2020-10-03 20:39:32 -04:00
Santiago Pastorino 773b3c3e95 hir_map -> hir() 2020-10-03 19:38:38 -05:00
LeSeulArtichaut efb9029fc8 Fix time periods for Triage WG procedure 2020-10-03 19:25:05 -05:00
Tshepang Lekhonkhobe c63a20ccbf Update src/getting-started.md
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03 19:25:05 -05:00
Tshepang Lekhonkhobe d3f37158ac Update src/getting-started.md
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03 19:25:05 -05:00
LeSeulArtichaut ff894213a7 Add a paragraph about reviewers and review latency in Getting Started chapter 2020-10-03 19:25:05 -05:00
Camelid b431d8211c Use HTTPS whenever possible in bibliography links (#909)
Also updated a few links that redirected.
2020-10-03 22:56:29 +02:00
Yuki Okushi b61231e905 Fix the report link 2020-10-03 16:12:04 -04:00
Camelid d9a98418f7 Fix instructions for squashing
`git merge-base master` does not work, you need
`git merge-base master HEAD` instead.
2020-10-02 15:08:28 -04:00
Roman 62ae93b3a3 add the last missing code highlight to t-compiler in the docs 2020-10-02 12:37:27 +02:00
Joshua Nelson 1c59aa9409 Fix typo 2020-09-30 22:39:25 +02:00
Jakob Degen 7f590fa025 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 fb23f10071 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 7fdae85e96 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
Santiago Pastorino 915fabf4cc --verbose is useful when not compiling and when compiling (#901) 2020-09-29 17:18:00 +02:00
follower 506f2e77c1 Use implicit reference links for shorter lines
(As suggested by jyn514.)
2020-09-27 10:37:22 -04:00
follower e2a1deb657 Fix line length error.
Reduced line length to <100 (as indicated by PR build error).

(Also removed extra space character before link.)
2020-09-27 10:37:22 -04:00
follower 1e77d7f743 Add links to documentation sources.
Linking directly to the relevant/example document source locations makes it easier for potential contributors to find them.
2020-09-27 10:37:22 -04:00
Joshua Nelson edc31ef0bc Add docs for x.py setup 2020-09-27 04:24:18 +02:00
follower 3ac6fc75ef Add link from "Writing Documentation" suggestion
A link to the relevant section of the contributing documentation makes it easier for contributors to locate the relevant information. (e.g. via an in-page search for "doc".)

This is particularly important currently as 85072e3303/CONTRIBUTING.md links directly to the (currently `rustc`-focused) "Getting Started" guide rather than the general Rust contribution content to which it used to point.
2020-09-26 11:52:14 -04:00
Shahar Or (mightyiam) 2ad2cb7c97 correct output path in Writing Documentation 2020-09-26 08:45:48 -04:00
Youngsuk_Kim 18c7583466 update link to 'BorrowKind' to be implicit in markdown 2020-09-25 22:55:49 -04:00
Youngsuk_Kim 49611100bf add link to 'BorrowKind' in closure.md 2020-09-25 22:55:49 -04:00
Youngsuk_Kim 06fdc4321e update description of 'ByRef' borrows of closures 2020-09-25 22:55:49 -04:00
Youngsuk_Kim a0958b664c minor punctuation/grammar error fix 2020-09-25 22:55:49 -04:00
Jakob Degen b7970e6c5e Remove reference to copyright notices.
Immediately below the section on copyright notices being removed,
it is mentioned that a particular thing should be placed below the
notices. This seems confusing.
2020-09-24 11:45:35 -04:00
Dániel Buga 727a536ba9 Link to the -Zmir-opt-level proposal
I was confused about what the different levels mean. This PR adds a paragraph that shortly explains the rationale behind different mir-opt-levels and links to the current proposal where there's some information about them.

Let me know if I wrote something unreasonable or incorrect.

Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-23 18:42:23 -04:00
Joshua Nelson 7609eb11ee Don't recommend building the compiler for running tests on the standard library (#887)
Thought of this while reading https://internals.rust-lang.org/t/contributing-changes-to-std/12829/.
2020-09-23 15:46:43 +00:00
Camelid ca00e2eefe `ConstEvalResult` is now `EvalToConstValueResult` (#885)
Also fixed typo.
2020-09-22 22:52:05 +02:00
Joshua Nelson 9c5e356ed5 Improve instructions for adding a new test (#881)
* Improve instructions for adding a new test

- Add a section for library tests
- Expand section on rustdoc tests

* Address review comments

- Say what should be considered a library test
- Mention adding error numbers to doc tests
- Link to #ui section
- Line wrapping

* Fix incorrect link

It shouldn't have been a link in the first place.

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-09-19 23:40:17 +00:00
Camelid 27ff56d829 Fix typo in table of contents 2020-09-17 11:35:14 -04:00
Camelid 0a80107e34 Revert "Mention that places are sometimes called "lvalues""
This reverts commit bf5e1c451d.
2020-09-17 11:35:14 -04:00
Camelid e645304ce9 Mention that places are sometimes called "lvalues" 2020-09-17 11:35:14 -04:00
Camelid fd525a93d6 More improvements 2020-09-17 11:35:14 -04:00
Camelid 231e3d9c83 Improve MIR sections in appendix
Add a new graphical representation of one of the examples of MIR and
basic blocks!

And make other minor improvements.
2020-09-17 11:35:14 -04:00
Macdonald Umoren 7bda848e3c debug-logging=true instead of debug-assertions=yes 2020-09-16 21:56:05 -04:00
Dylan MacKenzie 42be58a751 Add link for `AnalysisDomain::NAME` 2020-09-16 00:21:55 -04:00
Dylan MacKenzie ca60ec06df Describe how to generate graphviz diagrams for dataflow 2020-09-16 00:21:55 -04:00
Santiago Pastorino 9f4e7038fa Remove EN1 2020-09-15 18:13:33 -04:00
Santiago Pastorino a7d0f3f2dd Complete text about salsa base inputs 2020-09-15 18:13:33 -04:00
Santiago Pastorino 6cf849f63b Add Salsa In More Depth lecture 2020-09-15 18:13:33 -04:00
LeSeulArtichaut 0d2b8eb1c4 Fix typo
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
2020-09-14 17:42:19 -05:00
LeSeulArtichaut e6a94b2355 Make the HIR chapter point to the new chapter on IDs 2020-09-14 17:42:19 -05:00
LeSeulArtichaut c7ec4769ab Apply suggestions from code review
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-14 17:42:19 -05:00
LeSeulArtichaut fe19fc65f2 Add a chapter on all the identifiers used through `rustc` 2020-09-14 17:42:19 -05:00
Dylan MacKenzie 1fffd48313 Update `Visitor` and `Cursor` examples 2020-09-13 15:58:02 -04:00
Dylan MacKenzie ddc23efa5f Line edits 2020-09-13 15:58:02 -04:00
Dylan MacKenzie 0cc3a9f8f3 Add missing link to `Engine` 2020-09-13 15:58:02 -04:00
Dylan MacKenzie 3db7809e77 Initial draft of MIR dataflow framework docs 2020-09-13 15:58:02 -04:00
Monadic Cat 3b5a774a61 correct attribute used here 2020-09-12 18:41:06 -04:00
Joshua Nelson 7e42258f16 Address nits 2020-09-12 13:12:14 -05:00
Joshua Nelson 01c34848a3 Note that the default is 2015 2020-09-12 13:12:14 -05:00
Joshua Nelson 71853f5a5c Document edition flag for UI tests 2020-09-12 13:12:14 -05:00
LeSeulArtichaut eb39e07c58 Fix typo 2020-09-12 12:07:04 -04:00
LeSeulArtichaut 5ff253c02a Hide `@rustdoc` implementation details 2020-09-12 12:07:04 -04:00
LeSeulArtichaut ab47942c65 Apply suggestions from code review
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe ade9b19f51 Update src/rustbot.md 2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe 9f396a3f1e Update src/rustbot.md 2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe 317a5b33a4 Update src/contributing.md
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-09-12 12:07:04 -04:00
Tshepang Lekhonkhobe 28ca77209b Update src/contributing.md 2020-09-12 12:07:04 -04:00
LeSeulArtichaut a9264c50d6 Add a chapter on useful `@rustbot` commands 2020-09-12 12:07:04 -04:00
Gus Wynn 2ac4ba41ef Improve link and description of entry points in parser section (#876)
This seemed to be out of date!
2020-09-12 08:49:05 +09:00
LeSeulArtichaut 4a8945792e Fix typo
Co-authored-by: Tshepang Lekhonkhobe <tshepang@gmail.com>
2020-09-11 13:42:39 +02:00
LeSeulArtichaut 57794fe4dc Apply suggestions from code review
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-11 13:42:39 +02:00
LeSeulArtichaut d26f268757 Clean up 'Contributing to Rust - Pull Requests' 2020-09-11 13:42:39 +02:00
Joshua Nelson 81f52ce0db Fix other library commands 2020-09-10 23:56:41 -04:00
Joshua Nelson 86e02cda81 Fix incorrect docs about stages
`build library/core` builds the compiler, not just the standard library.
2020-09-10 23:56:41 -04:00
Camelid f0d769ea49 Add back information about Googling
Also cleaned up some other things.
2020-09-09 22:58:18 -04:00
Camelid 53a9cde26c Add back comma
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-09 22:58:18 -04:00
Camelid 38d726f367 Add more info about Rustdoc 2020-09-09 22:58:18 -04:00
Camelid dd3b2059b6 Update "Helpful Links" section 2020-09-09 22:58:18 -04:00