about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
AgeCommit message (Collapse)AuthorLines
2020-10-04Explain stages in terms of the compiler currently running (take N+1) (#857)Joshua Nelson-114/+127
* 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-04Link to .md files, rather than .htmlWho? Me?!-3/+3
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-04address lingering reviewer commentsmark-3/+7
2020-10-04Apply suggestions from code reviewGus Wynn-1/+3
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-04add noteGus Wynn-0/+5
2020-10-04add suggested workflow to setup nightly rustup for rustcGus Wynn-0/+16
2020-10-04Did more measurements on what exactly affects llvm-lines:Julian Wollersberger-14/+13
optimize, codegen-units and mir-opt do, but debug-assertions doesn't.
2020-10-04Document the usage of cargo-llvm-lines and -Ztimings.Julian Wollersberger-1/+80
2020-10-03Document new way to not build LLVMAleksey Kladov-4/+13
Implemented in https://github.com/rust-lang/rust/pull/76349
2020-10-03hir_map -> hir()Santiago Pastorino-2/+2
2020-10-03Fix time periods for Triage WG procedureLeSeulArtichaut-2/+2
2020-10-03Update src/getting-started.mdTshepang Lekhonkhobe-1/+1
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03Update src/getting-started.mdTshepang Lekhonkhobe-1/+1
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com>
2020-10-03Add a paragraph about reviewers and review latency in Getting Started chapterLeSeulArtichaut-0/+11
2020-10-03Use HTTPS whenever possible in bibliography links (#909)Camelid-20/+20
Also updated a few links that redirected.
2020-10-03Fix the report linkYuki Okushi-1/+1
2020-10-02Fix instructions for squashingCamelid-1/+1
`git merge-base master` does not work, you need `git merge-base master HEAD` instead.
2020-10-02add the last missing code highlight to t-compiler in the docsRoman-2/+2
2020-10-01Fix incorrect windows linkJoshua Nelson-1/+1
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-10-01Add windows instructionsJoshua Nelson-1/+9
2020-10-01Recommend setting up `check_line_lengths` as a pre-commit scriptJoshua Nelson-9/+19
I've run into lots of annoying failures from this. - Make it runnable without arguments - Add it in the README
2020-09-30Fix typoJoshua Nelson-1/+1
2020-09-30Incorporated suggestions into git page and edit for more brevity.Jakob Degen-47/+52
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-30Edit using git page for brevity and clarity.Jakob Degen-52/+36
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-30Add a section on using git.Jakob Degen-0/+204
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-29--verbose is useful when not compiling and when compiling (#901)Santiago Pastorino-2/+2
2020-09-27Use implicit reference links for shorter linesfollower-4/+4
(As suggested by jyn514.)
2020-09-27Fix line length error.follower-3/+3
Reduced line length to <100 (as indicated by PR build error). (Also removed extra space character before link.)
2020-09-27Add links to documentation sources.follower-2/+5
Linking directly to the relevant/example document source locations makes it easier for potential contributors to find them.
2020-09-27Add docs for x.py setupJoshua Nelson-14/+21
2020-09-26Add link from "Writing Documentation" suggestionfollower-1/+2
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 https://github.com/rust-lang/rust/blob/85072e330394440776ace5ae612e3ced32ef6348/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-26correct output path in Writing DocumentationShahar Or (mightyiam)-1/+1
2020-09-25update link to 'BorrowKind' to be implicit in markdownYoungsuk_Kim-2/+2
2020-09-25add link to 'BorrowKind' in closure.mdYoungsuk_Kim-3/+4
2020-09-25update description of 'ByRef' borrows of closuresYoungsuk_Kim-3/+3
2020-09-25minor punctuation/grammar error fixYoungsuk_Kim-4/+4
2020-09-24Remove reference to copyright notices.Jakob Degen-2/+1
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-23Link to the -Zmir-opt-level proposalDániel Buga-1/+14
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-23Don't recommend building the compiler for running tests on the standard ↵Joshua Nelson-3/+3
library (#887) Thought of this while reading https://internals.rust-lang.org/t/contributing-changes-to-std/12829/.
2020-09-22`ConstEvalResult` is now `EvalToConstValueResult` (#885)Camelid-2/+2
Also fixed typo.
2020-09-19Improve instructions for adding a new test (#881)Joshua Nelson-4/+14
* 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-17Fix typo in table of contentsCamelid-1/+1
2020-09-17Revert "Mention that places are sometimes called "lvalues""Camelid-2/+1
This reverts commit bf5e1c451de505fa453672c1168b09db07a145cb.
2020-09-17Mention that places are sometimes called "lvalues"Camelid-1/+2
2020-09-17More improvementsCamelid-5/+5
2020-09-17Improve MIR sections in appendixCamelid-27/+54
Add a new graphical representation of one of the examples of MIR and basic blocks! And make other minor improvements.
2020-09-16debug-logging=true instead of debug-assertions=yesMacdonald Umoren-2/+2
2020-09-16Add link for `AnalysisDomain::NAME`Dylan MacKenzie-1/+2
2020-09-16Describe how to generate graphviz diagrams for dataflowDylan MacKenzie-0/+20
2020-09-15Remove EN1Santiago Pastorino-4/+2
generated by cgit-pink 1.4.1-3-g733a5 (git 2.37.1) at 2026-02-23 13:22:43 +0000