Skip to content

Commit

Permalink
Rollup merge of rust-lang#77253 - jyn514:crate-link, r=Manishearth
Browse files Browse the repository at this point in the history
Resolve `crate` in intra-doc links properly across crates

Closes rust-lang#77193; see rust-lang#77193 (comment) for an explanation of what's going on here.
~~This also fixes the BTreeMap docs that have been broken for a while; see the description on the second commit for why and how.~~ Nope, see the second commit for why the link had to be changed.

r? @Manishearth
cc @dylni

@dylni note that this doesn't solve your original problem - now _both_ `with_code` and `crate::with_code` will be broken links. However this will fix a lot of other broken links (in particular I think https://docs.rs/sqlx/0.4.0-beta.1/sqlx/query/struct.Query.html is because of this bug). I'll open another issue for resolving additional docs in the new scope.
  • Loading branch information
Dylan-DPC authored Sep 28, 2020
2 parents 62f7d56 + 4065846 commit 275096e
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 2 deletions.
2 changes: 1 addition & 1 deletion library/alloc/src/collections/btree/map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -811,7 +811,7 @@ impl<K: Ord, V> BTreeMap<K, V> {
/// types that can be `==` without being identical. See the [module-level
/// documentation] for more.
///
/// [module-level documentation]: crate::collections#insert-and-complex-keys
/// [module-level documentation]: index.html#insert-and-complex-keys
///
/// # Examples
///
Expand Down
13 changes: 12 additions & 1 deletion src/librustdoc/passes/collect_intra_doc_links.rs
Original file line number Diff line number Diff line change
Expand Up @@ -914,7 +914,7 @@ impl LinkCollector<'_, '_> {
parent_node
};

let module_id = if let Some(id) = base_node {
let mut module_id = if let Some(id) = base_node {
id
} else {
debug!("attempting to resolve item without parent module: {}", path_str);
Expand All @@ -937,6 +937,17 @@ impl LinkCollector<'_, '_> {
resolved_self = format!("{}::{}", name, &path_str[6..]);
path_str = &resolved_self;
}
} else if path_str.starts_with("crate::") {
use rustc_span::def_id::CRATE_DEF_INDEX;

// HACK(jynelson): rustc_resolve thinks that `crate` is the crate currently being documented.
// But rustdoc wants it to mean the crate this item was originally present in.
// To work around this, remove it and resolve relative to the crate root instead.
// HACK(jynelson)(2): If we just strip `crate::` then suddenly primitives become ambiguous
// (consider `crate::char`). Instead, change it to `self::`. This works because 'self' is now the crate root.
resolved_self = format!("self::{}", &path_str["crate::".len()..]);
path_str = &resolved_self;
module_id = DefId { krate: item.def_id.krate, index: CRATE_DEF_INDEX };
}

match self.resolve_with_disambiguator(
Expand Down
5 changes: 5 additions & 0 deletions src/test/rustdoc/auxiliary/intra-link-cross-crate-crate.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#![crate_name = "inner"]

/// Links to [crate::g]
pub fn f() {}
pub fn g() {}
6 changes: 6 additions & 0 deletions src/test/rustdoc/intra-link-cross-crate-crate.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// aux-build:intra-link-cross-crate-crate.rs
// build-aux-docs
#![crate_name = "outer"]
extern crate inner;
// @has outer/fn.f.html '//a[@href="../inner/fn.g.html"]' "crate::g"
pub use inner::f;

0 comments on commit 275096e

Please sign in to comment.