about summary refs log tree commit diff
path: root/src/doc
AgeCommit message (Collapse)AuthorLines
2020-11-09Rollup merge of #78228 - pietroalbini:finally, r=Mark-SimulacrumDylan DPC-1/+7
Promote aarch64-unknown-linux-gnu to Tier 1 This PR promotes the `aarch64-unknown-linux-gnu` target to Tier 1, as proposed by [RFC 2959]: * The `aarch64-gnu` CI job is moved from `auto-fallible` to `auto`. * The platform support documentation is updated, uplifting the target to Tiert 1 with a note about missing stack probes support. * Building the documentation is enabled for the target, as we produce the `rust-docs` component for all Tier 1 platforms. [RFC 2959]: https://github.com/rust-lang/rfcs/pull/2959
2020-11-06Auto merge of #75778 - AndyGauge:75521-rustdoc-book-improvements, r=jyn514bors-31/+282
75521 rustdoc book improvements Added some guidelines about documenting with rustdoc Fixes #75521
2020-11-07Rollup merge of #78726 - GuillaumeGomez:back-link-to-main-website, ↵Yuki Okushi-1/+2
r=steveklabnik Add link to rust website Fixes #30838 This doesn't fix the issue as suggested but it at least adds a link to allow to go back to the rust website. r? `@steveklabnik`
2020-11-05doc/rustc: promote aarch64-unknown-linux-gnu to tier 1Pietro Albini-1/+7
This also adds a note about missing stack probes support, per the discussion on RFC 2959.
2020-11-05Rename lint to non_autolinksGuillaume Gomez-2/+2
2020-11-05Update URLs used in the lint exampleGuillaume Gomez-14/+15
2020-11-05Rename automatic_links to url_improvementsGuillaume Gomez-1/+1
2020-11-05Improve automatic_links globallyGuillaume Gomez-10/+3
2020-11-05Extend automatic_links lint to take into account URLs without link syntaxGuillaume Gomez-9/+13
2020-11-05Add documentation for automatic_links lintGuillaume Gomez-0/+40
2020-11-04Added Rustdoc book sections for linting and embedding more examplesAndrew Gauger-31/+282
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-11-04ci: demote i686-unknown-freebsd to tier 2 compiler targetPietro Albini-1/+1
While technically the i686-unknown-freebsd target has been a tier 2 development platform for a long time, with full toolchain tarballs available on static.rust-lang.org, due to a bug in the manifest generation the target was never available for download through rustup. The infrastructure team privately inquired the FreeBSD package maintainers, and they weren't relying on those tarballs either, so it's a fair assumption to say practically nobody is using those tarballs. This PR then removes the CI builder that produces full tarballs for the target, and moves the compilation of rust-std for the target in dist-various-2. The x86_64-unknown-freebsd target is *not* affected.
2020-11-04Add link to rust websiteGuillaume Gomez-1/+2
2020-11-03Rollup merge of #77950 - arlosi:sha256, r=eddybMara Bos-1/+1
Add support for SHA256 source file hashing Adds support for `-Z src-hash-algorithm sha256`, which became available in LLVM 11. Using an older version of LLVM will cause an error `invalid checksum kind` if the hash algorithm is set to sha256. r? `@eddyb` cc #70401 `@est31`
2020-11-03Rollup merge of #78676 - kiffie:embedded-bare-mipsr2, r=jonas-schievinkYuki Okushi-0/+1
add mipsel-unknown-none target This adds a target for bare MIPS32r2, little endian, softfloat. This target can be used for PIC32 microcontrollers (or possibly for other devices that have a MIPS MCU core such as the M4K core). Tried to find a name for the target that is in line with the naming scheme apparently used for the other MIPS targets. r? `@jonas-schievink`
2020-11-03Rollup merge of #78616 - richkadel:unstable-book-instr-cov, r=tmandryYuki Okushi-0/+169
Document -Zinstrument-coverage r? ``@tmandry`` FYI ``@wesleywiser`` Here is my proposed document for LLVM source-based code coverage. I based it on the `profile.md` page, in the same directory, and on the Clang guide for LLVM source-based coverage.
2020-11-02add mipsel-unknown-none targetStephan-0/+1
2020-11-02addressed feedbackRich Kadel-15/+24
2020-11-01Document -Zinstrument-coverageRich Kadel-0/+160
2020-10-29Rollup merge of #78492 - ehuss:update-books, r=ehussYuki Okushi-0/+0
Update books ## nomicon 7 commits in 6e57e64501f61873ab80cb78a07180a22751a5d6..69333eddb1de92fd17e272ce4677cc983d3bd71d 2020-09-14 11:40:23 -0400 to 2020-10-17 15:44:12 -0700 - Tweak GHA config (rust-lang-nursery/nomicon#240) - Fix link for `[T]` (rust-lang-nursery/nomicon#239) - Update casts.md (rust-lang-nursery/nomicon#232) - [WIP] Add more links (rust-lang-nursery/nomicon#180) - Data Race definition should be more precise (rust-lang-nursery/nomicon#219) - Update the diagnostic of `error[E0597]` in dropck.md (rust-lang-nursery/nomicon#157) - fix typo in Lifetimes mutable reference aliasing section (rust-lang-nursery/nomicon#225) ## reference 3 commits in 1b78182e71709169dc0f1c3acdc4541b6860e1c4..10c16caebe475d0d11bec0531b95d7697856c13c 2020-10-11 13:53:47 -0700 to 2020-10-25 20:51:26 -0700 - Add `unsafe` for `mod` and `extern`. (rust-lang-nursery/reference#898) - mention how unions interact with dropping (rust-lang-nursery/reference#897) - Add `move_ref_pattern` docs (rust-lang-nursery/reference#881) ## book 2 commits in 451a1e30f2dd137aa04e142414eafb8d05f87f84..13e1c05420bca86ecc79e4ba5b6d02de9bd53c62 2020-10-05 09:11:18 -0500 to 2020-10-20 14:57:32 -0500 - Referencing to Appendix B (rust-lang/book#2481) - Use GITHUB_PATH instead of add-path (rust-lang/book#2477) ## rust-by-example 2 commits in 152475937a8d8a1f508d8eeb57db79139bc803d9..99eafee0cb14e6ec641bf02a69d7b30f6058349a 2020-10-09 09:29:50 -0300 to 2020-10-21 14:21:55 -0300 - Formatting footer items. (rust-lang/rust-by-example#1385) - Add partial moves example for `move_ref_pattern` stabilization (rust-lang/rust-by-example#1377) ## edition-guide 3 commits in 81f16863014de60b53de401d71ff904d163ee030..7bc9b7a5e800f79df62947cb7d566fd2fbaf19fe 2020-08-27 13:56:31 -0700 to 2020-10-23 18:31:23 -0500 - A few small updates. (rust-lang/edition-guide#221) - Clarify the limitation of ? in main and tests (rust-lang/edition-guide#219) - Update deprecated GitHub Actions commands. (rust-lang/edition-guide#220)
2020-10-28Update booksEric Huss-0/+0
2020-10-28Fix typo "compiltest"Guillaume Gomez-1/+1
2020-10-27Fix unstable-book doc testsSantiago Pastorino-3/+4
2020-10-25Rollup merge of #78320 - phil-opp:patch-5, r=GuillaumeGomez,alexcrichtonYuki Okushi-1/+1
Link to cargo's `build-std` feature instead of `xargo` in custom target docs The `xargo` tool is in maintenance mode since 2018 and the `build-std` feature of cargo already works reasonably well for most use cases.
2020-10-24Link directly to `#build-std` anchorPhilipp Oppermann-1/+1
Co-authored-by: Jonas Schievink <jonasschievink@gmail.com>
2020-10-24Link to cargo's `build-std` feature instead of `xargo` in custom target docsPhilipp Oppermann-1/+1
The `xargo` tool is in maintenance mode since 2018 and the `build-std` feature of cargo already works reasonably well for most use cases.
2020-10-24Rollup merge of #78250 - camelid:document-inline-const, r=spastorinoJonas Schievink-0/+45
Document inline-const Part of #76001. r? @spastorino
2020-10-22Document inline-const in the Unstable BookCamelid-0/+45
2020-10-21Clean up and improve some docsCamelid-13/+15
* compiler docs * Don't format list as part of a code block * Clean up some other formatting * rustdoc book * Update CommonMark spec version to latest (0.28 -> 0.29) * Clean up some various wording and formatting
2020-10-18Auto merge of #76885 - dylni:move-slice-check-range-to-range-bounds, r=KodrAusbors-10/+10
Move `slice::check_range` to `RangeBounds` Since this method doesn't take a slice anymore (#76662), it makes more sense to define it on `RangeBounds`. Questions: - Should the new method be `assert_len` or `assert_length`?
2020-10-15Update submodules for link fixesJoshua Nelson-0/+0
- [rust-embedded](https://github.com/rust-embedded/book/compare/79ab7776929c66db83203397958fa7037d5d9a30...ca8169e69b479f615855d0eece7e318138fcfc00) - [cargo](https://github.com/rust-lang/cargo/compare/12db56cdedbc2c26a9aa18f994c0188cdcc67df5...79b397d72c557eb6444a2ba0dc00a211a226a35a)
2020-10-15Deny broken intra-doc links in linkcheckerJoshua Nelson-0/+2
Since rustdoc isn't warning about these links, check for them manually.
2020-10-15Rollup merge of #77951 - ehuss:update-books, r=ehussYuki Okushi-0/+0
Update books ## reference 5 commits in 56a13c082ee90736c08d6abdcd90462517b703d3..1b78182e71709169dc0f1c3acdc4541b6860e1c4 2020-09-14 23:20:16 -0700 to 2020-10-11 13:53:47 -0700 - Specify that SSE4.1 includes SSSE3 instead of SSE3 (rust-lang-nursery/reference#892) - Fix mutable expressions that can be dereferenced (rust-lang-nursery/reference#890) - Fix grammar in memory model (rust-lang-nursery/reference#889) - Add style checks. (rust-lang-nursery/reference#886) - Add description for LUB Coercion (rust-lang-nursery/reference#808) ## book 1 commits in cb28dee95e5e50b793e6ba9291c5d1568d3ad72e..451a1e30f2dd137aa04e142414eafb8d05f87f84 2020-09-09 10:06:00 -0500 to 2020-10-05 09:11:18 -0500 - clarify description of when ? can be used (rust-lang/book#2471) ## rust-by-example 1 commits in 7d3ff1c12db08a847a57a054be4a7951ce532d2d..152475937a8d8a1f508d8eeb57db79139bc803d9 2020-09-28 15:54:25 -0300 to 2020-10-09 09:29:50 -0300 - Add 1.45.0 cast documentation (rust-lang/rust-by-example#1384) ## embedded-book 2 commits in dd310616308e01f6cf227f46347b744aa56b77d9..79ab7776929c66db83203397958fa7037d5d9a30 2020-09-26 08:54:08 +0000 to 2020-10-12 08:00:05 +0000 - llvm-objdump: Use two hyphens in flags to objdump (rust-embedded/book#270) - Start/hardware: clarify which file needs tweaking (rust-embedded/book#266)
2020-10-14Add support for SHA256 source file hashing for LLVM 11+.Arlo Siemsen-1/+1
2020-10-14Update booksEric Huss-0/+0
2020-10-14Update codegen-backend.mdXAMPPRocky-0/+3
2020-10-14Update codegen-backend.mdXAMPPRocky-2/+2
2020-10-14Update src/doc/unstable-book/src/compiler-flags/codegen-backend.mdXAMPPRocky-1/+1
2020-10-14Document -Z codegen-backend in the unstable bookErin Power-0/+28
2020-10-14Rollup merge of #77239 - shepmaster:silicon-ci-plus, r=pietroalbiniYuki Okushi-1/+1
Enable building Cargo for aarch64-apple-darwin r? @ghost
2020-10-13aarch64-apple-darwin now includes CargoJake Goulding-1/+1
2020-10-13Auto merge of #76830 - Artoria2e5:tune, r=nagisabors-2/+18
Pass tune-cpu to LLVM I think this is how it should work... See https://internals.rust-lang.org/t/expose-tune-cpu-from-llvm/13088 for the background. Or the documentation diff.
2020-10-12Auto merge of #75914 - arlosi:aarch64-ci, r=pietroalbinibors-1/+1
Promote aarch64-pc-windows-msvc to Tier 2 Development Platform Adds a GitHub Actions CI build for `aarch64-pc-windows-msvc` via cross-compilation on an x86_64 host. This promotes `aarch64-pc-windows-msvc` from a Tier 2 Compilation Target (std) to a Tier 2 Development Platform (std+rustc+cargo+tools). Fixes #72881 r? `@pietroalbini`
2020-10-11Auto merge of #75991 - shepmaster:silicon-ci, r=pietroalbinibors-3/+3
Set up CI for aarch64-apple-darwin
2020-10-10Auto merge of #76934 - camelid:rustdoc-allow-generic-params, r=jyn514bors-13/+42
Allow generic parameters in intra-doc links Fixes #62834. --- The contents of the generics will be mostly ignored (except for warning if fully-qualified syntax is used, which is currently unsupported in intra-doc links - see issue #74563). * Allow links like `Vec<T>`, `Result<T, E>`, and `Option<Box<T>>` * Allow links like `Vec::<T>::new()` * Warn on * Unbalanced angle brackets (e.g. `Vec<T` or `Vec<T>>`) * Missing type to apply generics to (`<T>` or `<Box<T>>`) * Use of fully-qualified syntax (`<Vec as IntoIterator>::into_iter`) * Invalid path separator (`Vec:<T>:new`) * Too many angle brackets (`Vec<<T>>`) * Empty angle brackets (`Vec<>`) Note that this implementation *does* allow some constructs that aren't valid in the actual Rust syntax, for example `Box::<T>new()`. That may not be supported in rustdoc in the future; it is an implementation detail.
2020-10-10Auto merge of #77337 - lzutao:asm-mips64, r=Amanieubors-14/+13
Add asm! support for mips64 - [x] Updated `src/doc/unstable-book/src/library-features/asm.md`. - [ ] No vector type support. I don't know much about those types. cc #76839
2020-10-09Link to GitHub issue re macro resolutionCamelid-1/+3
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-08Update rustdoc intra-doc link docsCamelid-13/+40
* Describe generic parameters feature * Make general improvements to the docs
2020-10-07Auto merge of #77119 - GuillaumeGomez:unclosed-html-tag-lint, r=jyn514bors-0/+35
Unclosed html tag lint Part of #67799. I think `@ollie27` will be interested (`@Manishearth` too since they opened the issue ;) ). r? `@jyn514`
2020-10-06Rollup merge of #76855 - jyn514:platform-specific, r=ollie27Yuki Okushi-21/+50
Revamp rustdoc docs about documentation using `cfg` - Move `cfg(doc)` out of `unstable-features`. It's not unstable. - Remove outdated reference to `everybody_loops`. - Improve wording in various places - Give an example of code this allows (and does not allow) - Link to `cfg(doc)` in `doc(cfg)` documentation. Since one is stable and the other is not, don't combine them. - Cleanup wording for `doc(cfg)` - Incorporate changes from #76849 - Mention that `doc(cfg)` is also for features Addresses https://github.com/rust-lang/rust/pull/76849#issuecomment-694516199. Obsoletes https://github.com/rust-lang/rust/pull/76849 (I made sure to fix the weird dashes too). r? @steveklabnik
generated by cgit-pink 1.4.1-3-g733a5 (git 2.37.1) at 2026-02-28 00:32:59 +0000