nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-05-14 02:49:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Warn if linking to a private item

Browse Source
This commit is contained in:
Joshua Nelson 2020-05-13 00:21:54 -04:00
parent 14e65d5e95
commit 6f8bec9399
2 changed files with 28 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/librustdoc/lib.rs
View File

@ -34,6 +34,7 @@ extern crate rustc_metadata;
extern crate rustc_middle;
extern crate rustc_mir;
extern crate rustc_parse;
extern crate rustc_privacy;
extern crate rustc_resolve;
extern crate rustc_session;
extern crate rustc_span as rustc_span;

30
src/librustdoc/passes/collect_intra_doc_links.rs
View File

@ -178,6 +178,7 @@ impl<'a, 'tcx> LinkCollector<'a, 'tcx> {
let result = cx.enter_resolver(|resolver| {
resolver.resolve_str_path_error(DUMMY_SP, &path_str, ns, module_id)
});
debug!("{} resolved to {:?} in namespace {:?}", path_str, ns, result);
let result = match result {
Ok((_, Res::Err)) => Err(ErrorKind::ResolutionFailure),
_ => result.map_err(|_| ErrorKind::ResolutionFailure),
@ -202,7 +203,11 @@ impl<'a, 'tcx> LinkCollector<'a, 'tcx> {
}
return Ok((res, Some(path_str.to_owned())));
}
_ => return Ok((res, extra_fragment.clone())),
other => {
debug!("failed to resolve {} in namespace {:?} (got {:?})", path_str, ns, other);
debug!("extra_fragment is {:?}", extra_fragment);
return Ok((res, extra_fragment.clone()));
}
};
if value != (ns == ValueNS) {
@ -555,9 +560,11 @@ impl<'a, 'tcx> DocFolder for LinkCollector<'a, 'tcx> {
} else {
(parts[0].to_owned(), None)
};
let resolved_self;
let mut path_str;
let (res, fragment) = {
let mut kind = None;
let mut path_str = if let Some(prefix) =
path_str = if let Some(prefix) =
["struct@", "enum@", "type@", "trait@", "union@"]
.iter()
.find(|p| link.starts_with(**p))
@ -614,7 +621,6 @@ impl<'a, 'tcx> DocFolder for LinkCollector<'a, 'tcx> {
let base_node =
if item.is_mod() && item.attrs.inner_docs { None } else { parent_node };
let resolved_self;
// replace `Self` with suitable item's parent name
if path_str.starts_with("Self::") {
if let Some(ref name) = parent_name {
@ -760,6 +766,24 @@ impl<'a, 'tcx> DocFolder for LinkCollector<'a, 'tcx> {
if let Res::PrimTy(_) = res {
item.attrs.links.push((ori_link, None, fragment));
} else {
// ~~WRONG: TODO: I think this happens too late and we need to instead put this in `self.resolve`~~
debug!("item {:?} resolved to {:?}", item, res);
if let Some(local) = res.opt_def_id().and_then(|def_id| def_id.as_local()) {
let hir_id = self.cx.tcx.hir().as_local_hir_id(local);
if !self.cx.tcx.privacy_access_levels(rustc_hir::def_id::LOCAL_CRATE).is_exported(hir_id) {
let item_name = item.name.as_deref().unwrap_or("<unknown>");
build_diagnostic(
cx,
&item,
path_str,
&dox,
link_range,
&format!("public documentation for `{}` links to a private item", item_name),
"this item is private",
None,
);
}
}
let id = register_res(cx, res);
item.attrs.links.push((ori_link, Some(id), fragment));
}