Commit graph

5460 commits

Author SHA1 Message Date
Manish Goregaokar
51c1351f7b Resolve some conflicts 2020-09-13 18:14:34 -07:00
Manish Goregaokar
175e30539d Update src/doc/rustdoc/src/linking-to-items-by-name.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-13 18:12:52 -07:00
Manish Goregaokar
4e0eb0b73b Update src/doc/rustdoc/src/linking-to-items-by-name.md
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-13 18:12:52 -07:00
Manish Goregaokar
2a98409634 Fill out docs on intra-doc resolution failure lint 2020-09-13 18:12:52 -07:00
Manish Goregaokar
f072e4a732 Mention URL fragments 2020-09-13 18:12:52 -07:00
Manish Goregaokar
bc06674774 Mention super/crate/self in docs 2020-09-13 18:12:51 -07:00
Manish Goregaokar
63d5beec43 Move intra-doc-links documentation out of unstable section 2020-09-13 18:12:49 -07:00
Tyler Mandry
f9df658aad
Rollup merge of #76555 - alilleybrinker:reword_trivial_casts_lint_doc, 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-10 12:20:06 -07:00
Tyler Mandry
91c3ef8bef
Rollup merge of #76289 - arijit79:master, r=jyn514
Add docs about crate level documentation support

Wrote information about how to write documentation on the crate level in rhe rustdoc book
2020-09-10 12:19:59 -07:00
arijit79
fd5859a673 Add docs about crate level documentation support 2020-09-10 10:29:24 -04:00
Andrew Lilley Brinker
01bf35010f Reword trivial_casts lint to better explain.
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-09 19:36:15 -07:00
Tyler Mandry
df84ac74bd
Rollup merge of #76465 - jyn514:auto-versioning, r=elichai
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-09 15:05:53 -07:00
Tyler Mandry
d0c2a2d37c
Rollup merge of #76430 - pickfire:patch-7, r=steveklabnik
Add align to rustc-attrs unstable book
2020-09-09 15:05:51 -07:00
Dylan DPC
1aef86c858
Rollup merge of #76402 - elichai:patch-2, r=wesleywiser
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: 49cae55760
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: 5c1f21c3b8
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: 04488afe34
commit-date: 2020-08-24
host: x86_64-unknown-linux-gnu
release: 1.46.0
LLVM version: 10.0
```
2020-09-09 01:35:22 +02:00
Joshua Nelson
0c9bf13f5f Add a script to automatically update Rust/Clang versions 2020-09-07 22:06:23 -04:00
Ivan Tham
3a3a08585f
Unstable book rust-attrs does not work on generics
Co-authored-by: Peter Todd <pete@petertodd.org>
2020-09-08 09:08:25 +08:00
Ivan Tham
3740b0064d
Add align to rustc-attrs unstable book 2020-09-07 15:10:31 +08:00
Elichai Turkel
2e82589741
linker-plugin-lto.md: Convert the rust-clang MxN table to a 2xM table 2020-09-06 14:55:27 +03:00
Elichai Turkel
9e1403373d
Update linker-plugin-lto.md to contain up to rust 1.46 2020-09-06 11:20:53 +03:00
dylni
cf529c767e Adjust documentation for slice_check_range 2020-09-05 19:53:35 -04:00
Dylan DPC
c3a09fba84
Rollup merge of #75954 - ArekPiekarz:unstable_book_ffi_tracking_issues, r=steveklabnik
Unstable Book: add links to tracking issues for FFI features
2020-09-05 16:28:20 +02:00
Eric Huss
c012487bde Update books 2020-09-02 11:10:36 -07:00
Tyler Mandry
c22de44a80
Rollup merge of #76212 - JesHansen:fix-lint-doc, r=jyn514
Document lint missing_doc_code_examples is nightly-only

Closes #76194
2020-09-01 18:24:44 -07:00
Jes Bak Hansen
7eb4b1b4b9 Document lint missing_doc_code_examples is nightly-only 2020-09-01 20:45:21 +02:00
Mateusz Mikuła
23f0ccfe5d Stabilise link-self-contained option 2020-08-31 15:13:31 +02:00
bors
360eb349ae Auto merge of #75919 - rust-lang:jonas-schievink-patch-1, r=ehuss
Fix typo (`thumbv8m.main-none-eabihf` is Mainline)
2020-08-30 06:32:12 +00:00
Dylan DPC
fe43918c38
Rollup merge of #75892 - ArekPiekarz:unstable_book_tls_model_typo, r=petrochenkov
Fix typo in TLS Model in Unstable Book
2020-08-30 01:43:46 +02:00
bors
3d0c847d33 Auto merge of #74941 - dylanmckay:replace-broken-avr-unknown-unknown-target, 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-27 15:48:56 +00:00
Arkadiusz Piekarz
aa40c028fc Unstable Book: add links to tracking issues for FFI features 2020-08-26 22:03:29 +02:00
Jonas Schievink
d9b075a756
Fix typo (thumbv8m.main-none-eabihf is Mainline) 2020-08-25 22:55:04 +02:00
Arkadiusz Piekarz
1831f65288 Fix typo in TLS Model in Unstable Book 2020-08-24 23:02:44 +02:00
Dylan McKay
c9ead8c895 [AVR] Replace 'avr-unknown-unknown' with 'avr-unknown-gnu-atmega328' in platform-support.md 2020-08-24 20:44:10 +12:00
Joshua Nelson
73de34319e Document prim@ and primitive@ 2020-08-23 22:40:20 -04:00
Dylan DPC
cc1e5c0509
Rollup merge of #75753 - koutheir:patch-1, r=steveklabnik
Another motivation for CFG: return-oriented programming
2020-08-22 02:14:49 +02:00
Dr. Koutheir Attouchi
8ae3384bf7
Added link to Microsoft's documentation of CFG 2020-08-21 14:52:30 -04:00
Dr. Koutheir Attouchi
ec9657aec6
Fixed a typo 2020-08-21 14:47:18 -04:00
Guillaume Gomez
10a880d20e Improve wording 2020-08-21 09:49:26 +02:00
Dr. Koutheir Attouchi
5673b0e492
Switched ROP link to Desktop layout instead of mobile layout 2020-08-21 03:34:25 -04:00
Dr. Koutheir Attouchi
6fca004ba9
Another motivation for CFG: return-oriented programming 2020-08-20 18:54:40 -04:00
Guillaume Gomez
d108bd5386 Add documentation for --show-coverage option 2020-08-20 21:26:57 +02:00
Eric Huss
4890186957 Update books 2020-08-19 14:07:46 -07:00
Aleksey Kladov
5ba961018c Remove missing_fragment_specifier lint 2020-08-18 09:06:45 +02:00
Sasha
bdbb995df3 Mark x86_64-linux-kernel as * 2020-08-17 12:57:42 +02:00
Eric Huss
9976a60077 Move CloudABI to tier 3. 2020-08-14 20:43:27 -07:00
bors
d69b0997d7 Auto merge of #75431 - ehuss:platform-support, r=Mark-Simulacrum
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-13 06:17:25 +00:00
Eric Huss
ce717476ff Add a script to verify the Platform Support page is up-to-date. 2020-08-12 08:40:22 -07:00
Eric Huss
392116e021 Platform Support page updates.
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-11 16:05:43 -07:00
Eric Huss
1902983f45 Move forge platform-support to the rustc book. 2020-08-11 16:02:00 -07:00
Amanieu d'Antras
b5cef24f5f Update asm! documentation in unstable book
- Update the list of supported architectures.
- Clarify issues with LLVM's use of reserved registers.
2020-08-06 23:22:07 +01:00
Eric Huss
583133308b Update books 2020-08-04 16:45:19 -07:00