about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2020-12-26Add links to the source for the rustc and rustdoc books.Eric Huss-0/+6
2020-12-25Auto merge of #80296 - ↵bors-3/+0
wesleywiser:revert_missing_fragment_specifier_hard_error, r=Mark-Simulacrum Revert missing fragment specifier hard error Closes #76605 Reopens #40107 r? `@Mark-Simulacrum`
2020-12-22Revert "Remove missing_fragment_specifier lint"Wesley Wiser-3/+0
This reverts commit 5ba961018c482e050af908de60e4f8bd1a00f0ae.
2020-12-21Update booksEric Huss-0/+0
2020-12-13Fix `cargo-binutils` linkEFanZh-3/+3
2020-12-12Document `error-pattern` header (#989)Yuki Okushi-0/+33
* Document `error-pattern` header * Address some reviews
2020-12-11Fix some link failures and typosYuki Okushi-10/+10
2020-12-10Rollup merge of #79858 - sasurau4:doc/update-unstable-book-const-fn, r=oli-obkTyler Mandry-21/+2
Update const-fn doc in unstable-book Fix #79691 I couldn't find suitable examples. It seems that `const_fn` feature-gate used only following place. https://github.com/rust-lang/rust/blob/810324d1f31eb8d75e8f0044df720652986ef133/compiler/rustc_ast_passes/src/feature_gate.rs#L560-L562 And example like following emits [E0379](https://doc.rust-lang.org/error-index.html#E0379). ```rust #![feature(const_fn)] trait Foo { const fn bar() -> Self; } ``` Any other suitable example exists, please let me know.
2020-12-10Update sanitizer supported docs to reflect realityCorey Farwell-2/+26
2020-12-10All links to rustdoc-internals.mdNixon Enraght-Moony-0/+10
2020-12-10Update const-fn doc in unstable-bookDaiki Ihara-21/+2
Update src/doc/unstable-book/src/language-features/const-fn.md Co-authored-by: Ivan Tham <pickfire@riseup.net>
2020-12-07Fixes to Rust coverageRich Kadel-4/+87
Fixes: #79725 Some macros can create a situation where `fn_sig_span` and `body_span` map to different files. New documentation on coverage tests incorrectly assumed multiple test binaries could just be listed at the end of the `llvm-cov` command, but it turns out each binary needs a `--object` prefix. This PR fixes the bug and updates the documentation to correct that issue. It also fixes a few other minor issues in internal implementation comments, and adds documentation on getting coverage results for doc tests.
2020-12-07Add a section on identifiers in the MIR (#951)Camelid-2/+47
* 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-07Adds a dev guide section on Rust CoverageRich Kadel-1/+635
2020-12-06Edit the Mir page to fix infelicities. (#984)Siddharth-12/+17
* 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-06Add links to the rust documentation for all MIR structs (#982)Siddharth-11/+22
* 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-04Link to the Rustdoc book in the rustdoc chapter (#981)Joshua Nelson-0/+2
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-03Addressed feedback from 2020-12-01Rich Kadel-0/+2
Added one more test (two files) showing coverage of generics and unused functions across crates. Created and referenced new Issues, as requested. Added comments. Added a note about the possible effects of compiler options on LLVM coverage maps.
2020-12-03Combination of commitsRich Kadel-14/+89
Fixes multiple issue with counters, with simplification Includes a change to the implicit else span in ast_lowering, so coverage of the implicit else no longer spans the `then` block. Adds coverage for unused closures and async function bodies. Fixes: #78542 Adding unreachable regions for known MIR missing from coverage map Cleaned up PR commits, and removed link-dead-code requirement and tests Coverage no longer depends on Issue #76038 (`-C link-dead-code` is no longer needed or enforced, so MSVC can use the same tests as Linux and MacOS now) Restrict adding unreachable regions to covered files Improved the code that adds coverage for uncalled functions (with MIR but not-codegenned) to avoid generating coverage in files not already included in the files with covered functions. Resolved last known issue requiring --emit llvm-ir workaround Fixed bugs in how unreachable code spans were added.
2020-12-03Coverage tests for remaining TerminatorKinds and async, improve AssertRich Kadel-3/+1
Tested and validate results for panic unwind, panic abort, assert!() macro, TerminatorKind::Assert (for example, numeric overflow), and async/await. Implemented a previous documented idea to change Assert handling to be the same as FalseUnwind and Goto, so it doesn't get its own BasicCoverageBlock anymore. This changed a couple of coverage regions, but I validated those changes are not any worse than the prior results, and probably help assure some consistency (even if some people might disagree with how the code region is consistently computed). Fixed issue with async/await. AggregateKind::Generator needs to be handled like AggregateKind::Closure; coverage span for the outer async function should not "cover" the async body, which is actually executed in a separate "closure" MIR.
2020-12-03fix typo in src/doc/rustdoc/src/command-line-arguments.mdIan Jackson-1/+1
Co-authored-by: Guillaume Gomez <guillaume1.gomez@gmail.com>
2020-12-03fix a couple linksmark-5/+5
2020-12-03exclude play.rlo from linkchecksmark-1/+1
2020-12-02Use shorter [][]-style link to not pass 100 chars.jumbatm-1/+3
2020-12-02Apply suggestions from review.jumbatm-3/+3
Co-authored-by: Camelid <camelidcamel@gmail.com>
2020-12-02Document SessionDiagnosticjumbatm-0/+102
2020-12-03rustdoc: document --default-theme option in command line docIan Jackson-0/+20
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
2020-12-01Auto merge of #78684 - devsnek:inline-asm-wasm, r=Amanieubors-0/+5
Add wasm32 support to inline asm There is some contention around inline asm and wasm, and I really only made this to figure out the process of hacking on rustc, but I figured as long as the code existed, it was worth uploading. cc `@Amanieu`
2020-12-01Use shorter 'rustbot label' commandCamelid-1/+1
'rustbot modify labels: ...' -> 'rustbot label ...'
2020-12-01Add wasm32 support to inline asmGus Caplan-0/+5
2020-12-01Rollup merge of #79583 - ehuss:update-books, r=ehussMara Bos-0/+0
Update books ## nomicon 1 commits in 23c49f1d5ce4720bc5b7e3a920f47eccc8da6b63..d8383b65f7948c2ca19191b3b4bd709b403aaf45 2020-11-05 13:30:53 +0900 to 2020-11-22 10:24:42 -0500 - Clarify that any alignment is valid for ZSTs ## reference 5 commits in a7de763c213292f5b44bf10acb87ffa38724814d..a8afdca5d0715b2257b6f8b9a032fd4dd7dae855 2020-11-11 19:13:21 -0800 to 2020-11-30 06:44:46 -0800 - Describe relationship between reference and optimizers (rust-lang/reference#902) - A simple missing space (rust-lang/reference#909) - Cleanup formatting (rust-lang/reference#907) - Use `doc`, not `test` for fn item inner attr example (rust-lang/reference#906) - Update where our chat is. (rust-lang/reference#903) ## book 1 commits in 13e1c05420bca86ecc79e4ba5b6d02de9bd53c62..a190438d77d28041f24da4f6592e287fab073a61 2020-10-20 14:57:32 -0500 to 2020-11-16 10:44:08 -0600 - Change SipHash not found (404) link to SipHash in Wikipedia (rust-lang/book#2503) ## rust-by-example 4 commits in 1886fda6981b723e4de637074455558f8bc1e83c..236c734a2cb323541b3394f98682cb981b9ec086 2020-10-28 13:46:54 -0500 to 2020-11-30 14:05:49 -0300 - Update old invalid link (rust-lang/rust-by-example#1392) - Moved "See also" link to the correct page. (rust-lang/rust-by-example#1389) - Fix some markdown lint warnings (rust-lang/rust-by-example#1388) - Minor grammar suggestion (rust-lang/rust-by-example#1386) ## embedded-book 1 commits in ca8169e69b479f615855d0eece7e318138fcfc00..ba34b8a968f9531d38c4dc4411d5568b7c076bfe 2020-10-15 15:06:35 +0000 to 2020-11-17 00:20:43 +0000 - Clarify CAS availability (rust-embedded/book#273)
2020-12-01Rollup merge of #79573 - he32:master, r=jonas-schievinkMara Bos-4/+4
Update with status for various NetBSD ports. The NetBSD ports of rust to aarch64, armv7*, i686, and powerpc** all both build and run. Status is as of rust 1.47.0. *) Natively requires repeated successive build attempts (`rustc` is such a resource pig VM-consumption-wise), or run in a chroot on an aarch64 host where the available VM space is 4GB instead of the native 2GB. **) Powerpc either requires `-latomic` in a directory searched by default by `ld` or to be built within pkgsrc which has a patch and support package to tackle this issue.
2020-11-30Update booksEric Huss-0/+0
2020-11-30Move the bootstrapping section later in the guide (#975)Joshua Nelson-1/+1
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-30Address feedbackBen Striegel-37/+15
2020-11-30Add notes about running the UI test suiteBen Striegel-0/+37
2020-11-30Update with status for various NetBSD ports.Havard Eidnes-4/+4
The NetBSD ports of rust to aarch64, armv7*, i686, and powerpc** all both build and run. *) Natively requires repeated successive build attempts (rustc is such a resource pig VM-consumption-wise), or run in a chroot on an aarch64 host where the available VM space is 4GB instead of the native 2GB. **) Powerpc either requires -latomic in a directory searched by default by 'ld' or to be built within pkgsrc which has a patch to tackle this.
2020-11-30Improve contributor experience for the dev-guide itself (#973)Joshua Nelson-57/+14
- Fix typos in the README - Don't echo all instructions in the linkcheck.sh shellscript; this is noisy and unhelpful when developing locally. Verbose output is still enabled in CI. - Link to the index page for compiler docs, not `rustc_middle`. Note that the compiler docs are not a guide - that's us! - Remove outdated instructions about avoiding 429s. These should no longer be occurring locally now that we're using caching. - Consolidate info about `mdbook` and `mdbook-linkcheck` near each other
2020-11-30Add built-in support for the armv5te-unknown-linux-uclibceabi targetOndrej Perutka-0/+1
2020-11-29Document what 'sysroot' meansJoshua Nelson-0/+60
2020-11-29Don't imply that the name of the fork always needs to be changedJoshua Nelson-1/+1
2020-11-29Add information about common git issuesJoshua Nelson-1/+50
2020-11-28Fix a typoHirochika Matsumoto-1/+1
2020-11-26Link to feature-stabilization docsCamelid-3/+11
2020-11-26Move instructions for adding a feature gate to "Feature Gates"Camelid-22/+35
2020-11-26Document how to modify feature gatesCamelid-0/+66
How to remove them and how to rename them. cc <https://github.com/rust-lang/rust/pull/79336#discussion_r528627318> cc @varkor
2020-11-26Add to platform-support.mdBenedikt Terhechte-1/+1
2020-11-26Add support for Arm64 Catalyst on ARM MacsBenedikt Terhechte-0/+1
2020-11-25Auto merge of #79336 - camelid:rename-feature-oibit-to-auto, r=oli-obkbors-3/+3
Rename `optin_builtin_traits` to `auto_traits` They were originally called "opt-in, built-in traits" (OIBITs), but people realized that the name was too confusing and a mouthful, and so they were renamed to just "auto traits". The feature flag's name wasn't updated, though, so that's what this PR does. There are some other spots in the compiler that still refer to OIBITs, but I don't think changing those now is worth it since they are internal and not particularly relevant to this PR. Also see <https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/opt-in.2C.20built-in.20traits.20(auto.20traits).20feature.20name>. r? `@oli-obk` (feel free to re-assign if you're not the right reviewer for this)
2020-11-24Document when errors should have an associated error code (#967)Camelid-2/+11
Document when errors should have an associated error code
generated by cgit-pink 1.4.1-3-g733a5 (git 2.37.1) at 2026-02-27 15:31:57 +0000