rust/tests/rustdoc-ui/check.rs

// check-pass
// compile-flags: -Z unstable-options --check
// normalize-stderr-test: "nightly|beta|1\.[0-9][0-9]\.[0-9]" -> "$$CHANNEL"

#![feature(rustdoc_missing_doc_code_examples)]
//~^ WARN
//~^^ WARN

#![warn(missing_docs)]
#![warn(rustdoc::missing_doc_code_examples)]
#![warn(rustdoc::all)]

pub fn foo() {}
//~^ WARN
//~^^ WARN
Add tests for rustdoc --check option 2020-11-12 13:58:07 +00:00			`// check-pass`
			`// compile-flags: -Z unstable-options --check`
rustdoc: link to stable/beta docs consistently in documentation ## User-facing changes - Intra-doc links to primitives that currently go to rust-lang.org/nightly/std/primitive.x.html will start going to channel that rustdoc was built with. Nightly will continue going to /nightly; Beta will link to /beta; stable compilers will link to /1.52.1 (or whatever version they were built as). - Cross-crate links from std to core currently go to /nightly unconditionally. They will start going to /1.52.0 on stable channels (but remain the same on nightly channels). - Intra-crate links from std to std (or core to core) currently go to the same URL they are hosted at; they will continue to do so. Notably, this is different from everything else because it can preserve the distinction between /stable and /1.52.0 by using relative links. Note that "links" includes both intra-doc links and rustdoc's own automatically generated hyperlinks. ## Implementation changes - Update the testsuite to allow linking to /beta and /1.52.1 in docs - Use an html_root_url for the standard library that's dependent on the channel This avoids linking to nightly docs on stable. - Update rustdoc to use channel-dependent links for primitives from an unknown crate - Set DOC_RUST_LANG_ORG_CHANNEL from bootstrap to ensure it's in sync - Include doc.rust-lang.org in the channel 2021-05-05 03:36:33 +00:00			`// normalize-stderr-test: "nightly\|beta\|1\.[0-9][0-9]\.[0-9]" -> "$$CHANNEL"`
Add tests for rustdoc --check option 2020-11-12 13:58:07 +00:00
Feature gate the rustdoc::missing_doc_code_examples lint 2022-09-12 18:10:35 +00:00			`#![feature(rustdoc_missing_doc_code_examples)]`
Add tests for rustdoc --check option 2020-11-12 13:58:07 +00:00			`//~^ WARN`
			`//~^^ WARN`
Feature gate the rustdoc::missing_doc_code_examples lint 2022-09-12 18:10:35 +00:00
			`#![warn(missing_docs)]`
Only include stable lints in `rustdoc::all` group Including unstable lints in the lint group produces unintuitive behavior on stable (see #106289). Meanwhile, if we only included unstable lints on nightly and not on stable, we could end up with confusing bugs that were hard to compare across versions of Rust that lacked code changes. I think that only including stable lints in `rustdoc::all`, no matter the release channel, is the most intuitive option. Users can then control unstable lints individually, which is reasonable since they have to enable the feature gates individually anyway. 2022-12-31 01:09:19 +00:00			`#![warn(rustdoc::missing_doc_code_examples)]`
Rename `rustdoc` to `rustdoc::all` When rustdoc lints were changed to be tool lints, the `rustdoc` group was removed, leading to spurious warnings like ``` warning: unknown lint: `rustdoc` ``` The lint group still worked when rustdoc ran, since rustdoc added the group itself. This renames the group to `rustdoc::all` for consistency with `clippy::all` and the rest of the rustdoc lints. 2021-03-05 14:50:20 +00:00			`#![warn(rustdoc::all)]`
Add tests for rustdoc --check option 2020-11-12 13:58:07 +00:00
			`pub fn foo() {}`
			`//~^ WARN`
			`//~^^ WARN`