about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2020-09-10Rollup merge of #76555 - alilleybrinker:reword_trivial_casts_lint_doc, ↵Tyler Mandry-1/+2
r=steveklabnik Reword `trivial_casts` lint in rustc book to better explain what it does. The current description of the trivial casts lint under the "allowed by default" listing in the rustc book indicates the lint is for casts which may be removed, which is less clear than saying it's for casts which may be replaced by coercion (which is the wording used by the error message included in the doc). This commit changes the wording slightly to better describe what the lint does. This issue bit me in some recent code where I was attempting to convert a `Vec<SomeType>` to a `Vec<SomeTraitObject>`, and hit my project-wide `#![deny(trivial_casts)]` with `map(|o| Box::new(o) as TraitObject)`. I'd read the book docs for `trivial_casts` and was surprised by the error, as I took it to mean the cast ought to be removed (rather than replaced by ascription in this case). Removing the cast meant other code didn't compile, and I then found issues like #23742 and realized my misunderstanding.
2020-09-10Rollup merge of #76289 - arijit79:master, r=jyn514Tyler Mandry-0/+23
Add docs about crate level documentation support Wrote information about how to write documentation on the crate level in rhe rustdoc book
2020-09-10Add docs about crate level documentation supportarijit79-0/+23
2020-09-09Reword `trivial_casts` lint to better explain.Andrew Lilley Brinker-1/+2
The current description of the trivial casts lint under the "allowed by default" listing in the rustc book indicates the lint is for lints which may be removed, which is less clear than saying it's for lints which may be replaced by coercion (which is the wording used by the error message included in the doc). This commit changes the wording slightly to better describe what the lint does.
2020-09-09Rollup merge of #76465 - jyn514:auto-versioning, r=elichaiTyler Mandry-0/+22
Add a script to automatically update Rust/Clang versions in documentation From https://github.com/rust-lang/rust/pull/76402#issuecomment-687974508. r? @elichai
2020-09-09Rollup merge of #76430 - pickfire:patch-7, r=steveklabnikTyler Mandry-2/+2
Add align to rustc-attrs unstable book
2020-09-09Rollup merge of #76402 - elichai:patch-2, r=wesleywiserDylan DPC-12/+15
Update linker-plugin-lto.md to contain up to rust 1.46 Hi, this is the same as https://github.com/rust-lang/rust/pull/72290, if anyone has suggestions on how to automate this please say :) otherwise, you can check the versions I've added via: ```sh $ rustup install 1.44.0 $ rustc +1.44.0 -Vv rustc 1.44.0 (49cae5576 2020-06-01) binary: rustc commit-hash: 49cae55760da0a43428eba73abcb659bb70cf2e4 commit-date: 2020-06-01 host: x86_64-unknown-linux-gnu release: 1.44.0 LLVM version: 9.0 $ rustup install 1.45.0 $ rustc +1.45.0 -Vv rustc 1.45.0 (5c1f21c3b 2020-07-13) binary: rustc commit-hash: 5c1f21c3b82297671ad3ae1e8c942d2ca92e84f2 commit-date: 2020-07-13 host: x86_64-unknown-linux-gnu release: 1.45.0 LLVM version: 10.0 $ rustup install 1.46.0 $ rustc +stable -Vv rustc 1.46.0 (04488afe3 2020-08-24) binary: rustc commit-hash: 04488afe34512aa4c33566eb16d8c912a3ae04f9 commit-date: 2020-08-24 host: x86_64-unknown-linux-gnu release: 1.46.0 LLVM version: 10.0 ```
2020-09-07Add a script to automatically update Rust/Clang versionsJoshua Nelson-0/+22
2020-09-08Unstable book rust-attrs does not work on genericsIvan Tham-1/+1
Co-authored-by: Peter Todd <pete@petertodd.org>
2020-09-07Add align to rustc-attrs unstable bookIvan Tham-2/+2
2020-09-06linker-plugin-lto.md: Convert the rust-clang MxN table to a 2xM tableElichai Turkel-15/+15
2020-09-06Update linker-plugin-lto.md to contain up to rust 1.46Elichai Turkel-12/+15
2020-09-05Adjust documentation for slice_check_rangedylni-0/+10
2020-09-05Rollup merge of #75954 - ArekPiekarz:unstable_book_ffi_tracking_issues, ↵Dylan DPC-0/+10
r=steveklabnik Unstable Book: add links to tracking issues for FFI features
2020-09-02Update booksEric Huss-0/+0
2020-09-01Rollup merge of #76212 - JesHansen:fix-lint-doc, r=jyn514Tyler Mandry-1/+1
Document lint missing_doc_code_examples is nightly-only Closes #76194
2020-09-01Document lint missing_doc_code_examples is nightly-onlyJes Bak Hansen-1/+1
2020-08-31Stabilise link-self-contained optionMateusz Mikuła-4/+16
2020-08-30Auto merge of #75919 - rust-lang:jonas-schievink-patch-1, r=ehussbors-1/+1
Fix typo (`thumbv8m.main-none-eabihf` is Mainline)
2020-08-30Rollup merge of #75892 - ArekPiekarz:unstable_book_tls_model_typo, ↵Dylan DPC-1/+1
r=petrochenkov Fix typo in TLS Model in Unstable Book
2020-08-27Auto merge of #74941 - dylanmckay:replace-broken-avr-unknown-unknown-target, ↵bors-1/+1
r=oli-obk [AVR] Replace broken 'avr-unknown-unknown' target with 'avr-unknown-gnu-atmega328' target The `avr-unknown-unknown` target has never worked correctly, always trying to invoke the host linker and failing. It aimed to be a mirror of AVR-GCC's default handling of the `avr-unknown-unknown' triple (assume bare minimum chip features, silently skip linking runtime libraries, etc). This behaviour is broken-by-default as it will cause a miscompiled executable when flashed. This patch improves the AVR builtin target specifications to instead expose only a 'avr-unknown-gnu-atmega328' target. This target system is `gnu`, as it uses the AVR-GCC frontend along with avr-binutils. The target triple ABI is 'atmega328'. In the future, it should be possible to replace the dependency on AVR-GCC and binutils by using the in-progress AVR LLD and compiler-rt support. Perhaps at that point it would make sense to add an 'avr-unknown-unknown-atmega328' target as a better default when implemented. There is no current intention to add in-tree AVR target specifications for other AVR microcontrollers - this one can serve as a reference implementation for other devices via `rustc --print target-spec-json avr-unknown-gnu-atmega328p`. There should be no users of the existing 'avr-unknown-unknown' Rust target as a custom target specification JSON has always been recommended, and the avr-unknown-unknown target could never pass the linking step anyway.
2020-08-26Unstable Book: add links to tracking issues for FFI featuresArkadiusz Piekarz-0/+10
2020-08-25Fix typo (`thumbv8m.main-none-eabihf` is Mainline)Jonas Schievink-1/+1
2020-08-24Fix typo in TLS Model in Unstable BookArkadiusz Piekarz-1/+1
2020-08-24[AVR] Replace 'avr-unknown-unknown' with 'avr-unknown-gnu-atmega328' in ↵Dylan McKay-1/+1
platform-support.md
2020-08-23Document prim@ and primitive@Joshua Nelson-1/+1
2020-08-22Rollup merge of #75753 - koutheir:patch-1, r=steveklabnikDylan DPC-2/+3
Another motivation for CFG: return-oriented programming
2020-08-21Added link to Microsoft's documentation of CFGDr. Koutheir Attouchi-1/+1
2020-08-21Fixed a typoDr. Koutheir Attouchi-1/+1
2020-08-21Improve wordingGuillaume Gomez-1/+1
2020-08-21Switched ROP link to Desktop layout instead of mobile layoutDr. Koutheir Attouchi-1/+1
2020-08-20Another motivation for CFG: return-oriented programmingDr. Koutheir Attouchi-1/+2
2020-08-20Add documentation for --show-coverage optionGuillaume Gomez-0/+33
2020-08-19Update booksEric Huss-0/+0
2020-08-18Remove missing_fragment_specifier lintAleksey Kladov-9/+0
2020-08-17Mark x86_64-linux-kernel as *Sasha-1/+1
2020-08-14Move CloudABI to tier 3.Eric Huss-1/+1
2020-08-13Auto merge of #75431 - ehuss:platform-support, r=Mark-Simulacrumbors-5/+234
Move platform support to the rustc book. This moves the [Platform Support](https://forge.rust-lang.org/release/platform-support.html) page from the forge to the rustc book. There are several reasons for doing this: * The forge is not really oriented towards end-users (it mostly contains infrastructure, governance and policy, internal team pages, etc.). This platform support page is useful to user to know which targets are supported. * This page can now be updated in-sync with any PRs that add or remove a target, or change its status. * This is now automatically checked on CI to verify the list does not get out of sync. Currently it only checks the presence/absence of an entry, but more sophisticated checks could be added in the future. I'm not 100% certain this is the best location, but I think it fits. I'd like to see the rustc guide continue to grow, including things like linking information and more platform-specific details.
2020-08-12Add a script to verify the Platform Support page is up-to-date.Eric Huss-8/+9
2020-08-11Platform Support page updates.Eric Huss-193/+198
A few updates: - Some minor wording and formatting changes. - Remove the `cargo` column. - Explain the columns up-front. - Add no-wrap on the target-triple, which looks better to me. - Minor mention on how to install support for a built-in target via rustup.
2020-08-11Move forge platform-support to the rustc book.Eric Huss-0/+223
2020-08-06Update asm! documentation in unstable bookAmanieu d'Antras-1/+13
- Update the list of supported architectures. - Clarify issues with LLVM's use of reserved registers.
2020-08-04Update booksEric Huss-0/+0
2020-08-01Rollup merge of #74981 - giraffate:fix_sample_codes_in_unstable_book_plugin, ↵Manish Goregaokar-16/+14
r=GuilliameGomez Some fixes for `plugin.md` in unstable-book - sample codes not working I referred to https://github.com/rust-lang/rust/blob/master/src/test/ui-fulldeps/auxiliary/lint-plugin-test.rs and https://github.com/rust-lang/rust/blob/master/src/test/ui-fulldeps/lint-plugin.rs. - broken link https://github.com/rust-lang/rust/blob/master/src/librustc/lint/builtin.rs -> https://github.com/rust-lang/rust/blob/master/src/librustc_session/lint/builtin.rs
2020-07-31Some fixes for `plugin.md` in unstable-bookTakayuki Nakata-16/+14
- sample codes not working - broken link
2020-07-31Auto merge of #74926 - Manishearth:rename-lint, r=jyn514bors-1/+1
Rename intra_doc_link_resolution_failure It should be plural to follow the conventions in https://github.com/rust-lang/rfcs/blob/master/text/0344-conventions-galore.md#lints
2020-07-30intra_doc_resolution_failures -> broken_intra_doc_linksManish Goregaokar-1/+1
2020-07-30Rename to intra_doc_resolution_failuresManish Goregaokar-1/+1
2020-07-29Rename usage of intra_doc_link_resolution_failureManish Goregaokar-1/+1
2020-07-29Fix broken link in unstable book `plugin`Takayuki Nakata-1/+1