display rustc_private APIs as "Internal"

This commit is contained in:
Andy Russell 2018-12-12 22:51:04 -05:00
parent 5f3431691d
commit 8d393bf797
No known key found for this signature in database
GPG key ID: BE2221033EDBC374
5 changed files with 52 additions and 8 deletions

View file

@ -2703,13 +2703,16 @@ fn stability_tags(item: &clean::Item) -> String {
tags.push_str("[<div class='stab deprecated'>Deprecated</div>] "); tags.push_str("[<div class='stab deprecated'>Deprecated</div>] ");
} }
if item if let Some(stab) = item
.stability .stability
.as_ref() .as_ref()
.filter(|s| s.level == stability::Unstable) .filter(|s| s.level == stability::Unstable)
.is_some()
{ {
tags.push_str("[<div class='stab unstable'>Experimental</div>] "); if stab.feature.as_ref().map(|s| &**s) == Some("rustc_private") {
tags.push_str("[<div class='stab internal'>Internal</div>] ");
} else {
tags.push_str("[<div class='stab unstable'>Experimental</div>] ");
}
} }
if let Some(ref cfg) = item.attrs.cfg { if let Some(ref cfg) = item.attrs.cfg {
@ -2752,9 +2755,14 @@ fn short_stability(item: &clean::Item, cx: &Context) -> Vec<String> {
.as_ref() .as_ref()
.filter(|stab| stab.level == stability::Unstable) .filter(|stab| stab.level == stability::Unstable)
{ {
let mut message = String::from( let is_rustc_private = stab.feature.as_ref().map(|s| &**s) == Some("rustc_private");
"<span class=microscope>🔬</span> This is a nightly-only experimental API.",
); let mut message = if is_rustc_private {
"<span class='emoji'>⚙️</span> This is an internal compiler API."
} else {
"<span class='emoji'>🔬</span> This is a nightly-only experimental API."
}
.to_owned();
if let Some(feature) = stab.feature.as_ref() { if let Some(feature) = stab.feature.as_ref() {
let mut feature = format!("<code>{}</code>", Escape(&feature)); let mut feature = format!("<code>{}</code>", Escape(&feature));
@ -2770,6 +2778,17 @@ fn short_stability(item: &clean::Item, cx: &Context) -> Vec<String> {
} }
if let Some(unstable_reason) = &stab.unstable_reason { if let Some(unstable_reason) = &stab.unstable_reason {
// Provide a more informative message than the compiler help.
let unstable_reason = if is_rustc_private {
"This crate is being loaded from the sysroot, a permanently unstable location \
for private compiler dependencies. It is not intended for general use. Prefer \
using a public version of this crate from \
[crates.io](https://crates.io) via [`Cargo.toml`]\
(https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html)."
} else {
unstable_reason
};
let mut ids = cx.id_map.borrow_mut(); let mut ids = cx.id_map.borrow_mut();
message = format!( message = format!(
"<details><summary>{}</summary>{}</details>", "<details><summary>{}</summary>{}</details>",
@ -2778,7 +2797,12 @@ fn short_stability(item: &clean::Item, cx: &Context) -> Vec<String> {
); );
} }
stability.push(format!("<div class='stab unstable'>{}</div>", message)) let class = if is_rustc_private {
"internal"
} else {
"unstable"
};
stability.push(format!("<div class='stab {}'>{}</div>", class, message));
} }
if let Some(ref cfg) = item.attrs.cfg { if let Some(ref cfg) = item.attrs.cfg {

View file

@ -765,7 +765,7 @@ body.blur > :not(#help) {
display: list-item; display: list-item;
} }
.stab .microscope { .stab .emoji {
font-size: 1.5em; font-size: 1.5em;
} }

View file

@ -174,6 +174,10 @@ a {
color: #D2991D; color: #D2991D;
} }
.stab.internal a {
color: #304FFE;
}
a.test-arrow { a.test-arrow {
color: #dedede; color: #dedede;
} }
@ -199,6 +203,7 @@ a.test-arrow {
} }
.stab.unstable { background: #FFF5D6; border-color: #FFC600; color: #404040; } .stab.unstable { background: #FFF5D6; border-color: #FFC600; color: #404040; }
.stab.internal { background: #FFB9B3; border-color: #B71C1C; color: #404040; }
.stab.deprecated { background: #F3DFFF; border-color: #7F0087; color: #404040; } .stab.deprecated { background: #F3DFFF; border-color: #7F0087; color: #404040; }
.stab.portability { background: #C4ECFF; border-color: #7BA5DB; color: #404040; } .stab.portability { background: #C4ECFF; border-color: #7BA5DB; color: #404040; }

View file

@ -174,6 +174,10 @@ a {
color: #3873AD; color: #3873AD;
} }
.stab.internal a {
color: #304FFE;
}
a.test-arrow { a.test-arrow {
color: #f5f5f5; color: #f5f5f5;
} }
@ -200,6 +204,7 @@ a.test-arrow {
} }
.stab.unstable { background: #FFF5D6; border-color: #FFC600; } .stab.unstable { background: #FFF5D6; border-color: #FFC600; }
.stab.internal { background: #FFB9B3; border-color: #B71C1C; }
.stab.deprecated { background: #F3DFFF; border-color: #7F0087; } .stab.deprecated { background: #F3DFFF; border-color: #7F0087; }
.stab.portability { background: #C4ECFF; border-color: #7BA5DB; } .stab.portability { background: #C4ECFF; border-color: #7BA5DB; }

View file

@ -0,0 +1,10 @@
// compile-flags: -Z force-unstable-if-unmarked
// @matches internal/index.html '//*[@class="docblock-short"]' \
// '^\[Internal\] Docs'
// @has internal/struct.S.html '//*[@class="stab internal"]' \
// 'This is an internal compiler API. (rustc_private)'
/// Docs
pub struct S;
fn main() {}