From 440c0f07c3112d14dd3b359af873155a28865592 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Wernst=C3=A5l?= Date: Sun, 16 Aug 2015 15:53:18 +0200 Subject: [PATCH 1/9] rustdoc: Added issue tracker option and issue data to clean::Stability --- src/librustdoc/clean/mod.rs | 5 ++++- src/librustdoc/html/render.rs | 11 ++++++++++- src/librustdoc/lib.rs | 5 ++++- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/src/librustdoc/clean/mod.rs b/src/librustdoc/clean/mod.rs index 04b1f8ee1b1d3..05be445820d10 100644 --- a/src/librustdoc/clean/mod.rs +++ b/src/librustdoc/clean/mod.rs @@ -2688,7 +2688,8 @@ pub struct Stability { pub feature: String, pub since: String, pub deprecated_since: String, - pub reason: String + pub reason: String, + pub issue: Option } impl Clean for attr::Stability { @@ -2702,6 +2703,7 @@ impl Clean for attr::Stability { |istr| istr.to_string()), reason: self.reason.as_ref().map_or("".to_string(), |interned| interned.to_string()), + issue: self.issue, } } } @@ -2717,6 +2719,7 @@ impl<'a> Clean for &'a attr::Stability { |istr| istr.to_string()), reason: self.reason.as_ref().map_or("".to_string(), |interned| interned.to_string()), + issue: self.issue, } } } diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs index 83e77a5c03865..53869e042a812 100644 --- a/src/librustdoc/html/render.rs +++ b/src/librustdoc/html/render.rs @@ -103,6 +103,9 @@ pub struct Context { pub render_redirect_pages: bool, /// All the passes that were run on this crate. pub passes: HashSet, + /// The base-URL of the issue tracker for when an item has been tagged with + /// an issue number. + pub issue_tracker_base_url: Option, } /// Indicates where an external crate can be found. @@ -303,7 +306,8 @@ thread_local!(pub static CURRENT_LOCATION_KEY: RefCell> = pub fn run(mut krate: clean::Crate, external_html: &ExternalHtml, dst: PathBuf, - passes: HashSet) -> io::Result<()> { + passes: HashSet, + issue_tracker_base_url: Option) -> io::Result<()> { let src_root = match krate.src.parent() { Some(p) => p.to_path_buf(), None => PathBuf::new(), @@ -323,6 +327,7 @@ pub fn run(mut krate: clean::Crate, }, include_sources: true, render_redirect_pages: false, + issue_tracker_base_url: issue_tracker_base_url, }; try!(mkdir(&cx.dst)); @@ -352,6 +357,10 @@ pub fn run(mut krate: clean::Crate, } }); } + clean::NameValue(ref x, ref s) + if "issue_tracker_base_url" == *x => { + cx.issue_tracker_base_url = Some(s.to_string()); + } clean::Word(ref x) if "html_no_source" == *x => { cx.include_sources = false; diff --git a/src/librustdoc/lib.rs b/src/librustdoc/lib.rs index 33902363e0a25..73b7de45c4a2c 100644 --- a/src/librustdoc/lib.rs +++ b/src/librustdoc/lib.rs @@ -178,6 +178,8 @@ pub fn opts() -> Vec { "FILES"), optopt("", "markdown-playground-url", "URL to send code snippets to", "URL"), + optopt("", "issue-tracker-base-url", + "base URL for issue tracker", "URL"), optflag("", "markdown-no-toc", "don't include table of contents") ) } @@ -284,7 +286,8 @@ pub fn main_args(args: &[String]) -> isize { Some("html") | None => { match html::render::run(krate, &external_html, output.unwrap_or(PathBuf::from("doc")), - passes.into_iter().collect()) { + passes.into_iter().collect(), + matches.opt_str("issue-tracker-base-url")) { Ok(()) => {} Err(e) => panic!("failed to generate documentation: {}", e), } From b31038764dbc060b8fcccdee89e5e43072428458 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Wernst=C3=A5l?= Date: Sun, 16 Aug 2015 17:05:18 +0200 Subject: [PATCH 2/9] rustdoc: Pass the Context down to short_stability() --- src/librustdoc/html/render.rs | 114 +++++++++++++++++----------------- 1 file changed, 58 insertions(+), 56 deletions(-) diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs index 53869e042a812..dceb052e7960a 100644 --- a/src/librustdoc/html/render.rs +++ b/src/librustdoc/html/render.rs @@ -1494,16 +1494,16 @@ impl<'a> fmt::Display for Item<'a> { item_module(fmt, self.cx, self.item, &m.items) } clean::FunctionItem(ref f) | clean::ForeignFunctionItem(ref f) => - item_function(fmt, self.item, f), + item_function(fmt, self.cx, self.item, f), clean::TraitItem(ref t) => item_trait(fmt, self.cx, self.item, t), - clean::StructItem(ref s) => item_struct(fmt, self.item, s), - clean::EnumItem(ref e) => item_enum(fmt, self.item, e), - clean::TypedefItem(ref t, _) => item_typedef(fmt, self.item, t), - clean::MacroItem(ref m) => item_macro(fmt, self.item, m), - clean::PrimitiveItem(ref p) => item_primitive(fmt, self.item, p), + clean::StructItem(ref s) => item_struct(fmt, self.cx, self.item, s), + clean::EnumItem(ref e) => item_enum(fmt, self.cx, self.item, e), + clean::TypedefItem(ref t, _) => item_typedef(fmt, self.cx, self.item, t), + clean::MacroItem(ref m) => item_macro(fmt, self.cx, self.item, m), + clean::PrimitiveItem(ref p) => item_primitive(fmt, self.cx, self.item, p), clean::StaticItem(ref i) | clean::ForeignStaticItem(ref i) => - item_static(fmt, self.item, i), - clean::ConstantItem(ref c) => item_constant(fmt, self.item, c), + item_static(fmt, self.cx, self.item, i), + clean::ConstantItem(ref c) => item_constant(fmt, self.cx, self.item, c), _ => Ok(()) } } @@ -1546,8 +1546,8 @@ fn plain_summary_line(s: Option<&str>) -> String { markdown::plain_summary_line(&line[..]) } -fn document(w: &mut fmt::Formatter, item: &clean::Item) -> fmt::Result { - if let Some(s) = short_stability(item, true) { +fn document(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item) -> fmt::Result { + if let Some(s) = short_stability(item, cx, true) { try!(write!(w, "
{}
", s)); } if let Some(s) = item.doc_value() { @@ -1558,7 +1558,7 @@ fn document(w: &mut fmt::Formatter, item: &clean::Item) -> fmt::Result { fn item_module(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item, items: &[clean::Item]) -> fmt::Result { - try!(document(w, item)); + try!(document(w, cx, item)); let mut indices = (0..items.len()).filter(|i| { !cx.ignore_private_item(&items[*i]) @@ -1666,7 +1666,7 @@ fn item_module(w: &mut fmt::Formatter, cx: &Context, _ => { if myitem.name.is_none() { continue } - let stab_docs = if let Some(s) = short_stability(myitem, false) { + let stab_docs = if let Some(s) = short_stability(myitem, cx, false) { format!("[{}]", s) } else { String::new() @@ -1694,7 +1694,7 @@ fn item_module(w: &mut fmt::Formatter, cx: &Context, write!(w, "") } -fn short_stability(item: &clean::Item, show_reason: bool) -> Option { +fn short_stability(item: &clean::Item, cx: &Context, show_reason: bool) -> Option { item.stability.as_ref().and_then(|stab| { let reason = if show_reason && !stab.reason.is_empty() { format!(": {}", stab.reason) @@ -1729,7 +1729,7 @@ impl<'a> fmt::Display for Initializer<'a> { } } -fn item_constant(w: &mut fmt::Formatter, it: &clean::Item, +fn item_constant(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, c: &clean::Constant) -> fmt::Result { try!(write!(w, "
{vis}const \
                     {name}: {typ}{init}
", @@ -1737,10 +1737,10 @@ fn item_constant(w: &mut fmt::Formatter, it: &clean::Item, name = it.name.as_ref().unwrap(), typ = c.type_, init = Initializer(&c.expr))); - document(w, it) + document(w, cx, it) } -fn item_static(w: &mut fmt::Formatter, it: &clean::Item, +fn item_static(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, s: &clean::Static) -> fmt::Result { try!(write!(w, "
{vis}static {mutability}\
                     {name}: {typ}{init}
", @@ -1749,10 +1749,10 @@ fn item_static(w: &mut fmt::Formatter, it: &clean::Item, name = it.name.as_ref().unwrap(), typ = s.type_, init = Initializer(&s.expr))); - document(w, it) + document(w, cx, it) } -fn item_function(w: &mut fmt::Formatter, it: &clean::Item, +fn item_function(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, f: &clean::Function) -> fmt::Result { try!(write!(w, "
{vis}{unsafety}{abi}{constness}fn \
                     {name}{generics}{decl}{where_clause}
", @@ -1764,7 +1764,7 @@ fn item_function(w: &mut fmt::Formatter, it: &clean::Item, generics = f.generics, where_clause = WhereClause(&f.generics), decl = f.decl)); - document(w, it) + document(w, cx, it) } fn item_trait(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, @@ -1841,9 +1841,9 @@ fn item_trait(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, try!(write!(w, "")); // Trait documentation - try!(document(w, it)); + try!(document(w, cx, it)); - fn trait_item(w: &mut fmt::Formatter, m: &clean::Item) + fn trait_item(w: &mut fmt::Formatter, cx: &Context, m: &clean::Item) -> fmt::Result { try!(write!(w, "

", ty = shortty(m), @@ -1851,7 +1851,7 @@ fn item_trait(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, stab = m.stability_class())); try!(render_assoc_item(w, m, AssocItemLink::Anchor)); try!(write!(w, "

")); - try!(document(w, m)); + try!(document(w, cx, m)); Ok(()) } @@ -1861,7 +1861,7 @@ fn item_trait(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
")); for t in &types { - try!(trait_item(w, *t)); + try!(trait_item(w, cx, *t)); } try!(write!(w, "
")); } @@ -1872,7 +1872,7 @@ fn item_trait(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
")); for t in &consts { - try!(trait_item(w, *t)); + try!(trait_item(w, cx, *t)); } try!(write!(w, "
")); } @@ -1884,7 +1884,7 @@ fn item_trait(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
")); for m in &required { - try!(trait_item(w, *m)); + try!(trait_item(w, cx, *m)); } try!(write!(w, "
")); } @@ -1894,13 +1894,13 @@ fn item_trait(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
")); for m in &provided { - try!(trait_item(w, *m)); + try!(trait_item(w, cx, *m)); } try!(write!(w, "
")); } // If there are methods directly on this trait object, render them here. - try!(render_assoc_items(w, it.def_id, AssocItemRender::All)); + try!(render_assoc_items(w, cx, it.def_id, AssocItemRender::All)); let cache = cache(); try!(write!(w, " @@ -2012,7 +2012,7 @@ fn render_assoc_item(w: &mut fmt::Formatter, meth: &clean::Item, } } -fn item_struct(w: &mut fmt::Formatter, it: &clean::Item, +fn item_struct(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, s: &clean::Struct) -> fmt::Result { try!(write!(w, "
"));
     try!(render_attributes(w, it));
@@ -2025,7 +2025,7 @@ fn item_struct(w: &mut fmt::Formatter, it: &clean::Item,
                        true));
     try!(write!(w, "
")); - try!(document(w, it)); + try!(document(w, cx, it)); let mut fields = s.fields.iter().filter(|f| { match f.inner { clean::StructFieldItem(clean::HiddenStructField) => false, @@ -2042,16 +2042,16 @@ fn item_struct(w: &mut fmt::Formatter, it: &clean::Item, {name}", stab = field.stability_class(), name = field.name.as_ref().unwrap())); - try!(document(w, field)); + try!(document(w, cx, field)); try!(write!(w, "")); } try!(write!(w, "")); } } - render_assoc_items(w, it.def_id, AssocItemRender::All) + render_assoc_items(w, cx, it.def_id, AssocItemRender::All) } -fn item_enum(w: &mut fmt::Formatter, it: &clean::Item, +fn item_enum(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, e: &clean::Enum) -> fmt::Result { try!(write!(w, "
"));
     try!(render_attributes(w, it));
@@ -2104,13 +2104,13 @@ fn item_enum(w: &mut fmt::Formatter, it: &clean::Item,
     }
     try!(write!(w, "
")); - try!(document(w, it)); + try!(document(w, cx, it)); if !e.variants.is_empty() { try!(write!(w, "

Variants

\n")); for variant in &e.variants { try!(write!(w, "")); } try!(write!(w, "
{name}", name = variant.name.as_ref().unwrap())); - try!(document(w, variant)); + try!(document(w, cx, variant)); match variant.inner { clean::VariantItem(ref var) => { match var.kind { @@ -2132,7 +2132,7 @@ fn item_enum(w: &mut fmt::Formatter, it: &clean::Item, {f}", v = variant.name.as_ref().unwrap(), f = field.name.as_ref().unwrap())); - try!(document(w, field)); + try!(document(w, cx, field)); try!(write!(w, "
")); @@ -2147,7 +2147,7 @@ fn item_enum(w: &mut fmt::Formatter, it: &clean::Item, try!(write!(w, "")); } - try!(render_assoc_items(w, it.def_id, AssocItemRender::All)); + try!(render_assoc_items(w, cx, it.def_id, AssocItemRender::All)); Ok(()) } @@ -2242,6 +2242,7 @@ enum AssocItemRender<'a> { } fn render_assoc_items(w: &mut fmt::Formatter, + cx: &Context, it: ast::DefId, what: AssocItemRender) -> fmt::Result { let c = cache(); @@ -2265,7 +2266,7 @@ fn render_assoc_items(w: &mut fmt::Formatter, } }; for i in &non_trait { - try!(render_impl(w, i, AssocItemLink::Anchor, render_header)); + try!(render_impl(w, cx, i, AssocItemLink::Anchor, render_header)); } } if let AssocItemRender::DerefFor { .. } = what { @@ -2281,7 +2282,7 @@ fn render_assoc_items(w: &mut fmt::Formatter, } }); if let Some(impl_) = deref_impl { - try!(render_deref_methods(w, impl_)); + try!(render_deref_methods(w, cx, impl_)); } try!(write!(w, "

Trait \ Implementations

")); @@ -2290,7 +2291,7 @@ fn render_assoc_items(w: &mut fmt::Formatter, }); for i in &manual { let did = i.trait_did().unwrap(); - try!(render_impl(w, i, AssocItemLink::GotoSource(did), true)); + try!(render_impl(w, cx, i, AssocItemLink::GotoSource(did), true)); } if !derived.is_empty() { try!(write!(w, "

\ @@ -2298,14 +2299,14 @@ fn render_assoc_items(w: &mut fmt::Formatter,

")); for i in &derived { let did = i.trait_did().unwrap(); - try!(render_impl(w, i, AssocItemLink::GotoSource(did), true)); + try!(render_impl(w, cx, i, AssocItemLink::GotoSource(did), true)); } } } Ok(()) } -fn render_deref_methods(w: &mut fmt::Formatter, impl_: &Impl) -> fmt::Result { +fn render_deref_methods(w: &mut fmt::Formatter, cx: &Context, impl_: &Impl) -> fmt::Result { let deref_type = impl_.impl_.trait_.as_ref().unwrap(); let target = impl_.impl_.items.iter().filter_map(|item| { match item.inner { @@ -2315,12 +2316,12 @@ fn render_deref_methods(w: &mut fmt::Formatter, impl_: &Impl) -> fmt::Result { }).next().expect("Expected associated type binding"); let what = AssocItemRender::DerefFor { trait_: deref_type, type_: target }; match *target { - clean::ResolvedPath { did, .. } => render_assoc_items(w, did, what), + clean::ResolvedPath { did, .. } => render_assoc_items(w, cx, did, what), _ => { if let Some(prim) = target.primitive_type() { if let Some(c) = cache().primitive_locations.get(&prim) { let did = ast::DefId { krate: *c, node: prim.to_node_id() }; - try!(render_assoc_items(w, did, what)); + try!(render_assoc_items(w, cx, did, what)); } } Ok(()) @@ -2331,7 +2332,7 @@ fn render_deref_methods(w: &mut fmt::Formatter, impl_: &Impl) -> fmt::Result { // Render_header is false when we are rendering a `Deref` impl and true // otherwise. If render_header is false, we will avoid rendering static // methods, since they are not accessible for the type implementing `Deref` -fn render_impl(w: &mut fmt::Formatter, i: &Impl, link: AssocItemLink, +fn render_impl(w: &mut fmt::Formatter, cx: &Context, i: &Impl, link: AssocItemLink, render_header: bool) -> fmt::Result { if render_header { try!(write!(w, "

{}

", i.impl_)); @@ -2340,7 +2341,7 @@ fn render_impl(w: &mut fmt::Formatter, i: &Impl, link: AssocItemLink, } } - fn doctraititem(w: &mut fmt::Formatter, item: &clean::Item, + fn doctraititem(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item, link: AssocItemLink, render_static: bool) -> fmt::Result { match item.inner { clean::MethodItem(..) | clean::TyMethodItem(..) => { @@ -2390,7 +2391,7 @@ fn render_impl(w: &mut fmt::Formatter, i: &Impl, link: AssocItemLink, if is_static_method(item) && !render_static { Ok(()) } else { - document(w, item) + document(w, cx, item) } } else { Ok(()) @@ -2407,10 +2408,11 @@ fn render_impl(w: &mut fmt::Formatter, i: &Impl, link: AssocItemLink, try!(write!(w, "
")); for trait_item in &i.impl_.items { - try!(doctraititem(w, trait_item, link, render_header)); + try!(doctraititem(w, cx, trait_item, link, render_header)); } fn render_default_items(w: &mut fmt::Formatter, + cx: &Context, did: ast::DefId, t: &clean::Trait, i: &clean::Impl, @@ -2422,7 +2424,7 @@ fn render_impl(w: &mut fmt::Formatter, i: &Impl, link: AssocItemLink, None => {} } - try!(doctraititem(w, trait_item, AssocItemLink::GotoSource(did), render_static)); + try!(doctraititem(w, cx, trait_item, AssocItemLink::GotoSource(did), render_static)); } Ok(()) } @@ -2433,7 +2435,7 @@ fn render_impl(w: &mut fmt::Formatter, i: &Impl, link: AssocItemLink, // for them work. if let Some(clean::ResolvedPath { did, .. }) = i.impl_.trait_ { if let Some(t) = cache().traits.get(&did) { - try!(render_default_items(w, did, t, &i.impl_, render_header)); + try!(render_default_items(w, cx, did, t, &i.impl_, render_header)); } } @@ -2441,7 +2443,7 @@ fn render_impl(w: &mut fmt::Formatter, i: &Impl, link: AssocItemLink, Ok(()) } -fn item_typedef(w: &mut fmt::Formatter, it: &clean::Item, +fn item_typedef(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, t: &clean::Typedef) -> fmt::Result { try!(write!(w, "
type {}{}{where_clause} = {type_};
", it.name.as_ref().unwrap(), @@ -2449,7 +2451,7 @@ fn item_typedef(w: &mut fmt::Formatter, it: &clean::Item, where_clause = WhereClause(&t.generics), type_ = t.type_)); - document(w, it) + document(w, cx, it) } impl<'a> fmt::Display for Sidebar<'a> { @@ -2520,19 +2522,19 @@ impl<'a> fmt::Display for Source<'a> { } } -fn item_macro(w: &mut fmt::Formatter, it: &clean::Item, +fn item_macro(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, t: &clean::Macro) -> fmt::Result { try!(w.write_str(&highlight::highlight(&t.source, Some("macro"), None))); - document(w, it) + document(w, cx, it) } -fn item_primitive(w: &mut fmt::Formatter, +fn item_primitive(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, _p: &clean::PrimitiveType) -> fmt::Result { - try!(document(w, it)); - render_assoc_items(w, it.def_id, AssocItemRender::All) + try!(document(w, cx, it)); + render_assoc_items(w, cx, it.def_id, AssocItemRender::All) } fn get_basic_keywords() -> &'static str { From 9698e8fd17a3517bc5904ceb74e0bdbf7e332413 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Wernst=C3=A5l?= Date: Sun, 16 Aug 2015 17:20:37 +0200 Subject: [PATCH 3/9] rustdoc: Print feature flag and issue link if present in short_stability --- src/librustdoc/html/render.rs | 17 ++++++++++++++++- src/librustdoc/html/static/main.css | 6 +++--- 2 files changed, 19 insertions(+), 4 deletions(-) diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs index dceb052e7960a..c36fb95be42b2 100644 --- a/src/librustdoc/html/render.rs +++ b/src/librustdoc/html/render.rs @@ -1709,7 +1709,22 @@ fn short_stability(item: &clean::Item, cx: &Context, show_reason: bool) -> Optio }; format!("Deprecated{}{}", since, Markdown(&reason)) } else if stab.level == attr::Unstable { - format!("Unstable{}", Markdown(&reason)) + let unstable_extra = if show_reason { + match (!stab.feature.is_empty(), &cx.issue_tracker_base_url, stab.issue) { + (true, &Some(ref tracker_url), Some(issue_no)) => + format!(" ({} #{})", Escape(&stab.feature), + tracker_url, issue_no, issue_no), + (false, &Some(ref tracker_url), Some(issue_no)) => + format!(" (#{})", Escape(&tracker_url), issue_no, + issue_no), + (true, _, _) => + format!(" ({})", Escape(&stab.feature)), + _ => String::new(), + } + } else { + String::new() + }; + format!("Unstable{}{}", unstable_extra, Markdown(&reason)) } else { return None }; diff --git a/src/librustdoc/html/static/main.css b/src/librustdoc/html/static/main.css index 774d413fffa15..ea1c1ae283fd3 100644 --- a/src/librustdoc/html/static/main.css +++ b/src/librustdoc/html/static/main.css @@ -123,7 +123,7 @@ code, pre { font-family: "Source Code Pro", Menlo, Monaco, Consolas, "DejaVu Sans Mono", Inconsolata, monospace; white-space: pre-wrap; } -.docblock code { +.docblock code, .stability code { background-color: #F5F5F5; border-radius: 3px; padding: 0 0.2em; @@ -387,11 +387,11 @@ a { background: transparent; } -.docblock a { +.docblock a, .stability a { color: #4e8bca; } -.docblock a:hover { +.docblock a:hover, .stability a { text-decoration: underline; } From 7fdbe69996f5e79343379f33609ddba9103d1d54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Wernst=C3=A5l?= Date: Sun, 16 Aug 2015 17:22:50 +0200 Subject: [PATCH 4/9] rustdoc: Added issue_tracker_base_url annotations to crates --- src/liballoc/lib.rs | 1 + src/libarena/lib.rs | 3 ++- src/libcollections/lib.rs | 1 + src/libcore/lib.rs | 3 ++- src/libflate/lib.rs | 3 ++- src/libfmt_macros/lib.rs | 3 ++- src/libgetopts/lib.rs | 3 ++- src/libgraphviz/lib.rs | 3 ++- src/liblibc/lib.rs | 3 ++- src/liblog/lib.rs | 3 ++- src/librand/lib.rs | 3 ++- src/librbml/lib.rs | 3 ++- src/librustc/lib.rs | 3 ++- src/librustc_back/lib.rs | 3 ++- src/librustc_borrowck/lib.rs | 3 ++- src/librustc_data_structures/lib.rs | 3 ++- src/librustc_driver/lib.rs | 3 ++- src/librustc_lint/lib.rs | 3 ++- src/librustc_llvm/lib.rs | 3 ++- src/librustc_privacy/lib.rs | 3 ++- src/librustc_resolve/lib.rs | 3 ++- src/librustc_trans/lib.rs | 3 ++- src/librustc_typeck/lib.rs | 3 ++- src/librustc_unicode/lib.rs | 1 + src/librustdoc/lib.rs | 3 ++- src/libserialize/lib.rs | 3 ++- src/libstd/lib.rs | 1 + src/libsyntax/lib.rs | 3 ++- src/libterm/lib.rs | 3 ++- src/libtest/lib.rs | 3 ++- 30 files changed, 56 insertions(+), 26 deletions(-) diff --git a/src/liballoc/lib.rs b/src/liballoc/lib.rs index 630993d829120..677916b53989b 100644 --- a/src/liballoc/lib.rs +++ b/src/liballoc/lib.rs @@ -69,6 +69,7 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/", test(no_crate_inject))] #![no_std] #![cfg_attr(not(stage0), needs_allocator)] diff --git a/src/libarena/lib.rs b/src/libarena/lib.rs index 332e5abdefb0a..25c2ce1c3caca 100644 --- a/src/libarena/lib.rs +++ b/src/libarena/lib.rs @@ -28,7 +28,8 @@ #![crate_type = "dylib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(alloc)] #![feature(box_syntax)] diff --git a/src/libcollections/lib.rs b/src/libcollections/lib.rs index 702b01f0e2eee..2639e6dce468f 100644 --- a/src/libcollections/lib.rs +++ b/src/libcollections/lib.rs @@ -26,6 +26,7 @@ html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", html_playground_url = "https://play.rust-lang.org/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/", test(no_crate_inject))] #![allow(trivial_casts)] diff --git a/src/libcore/lib.rs b/src/libcore/lib.rs index ae85e2712ce81..de7bdd410b7c8 100644 --- a/src/libcore/lib.rs +++ b/src/libcore/lib.rs @@ -58,7 +58,8 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/")] + html_playground_url = "https://play.rust-lang.org/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![doc(test(no_crate_inject))] #![no_core] diff --git a/src/libflate/lib.rs b/src/libflate/lib.rs index d85f653937c80..f117500a31af2 100644 --- a/src/libflate/lib.rs +++ b/src/libflate/lib.rs @@ -23,7 +23,8 @@ #![crate_type = "dylib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(libc)] #![feature(staged_api)] diff --git a/src/libfmt_macros/lib.rs b/src/libfmt_macros/lib.rs index 694382047308e..0fa4a0ea6128d 100644 --- a/src/libfmt_macros/lib.rs +++ b/src/libfmt_macros/lib.rs @@ -24,7 +24,8 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/")] + html_playground_url = "https://play.rust-lang.org/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(staged_api)] #![feature(unicode)] diff --git a/src/libgetopts/lib.rs b/src/libgetopts/lib.rs index ef63f85bb1337..af5990da64386 100644 --- a/src/libgetopts/lib.rs +++ b/src/libgetopts/lib.rs @@ -88,7 +88,8 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/")] + html_playground_url = "https://play.rust-lang.org/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![deny(missing_docs)] #![feature(staged_api)] diff --git a/src/libgraphviz/lib.rs b/src/libgraphviz/lib.rs index 172ae2746b87d..d48c84ee0362c 100644 --- a/src/libgraphviz/lib.rs +++ b/src/libgraphviz/lib.rs @@ -283,7 +283,8 @@ #![crate_type = "dylib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(into_cow)] #![feature(str_escape)] diff --git a/src/liblibc/lib.rs b/src/liblibc/lib.rs index 08f0b2aa895b0..6273c1214ec4e 100644 --- a/src/liblibc/lib.rs +++ b/src/liblibc/lib.rs @@ -21,7 +21,8 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/")] + html_playground_url = "https://play.rust-lang.org/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![cfg_attr(test, feature(test))] //! Bindings for the C standard library and other platform libraries diff --git a/src/liblog/lib.rs b/src/liblog/lib.rs index 2187c1fb7dfa4..f192be9cb2c54 100644 --- a/src/liblog/lib.rs +++ b/src/liblog/lib.rs @@ -167,7 +167,8 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/")] + html_playground_url = "https://play.rust-lang.org/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![deny(missing_docs)] #![feature(box_raw)] diff --git a/src/librand/lib.rs b/src/librand/lib.rs index a72bc389286f6..f7566fa4d90a3 100644 --- a/src/librand/lib.rs +++ b/src/librand/lib.rs @@ -23,7 +23,8 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/")] + html_playground_url = "https://play.rust-lang.org/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![no_std] #![staged_api] #![unstable(feature = "rand", diff --git a/src/librbml/lib.rs b/src/librbml/lib.rs index af36d45ab573d..f4efb3d2a476c 100644 --- a/src/librbml/lib.rs +++ b/src/librbml/lib.rs @@ -121,7 +121,8 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/")] + html_playground_url = "https://play.rust-lang.org/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(rustc_private)] #![feature(staged_api)] diff --git a/src/librustc/lib.rs b/src/librustc/lib.rs index 370405d82abdb..44bfd7f57ddcf 100644 --- a/src/librustc/lib.rs +++ b/src/librustc/lib.rs @@ -23,7 +23,8 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(append)] #![feature(associated_consts)] diff --git a/src/librustc_back/lib.rs b/src/librustc_back/lib.rs index 9f503c0c33c16..3ec22b44319c7 100644 --- a/src/librustc_back/lib.rs +++ b/src/librustc_back/lib.rs @@ -30,7 +30,8 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(box_syntax)] #![feature(fs_canonicalize)] diff --git a/src/librustc_borrowck/lib.rs b/src/librustc_borrowck/lib.rs index 5157e31b8326d..d36c9c4e3027f 100644 --- a/src/librustc_borrowck/lib.rs +++ b/src/librustc_borrowck/lib.rs @@ -17,7 +17,8 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![allow(non_camel_case_types)] diff --git a/src/librustc_data_structures/lib.rs b/src/librustc_data_structures/lib.rs index eb9ed83b2b0dc..babb81f8bd6da 100644 --- a/src/librustc_data_structures/lib.rs +++ b/src/librustc_data_structures/lib.rs @@ -25,7 +25,8 @@ #![staged_api] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://www.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(rustc_private, staged_api)] #![cfg_attr(test, feature(test))] diff --git a/src/librustc_driver/lib.rs b/src/librustc_driver/lib.rs index 1d440af269713..2474dfbdf538e 100644 --- a/src/librustc_driver/lib.rs +++ b/src/librustc_driver/lib.rs @@ -23,7 +23,8 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(box_syntax)] #![feature(libc)] diff --git a/src/librustc_lint/lib.rs b/src/librustc_lint/lib.rs index d97f3dbb79b8a..0a4c102e2ca89 100644 --- a/src/librustc_lint/lib.rs +++ b/src/librustc_lint/lib.rs @@ -28,7 +28,8 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![cfg_attr(test, feature(test))] #![feature(box_patterns)] diff --git a/src/librustc_llvm/lib.rs b/src/librustc_llvm/lib.rs index aa3a991b8b6d4..13f8f3f4783dd 100644 --- a/src/librustc_llvm/lib.rs +++ b/src/librustc_llvm/lib.rs @@ -23,7 +23,8 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(associated_consts)] #![feature(box_syntax)] diff --git a/src/librustc_privacy/lib.rs b/src/librustc_privacy/lib.rs index 912da8f61c87a..3c54fbe51178b 100644 --- a/src/librustc_privacy/lib.rs +++ b/src/librustc_privacy/lib.rs @@ -17,7 +17,8 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(rustc_diagnostic_macros)] #![feature(rustc_private)] diff --git a/src/librustc_resolve/lib.rs b/src/librustc_resolve/lib.rs index 8127c2dee2cbf..b49609ca36d7c 100644 --- a/src/librustc_resolve/lib.rs +++ b/src/librustc_resolve/lib.rs @@ -17,7 +17,8 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(associated_consts)] #![feature(borrow_state)] diff --git a/src/librustc_trans/lib.rs b/src/librustc_trans/lib.rs index 6d91ae6fed639..6c0563de5ff87 100644 --- a/src/librustc_trans/lib.rs +++ b/src/librustc_trans/lib.rs @@ -23,7 +23,8 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(box_patterns)] #![feature(box_syntax)] diff --git a/src/librustc_typeck/lib.rs b/src/librustc_typeck/lib.rs index 08fd4d8dee5d5..5b684e9fa4dea 100644 --- a/src/librustc_typeck/lib.rs +++ b/src/librustc_typeck/lib.rs @@ -71,7 +71,8 @@ This API is completely unstable and subject to change. #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![allow(non_camel_case_types)] diff --git a/src/librustc_unicode/lib.rs b/src/librustc_unicode/lib.rs index 99284fee2d9d5..d046393cdeb08 100644 --- a/src/librustc_unicode/lib.rs +++ b/src/librustc_unicode/lib.rs @@ -30,6 +30,7 @@ html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", html_playground_url = "https://play.rust-lang.org/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/", test(no_crate_inject))] #![no_std] diff --git a/src/librustdoc/lib.rs b/src/librustdoc/lib.rs index 73b7de45c4a2c..af1d06916bc94 100644 --- a/src/librustdoc/lib.rs +++ b/src/librustdoc/lib.rs @@ -18,7 +18,8 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/")] + html_playground_url = "https://play.rust-lang.org/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(box_patterns)] #![feature(box_syntax)] diff --git a/src/libserialize/lib.rs b/src/libserialize/lib.rs index 5b7bec41723cd..ef6da25ac239d 100644 --- a/src/libserialize/lib.rs +++ b/src/libserialize/lib.rs @@ -26,7 +26,8 @@ Core encoding and decoding interfaces. #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/")] + html_playground_url = "https://play.rust-lang.org/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(box_syntax)] #![feature(collections)] diff --git a/src/libstd/lib.rs b/src/libstd/lib.rs index 655fa04c2644e..ca293347d04da 100644 --- a/src/libstd/lib.rs +++ b/src/libstd/lib.rs @@ -195,6 +195,7 @@ html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", html_playground_url = "https://play.rust-lang.org/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/", test(no_crate_inject, attr(deny(warnings))), test(attr(allow(dead_code, deprecated, unused_variables, unused_mut))))] diff --git a/src/libsyntax/lib.rs b/src/libsyntax/lib.rs index 0d1fa6dd7265a..a190030fdd40e 100644 --- a/src/libsyntax/lib.rs +++ b/src/libsyntax/lib.rs @@ -23,7 +23,8 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(associated_consts)] #![feature(drain)] diff --git a/src/libterm/lib.rs b/src/libterm/lib.rs index 8bf8044f81431..798058c3eaf86 100644 --- a/src/libterm/lib.rs +++ b/src/libterm/lib.rs @@ -53,7 +53,8 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/")] + html_playground_url = "https://play.rust-lang.org/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![deny(missing_docs)] #![feature(box_syntax)] diff --git a/src/libtest/lib.rs b/src/libtest/lib.rs index 47c50f70a392a..3f2f93fa3ad59 100644 --- a/src/libtest/lib.rs +++ b/src/libtest/lib.rs @@ -32,7 +32,8 @@ #![crate_type = "dylib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/")] + html_root_url = "https://doc.rust-lang.org/nightly/", + issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] #![feature(asm)] #![feature(box_syntax)] From ed02a768ef88d041f7a5088ec48fb734fb7318e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Wernst=C3=A5l?= Date: Sun, 16 Aug 2015 23:06:57 +0200 Subject: [PATCH 5/9] librustdoc: Fix tidy --- src/librustdoc/html/render.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs index c36fb95be42b2..34633bb616209 100644 --- a/src/librustdoc/html/render.rs +++ b/src/librustdoc/html/render.rs @@ -1712,8 +1712,8 @@ fn short_stability(item: &clean::Item, cx: &Context, show_reason: bool) -> Optio let unstable_extra = if show_reason { match (!stab.feature.is_empty(), &cx.issue_tracker_base_url, stab.issue) { (true, &Some(ref tracker_url), Some(issue_no)) => - format!(" ({} #{})", Escape(&stab.feature), - tracker_url, issue_no, issue_no), + format!(" ({} #{})", + Escape(&stab.feature), tracker_url, issue_no, issue_no), (false, &Some(ref tracker_url), Some(issue_no)) => format!(" (#{})", Escape(&tracker_url), issue_no, issue_no), From d893145cae67032ebdc3cfc73396cab362840bb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Wernst=C3=A5l?= Date: Mon, 17 Aug 2015 20:23:47 +0200 Subject: [PATCH 6/9] rustdoc: Adjusted style for unstable feature-name --- src/librustdoc/html/static/main.css | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/librustdoc/html/static/main.css b/src/librustdoc/html/static/main.css index ea1c1ae283fd3..c98b7825795b5 100644 --- a/src/librustdoc/html/static/main.css +++ b/src/librustdoc/html/static/main.css @@ -123,7 +123,7 @@ code, pre { font-family: "Source Code Pro", Menlo, Monaco, Consolas, "DejaVu Sans Mono", Inconsolata, monospace; white-space: pre-wrap; } -.docblock code, .stability code { +.docblock code { background-color: #F5F5F5; border-radius: 3px; padding: 0 0.2em; @@ -355,6 +355,10 @@ nav.sub { margin-left: 20px; } +.content .stability code { + font-size: 90%; +} + nav { border-bottom: 1px solid #e0e0e0; padding-bottom: 10px; From 10d08f0466ad6816721e3fa2a52d2a6e255f36e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Wernst=C3=A5l?= Date: Mon, 17 Aug 2015 20:24:28 +0200 Subject: [PATCH 7/9] rustdoc: Removed command line option issue-tracker-base-url --- src/librustdoc/html/render.rs | 5 ++--- src/librustdoc/lib.rs | 5 +---- 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs index 34633bb616209..d2c8078e62a40 100644 --- a/src/librustdoc/html/render.rs +++ b/src/librustdoc/html/render.rs @@ -306,8 +306,7 @@ thread_local!(pub static CURRENT_LOCATION_KEY: RefCell> = pub fn run(mut krate: clean::Crate, external_html: &ExternalHtml, dst: PathBuf, - passes: HashSet, - issue_tracker_base_url: Option) -> io::Result<()> { + passes: HashSet) -> io::Result<()> { let src_root = match krate.src.parent() { Some(p) => p.to_path_buf(), None => PathBuf::new(), @@ -327,7 +326,7 @@ pub fn run(mut krate: clean::Crate, }, include_sources: true, render_redirect_pages: false, - issue_tracker_base_url: issue_tracker_base_url, + issue_tracker_base_url: None, }; try!(mkdir(&cx.dst)); diff --git a/src/librustdoc/lib.rs b/src/librustdoc/lib.rs index af1d06916bc94..a754fb058ee99 100644 --- a/src/librustdoc/lib.rs +++ b/src/librustdoc/lib.rs @@ -179,8 +179,6 @@ pub fn opts() -> Vec { "FILES"), optopt("", "markdown-playground-url", "URL to send code snippets to", "URL"), - optopt("", "issue-tracker-base-url", - "base URL for issue tracker", "URL"), optflag("", "markdown-no-toc", "don't include table of contents") ) } @@ -287,8 +285,7 @@ pub fn main_args(args: &[String]) -> isize { Some("html") | None => { match html::render::run(krate, &external_html, output.unwrap_or(PathBuf::from("doc")), - passes.into_iter().collect(), - matches.opt_str("issue-tracker-base-url")) { + passes.into_iter().collect()) { Ok(()) => {} Err(e) => panic!("failed to generate documentation: {}", e), } From 3dc02978bd8e646496d691ed29b68264b4ec77b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Wernst=C3=A5l?= Date: Mon, 17 Aug 2015 20:37:30 +0200 Subject: [PATCH 8/9] rustdoc: Removed issue_tracker_base_url from crates not in public API docs --- src/libarena/lib.rs | 3 +-- src/libflate/lib.rs | 3 +-- src/libfmt_macros/lib.rs | 3 +-- src/libgetopts/lib.rs | 3 +-- src/libgraphviz/lib.rs | 3 +-- src/liblog/lib.rs | 3 +-- src/librand/lib.rs | 3 +-- src/librbml/lib.rs | 3 +-- src/librustc/lib.rs | 3 +-- src/librustc_back/lib.rs | 3 +-- src/librustc_borrowck/lib.rs | 3 +-- src/librustc_data_structures/lib.rs | 3 +-- src/librustc_driver/lib.rs | 3 +-- src/librustc_lint/lib.rs | 3 +-- src/librustc_llvm/lib.rs | 3 +-- src/librustc_privacy/lib.rs | 3 +-- src/librustc_resolve/lib.rs | 3 +-- src/librustc_trans/lib.rs | 3 +-- src/librustc_typeck/lib.rs | 3 +-- src/librustdoc/lib.rs | 3 +-- src/libserialize/lib.rs | 3 +-- src/libsyntax/lib.rs | 3 +-- src/libterm/lib.rs | 3 +-- src/libtest/lib.rs | 3 +-- 24 files changed, 24 insertions(+), 48 deletions(-) diff --git a/src/libarena/lib.rs b/src/libarena/lib.rs index 25c2ce1c3caca..332e5abdefb0a 100644 --- a/src/libarena/lib.rs +++ b/src/libarena/lib.rs @@ -28,8 +28,7 @@ #![crate_type = "dylib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![feature(alloc)] #![feature(box_syntax)] diff --git a/src/libflate/lib.rs b/src/libflate/lib.rs index f117500a31af2..d85f653937c80 100644 --- a/src/libflate/lib.rs +++ b/src/libflate/lib.rs @@ -23,8 +23,7 @@ #![crate_type = "dylib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![feature(libc)] #![feature(staged_api)] diff --git a/src/libfmt_macros/lib.rs b/src/libfmt_macros/lib.rs index 0fa4a0ea6128d..694382047308e 100644 --- a/src/libfmt_macros/lib.rs +++ b/src/libfmt_macros/lib.rs @@ -24,8 +24,7 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_playground_url = "https://play.rust-lang.org/")] #![feature(staged_api)] #![feature(unicode)] diff --git a/src/libgetopts/lib.rs b/src/libgetopts/lib.rs index af5990da64386..ef63f85bb1337 100644 --- a/src/libgetopts/lib.rs +++ b/src/libgetopts/lib.rs @@ -88,8 +88,7 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_playground_url = "https://play.rust-lang.org/")] #![deny(missing_docs)] #![feature(staged_api)] diff --git a/src/libgraphviz/lib.rs b/src/libgraphviz/lib.rs index d48c84ee0362c..172ae2746b87d 100644 --- a/src/libgraphviz/lib.rs +++ b/src/libgraphviz/lib.rs @@ -283,8 +283,7 @@ #![crate_type = "dylib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![feature(into_cow)] #![feature(str_escape)] diff --git a/src/liblog/lib.rs b/src/liblog/lib.rs index f192be9cb2c54..2187c1fb7dfa4 100644 --- a/src/liblog/lib.rs +++ b/src/liblog/lib.rs @@ -167,8 +167,7 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_playground_url = "https://play.rust-lang.org/")] #![deny(missing_docs)] #![feature(box_raw)] diff --git a/src/librand/lib.rs b/src/librand/lib.rs index f7566fa4d90a3..a72bc389286f6 100644 --- a/src/librand/lib.rs +++ b/src/librand/lib.rs @@ -23,8 +23,7 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_playground_url = "https://play.rust-lang.org/")] #![no_std] #![staged_api] #![unstable(feature = "rand", diff --git a/src/librbml/lib.rs b/src/librbml/lib.rs index f4efb3d2a476c..af36d45ab573d 100644 --- a/src/librbml/lib.rs +++ b/src/librbml/lib.rs @@ -121,8 +121,7 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_playground_url = "https://play.rust-lang.org/")] #![feature(rustc_private)] #![feature(staged_api)] diff --git a/src/librustc/lib.rs b/src/librustc/lib.rs index 44bfd7f57ddcf..370405d82abdb 100644 --- a/src/librustc/lib.rs +++ b/src/librustc/lib.rs @@ -23,8 +23,7 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![feature(append)] #![feature(associated_consts)] diff --git a/src/librustc_back/lib.rs b/src/librustc_back/lib.rs index 3ec22b44319c7..9f503c0c33c16 100644 --- a/src/librustc_back/lib.rs +++ b/src/librustc_back/lib.rs @@ -30,8 +30,7 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![feature(box_syntax)] #![feature(fs_canonicalize)] diff --git a/src/librustc_borrowck/lib.rs b/src/librustc_borrowck/lib.rs index d36c9c4e3027f..5157e31b8326d 100644 --- a/src/librustc_borrowck/lib.rs +++ b/src/librustc_borrowck/lib.rs @@ -17,8 +17,7 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![allow(non_camel_case_types)] diff --git a/src/librustc_data_structures/lib.rs b/src/librustc_data_structures/lib.rs index babb81f8bd6da..eb9ed83b2b0dc 100644 --- a/src/librustc_data_structures/lib.rs +++ b/src/librustc_data_structures/lib.rs @@ -25,8 +25,7 @@ #![staged_api] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://www.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![feature(rustc_private, staged_api)] #![cfg_attr(test, feature(test))] diff --git a/src/librustc_driver/lib.rs b/src/librustc_driver/lib.rs index 2474dfbdf538e..1d440af269713 100644 --- a/src/librustc_driver/lib.rs +++ b/src/librustc_driver/lib.rs @@ -23,8 +23,7 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![feature(box_syntax)] #![feature(libc)] diff --git a/src/librustc_lint/lib.rs b/src/librustc_lint/lib.rs index 0a4c102e2ca89..d97f3dbb79b8a 100644 --- a/src/librustc_lint/lib.rs +++ b/src/librustc_lint/lib.rs @@ -28,8 +28,7 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![cfg_attr(test, feature(test))] #![feature(box_patterns)] diff --git a/src/librustc_llvm/lib.rs b/src/librustc_llvm/lib.rs index 13f8f3f4783dd..aa3a991b8b6d4 100644 --- a/src/librustc_llvm/lib.rs +++ b/src/librustc_llvm/lib.rs @@ -23,8 +23,7 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![feature(associated_consts)] #![feature(box_syntax)] diff --git a/src/librustc_privacy/lib.rs b/src/librustc_privacy/lib.rs index 3c54fbe51178b..912da8f61c87a 100644 --- a/src/librustc_privacy/lib.rs +++ b/src/librustc_privacy/lib.rs @@ -17,8 +17,7 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![feature(rustc_diagnostic_macros)] #![feature(rustc_private)] diff --git a/src/librustc_resolve/lib.rs b/src/librustc_resolve/lib.rs index b49609ca36d7c..8127c2dee2cbf 100644 --- a/src/librustc_resolve/lib.rs +++ b/src/librustc_resolve/lib.rs @@ -17,8 +17,7 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![feature(associated_consts)] #![feature(borrow_state)] diff --git a/src/librustc_trans/lib.rs b/src/librustc_trans/lib.rs index 6c0563de5ff87..6d91ae6fed639 100644 --- a/src/librustc_trans/lib.rs +++ b/src/librustc_trans/lib.rs @@ -23,8 +23,7 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![feature(box_patterns)] #![feature(box_syntax)] diff --git a/src/librustc_typeck/lib.rs b/src/librustc_typeck/lib.rs index 5b684e9fa4dea..08fd4d8dee5d5 100644 --- a/src/librustc_typeck/lib.rs +++ b/src/librustc_typeck/lib.rs @@ -71,8 +71,7 @@ This API is completely unstable and subject to change. #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![allow(non_camel_case_types)] diff --git a/src/librustdoc/lib.rs b/src/librustdoc/lib.rs index a754fb058ee99..33902363e0a25 100644 --- a/src/librustdoc/lib.rs +++ b/src/librustdoc/lib.rs @@ -18,8 +18,7 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_playground_url = "https://play.rust-lang.org/")] #![feature(box_patterns)] #![feature(box_syntax)] diff --git a/src/libserialize/lib.rs b/src/libserialize/lib.rs index ef6da25ac239d..5b7bec41723cd 100644 --- a/src/libserialize/lib.rs +++ b/src/libserialize/lib.rs @@ -26,8 +26,7 @@ Core encoding and decoding interfaces. #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_playground_url = "https://play.rust-lang.org/")] #![feature(box_syntax)] #![feature(collections)] diff --git a/src/libsyntax/lib.rs b/src/libsyntax/lib.rs index a190030fdd40e..0d1fa6dd7265a 100644 --- a/src/libsyntax/lib.rs +++ b/src/libsyntax/lib.rs @@ -23,8 +23,7 @@ #![crate_type = "rlib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![feature(associated_consts)] #![feature(drain)] diff --git a/src/libterm/lib.rs b/src/libterm/lib.rs index 798058c3eaf86..8bf8044f81431 100644 --- a/src/libterm/lib.rs +++ b/src/libterm/lib.rs @@ -53,8 +53,7 @@ #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/", - html_playground_url = "https://play.rust-lang.org/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_playground_url = "https://play.rust-lang.org/")] #![deny(missing_docs)] #![feature(box_syntax)] diff --git a/src/libtest/lib.rs b/src/libtest/lib.rs index 3f2f93fa3ad59..47c50f70a392a 100644 --- a/src/libtest/lib.rs +++ b/src/libtest/lib.rs @@ -32,8 +32,7 @@ #![crate_type = "dylib"] #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", - html_root_url = "https://doc.rust-lang.org/nightly/", - issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] + html_root_url = "https://doc.rust-lang.org/nightly/")] #![feature(asm)] #![feature(box_syntax)] From 6532a08525137a5f839c4ed555ad95360621f5db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Wernst=C3=A5l?= Date: Mon, 17 Aug 2015 22:05:07 +0200 Subject: [PATCH 9/9] rustdoc: Add test for #27759 --- src/test/rustdoc/issue-27759.rs | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 src/test/rustdoc/issue-27759.rs diff --git a/src/test/rustdoc/issue-27759.rs b/src/test/rustdoc/issue-27759.rs new file mode 100644 index 0000000000000..2d5f97b1f9331 --- /dev/null +++ b/src/test/rustdoc/issue-27759.rs @@ -0,0 +1,25 @@ +// Copyright 2015 The Rust Project Developers. See the COPYRIGHT +// file at the top-level directory of this distribution and at +// http://rust-lang.org/COPYRIGHT. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +#![feature(staged_api)] +#![staged_api] +#![doc(issue_tracker_base_url = "http://issue_url/")] + +// @has issue_27759/unstable/index.html +// @has - 'test' +// @has - '#27759' +#[unstable(feature="test", issue="27759")] +pub mod unstable { + // @has issue_27759/unstable/fn.issue.html + // @has - 'test_function' + // @has - '#1234567890' + #[unstable(feature="test_function", issue="1234567890")] + pub fn issue() {} +}