rust/tests/rustdoc/intra-doc/prim-precedence.rs

#![deny(rustdoc::broken_intra_doc_links)]

pub mod char {
    /// [char]
    // @has prim_precedence/char/struct.Inner.html '//a/@href' '{{channel}}/std/primitive.char.html'
    pub struct Inner;
}

/// See [prim@char]
// @has prim_precedence/struct.MyString.html '//a/@href' '{{channel}}/std/primitive.char.html'
pub struct MyString;

/// See also [crate::char] and [mod@char]
// @has prim_precedence/struct.MyString2.html '//*[@href="char/index.html"]' 'crate::char'
// @has - '//*[@href="char/index.html"]' 'mod@char'
pub struct MyString2;
Fix warnings in rustdoc HTML tests Now that compiletest denies warnings in these tests, they need fixing! 2021-11-26 15:03:16 -08:00			`#![deny(rustdoc::broken_intra_doc_links)]`
Move `src/test/rustdoc` intra-doc link tests into a subdirectory They were starting to get unwieldy. 2020-11-28 20:25:41 -05:00
			`pub mod char {`
			`/// [char]`
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-04 23:36:33 -04:00			`// @has prim_precedence/char/struct.Inner.html '//a/@href' '{{channel}}/std/primitive.char.html'`
Move `src/test/rustdoc` intra-doc link tests into a subdirectory They were starting to get unwieldy. 2020-11-28 20:25:41 -05:00			`pub struct Inner;`
			`}`

			`/// See [prim@char]`
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-04 23:36:33 -04:00			`// @has prim_precedence/struct.MyString.html '//a/@href' '{{channel}}/std/primitive.char.html'`
Move `src/test/rustdoc` intra-doc link tests into a subdirectory They were starting to get unwieldy. 2020-11-28 20:25:41 -05:00			`pub struct MyString;`

			`/// See also [crate::char] and [mod@char]`
rustdoc: use more precise relative URLS Instead of using a depth counter and adding "../" to get to the top, this commit makes rustdoc actually compare the path of what it's linking from to the path that it's linking to. This makes the resulting HTML shorter. Here's a comparison of one of the largest (non-source) files in the Rust standard library docs (about 4% improvement before gzipping). $ wc -c struct.Wrapping.old.html struct.Wrapping.new.html 2387389 struct.Wrapping.old.html 2298538 struct.Wrapping.new.html Most if it can be efficiently gzipped away. $ wc -c struct.Wrapping.old.html.gz struct.Wrapping.new.html.gz 70679 struct.Wrapping.old.html.gz 70050 struct.Wrapping.new.html.gz But it also makes a difference in the final DOM size, reducing it from 91MiB to 82MiB. 2021-03-17 11:41:01 -07:00			`// @has prim_precedence/struct.MyString2.html '//*[@href="char/index.html"]' 'crate::char'`
			`// @has - '//*[@href="char/index.html"]' 'mod@char'`
Move `src/test/rustdoc` intra-doc link tests into a subdirectory They were starting to get unwieldy. 2020-11-28 20:25:41 -05:00			`pub struct MyString2;`