Skip to content

Commit

Permalink
display rustc_private APIs as "Internal"
Browse files Browse the repository at this point in the history
  • Loading branch information
euclio committed Dec 20, 2018
1 parent 5f34316 commit 8d393bf
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 8 deletions.
38 changes: 31 additions & 7 deletions src/librustdoc/html/render.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2703,13 +2703,16 @@ fn stability_tags(item: &clean::Item) -> String {
tags.push_str("[<div class='stab deprecated'>Deprecated</div>] ");
}

if item
if let Some(stab) = item
.stability
.as_ref()
.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 {
Expand Down Expand Up @@ -2752,9 +2755,14 @@ fn short_stability(item: &clean::Item, cx: &Context) -> Vec<String> {
.as_ref()
.filter(|stab| stab.level == stability::Unstable)
{
let mut message = String::from(
"<span class=microscope>🔬</span> This is a nightly-only experimental API.",
);
let is_rustc_private = stab.feature.as_ref().map(|s| &**s) == Some("rustc_private");

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() {
let mut feature = format!("<code>{}</code>", Escape(&feature));
Expand All @@ -2770,6 +2778,17 @@ fn short_stability(item: &clean::Item, cx: &Context) -> Vec<String> {
}

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();
message = format!(
"<details><summary>{}</summary>{}</details>",
Expand All @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/html/static/rustdoc.css
Original file line number Diff line number Diff line change
Expand Up @@ -765,7 +765,7 @@ body.blur > :not(#help) {
display: list-item;
}

.stab .microscope {
.stab .emoji {
font-size: 1.5em;
}

Expand Down
5 changes: 5 additions & 0 deletions src/librustdoc/html/static/themes/dark.css
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,10 @@ a {
color: #D2991D;
}

.stab.internal a {
color: #304FFE;
}

a.test-arrow {
color: #dedede;
}
Expand All @@ -199,6 +203,7 @@ a.test-arrow {
}

.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.portability { background: #C4ECFF; border-color: #7BA5DB; color: #404040; }

Expand Down
5 changes: 5 additions & 0 deletions src/librustdoc/html/static/themes/light.css
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,10 @@ a {
color: #3873AD;
}

.stab.internal a {
color: #304FFE;
}

a.test-arrow {
color: #f5f5f5;
}
Expand All @@ -200,6 +204,7 @@ a.test-arrow {
}

.stab.unstable { background: #FFF5D6; border-color: #FFC600; }
.stab.internal { background: #FFB9B3; border-color: #B71C1C; }
.stab.deprecated { background: #F3DFFF; border-color: #7F0087; }
.stab.portability { background: #C4ECFF; border-color: #7BA5DB; }

Expand Down
10 changes: 10 additions & 0 deletions src/test/rustdoc/internal.rs
Original file line number Diff line number Diff line change
@@ -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() {}

0 comments on commit 8d393bf

Please sign in to comment.