about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
AgeCommit message (Collapse)AuthorLines
2021-03-10Adjust a bit better P- label textSantiago Pastorino-2/+2
2021-03-10Fix typos (#1079)Santiago Pastorino-2/+2
2021-03-09Update cmake version in prerequisites.md (#1077)Wesley Wiser-1/+1
LLVM requires at least cmake 3.13.4. https://www.llvm.org/docs/CMake.html
2021-03-09Fix typo: suceed -> succeedChayim Refael Friedman-1/+1
2021-03-09Add article on using WPA to profile rustc memory usage on Windows (#1074)Wesley Wiser-0/+113
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-07Use more accurate estimate of generated LLVM IR with llvm-linesTomasz Miąsko-27/+41
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-02-28Cleanup rustdoc chapters a bitCamelid-12/+9
* 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-28Fix broken linksYuki Okushi-3/+3
2021-02-26Document how to enable CI LLVM without using `x.py setup`Camelid-0/+8
2021-02-26Remove some unrelated changesCamelid-2/+2
2021-02-26Fix typosCamelid-5/+5
2021-02-26Restore instructions for using system LLVMCamelid-0/+28
They were removed in #1030, but are still useful.
2021-02-26Update some out-of-date informationCamelid-20/+18
2021-02-24Fixes typo in getting started guideDaniel Santos-1/+1
2021-02-22Fix formatting of more date references (#1067)Camelid-27/+38
2021-02-21Fix broken links in query.md (#1068)Hirochika Matsumoto-2/+2
2021-02-20Update docs from date triage for 2021-02 (#1048)Camelid-24/+56
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-20Fix date-check comment formatting (#1066)Camelid-10/+10
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-20Make "URL" show up (#1065)r00ster-1/+1
* Make "URL" show up * Use `<URL>` Co-authored-by: Léo Lanteri Thauvin <leseulartichaut@gmail.com>
2021-02-19Point to main branch on llvm-project's linksYuki Okushi-3/+3
2021-02-18Fix typo (#1063)dmezh-1/+1
2021-02-17Update running.mdbstrie-2/+2
2021-02-15Add Oxide paper to bibliographypierwill-0/+1
2021-02-07Fix typoCamelid-2/+2
2021-02-07Fix typo in Bug Fix Procedure (#1050)Yusuke Tanaka-3/+3
2021-02-04Add chapter on libs and metadata. (#1044)Eric Huss-0/+193
2021-02-04Make check-in.sh output in way that suggest to add only the most relevant infoSantiago Pastorino-6/+2
2021-02-03Add lots of date-check annotationsCamelid-112/+118
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-03Implement date-checkerCamelid-1/+442
This tool looks for HTML comments like `<!-- date: 2021-01 -->` in each Markdown source file and compiles a list of dates that are older than six months. It then opens an issue with that list, with checkboxes for each file and date. Note that it will only open an issue if there was at least one date older than six months; it does nothing if the list is empty. This tool is automatically run monthly in a GitHub Actions workflow. I have tested the tool on a private repo and confirmed that it works.
2021-02-01Document how to stabilize a library feature (#1036)Joshua Nelson-36/+55
* 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-01-30Update test suite descriptions. (#1042)Eric Huss-4/+5
2021-01-30put `x.py` in ticksHenry Boisdequin-1/+1
2021-01-24Update links to `librustc_llvm` and `rustllvm`LeSeulArtichaut-11/+12
2021-01-22Add link to promotion.md (#1033)Joshua Nelson-1/+1
* Add link to promotion.md * Improve link text Co-authored-by: Camelid <camelidcamel@gmail.com> Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-01-21Add missing periodCamelid-1/+1
2021-01-20Remove "Skipping LLVM build" sectionJoshua Nelson-34/+9
`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-20Add mdbook-toc, markers, and documentation (#1028)Iñaki Garay-76/+177
* Add mdbook-toc to travis, book.toml and documentation * Add toc markers * Whitespace cleanup and some punctuation * Addressed comments
2021-01-19Link to `feature_err` in stability section (#1022)Joshua Nelson-1/+4
2021-01-17Fix typo (#1027)Martin Geisler-1/+1
2021-01-17Note that `--check` now allows using any stageJoshua Nelson-4/+1
2021-01-16improved the readablity of a lineashosive-1/+1
2021-01-16Fixed a grammatical error in hardawre requirements sectionsaki-osive-1/+1
2021-01-14Corrected MIR file path and fixed a typo (#1020)saki-osive-2/+2
2021-01-12Add a note about UI test entry limitation (#1019)Yuki Okushi-0/+17
2021-01-10Add context to dated information (#1013)Iñaki Garay-67/+90
* 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-10Update 'Workspace structure' section (#1017)Camelid-6/+12
* Update description of `src/` * Note that `library/` also contains the Rust runtime
2021-01-09Point to `HirId` instead of `NodeId`Camelid-1/+1
2021-01-09Fix typo (#1016)Camelid-1/+1
"currenty"!
2021-01-05Break up long lineRyan Levick-1/+2
2021-01-05Remove backticks and comment about possible bugRyan Levick-5/+1