Skip to content

Commit

Permalink
Rollup merge of #92077 - jyn514:remove-collapsed, r=GuillaumeGomez
Browse files Browse the repository at this point in the history
rustdoc: Remove unused `collapsed` field

`render/context` always runs after `run_global_context`, so it was always set to `true`.

This is a holdover from when rustdoc allowed configuring passes, but the `collapse-docs` pass was
removed ages ago, and the ability to configure passes is about to be removed.

Found while reviewing #91305.
  • Loading branch information
matthiaskrgr authored Dec 19, 2021
2 parents 690d6b0 + dea1c68 commit 1f080f6
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 17 deletions.
3 changes: 1 addition & 2 deletions src/librustdoc/clean/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,11 @@ crate struct Crate {
crate primitives: ThinVec<(DefId, PrimitiveType)>,
/// Only here so that they can be filtered through the rustdoc passes.
crate external_traits: Rc<RefCell<FxHashMap<DefId, TraitWithExtraInfo>>>,
crate collapsed: bool,
}

// `Crate` is frequently moved by-value. Make sure it doesn't unintentionally get bigger.
#[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
rustc_data_structures::static_assert_size!(Crate, 80);
rustc_data_structures::static_assert_size!(Crate, 72);

impl Crate {
crate fn name(&self, tcx: TyCtxt<'_>) -> Symbol {
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/clean/utils.rs
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ crate fn krate(cx: &mut DocContext<'_>) -> Crate {
}));
}

Crate { module, primitives, external_traits: cx.external_traits.clone(), collapsed: false }
Crate { module, primitives, external_traits: cx.external_traits.clone() }
}

fn external_generic_args(
Expand Down
3 changes: 0 additions & 3 deletions src/librustdoc/core.rs
Original file line number Diff line number Diff line change
Expand Up @@ -510,9 +510,6 @@ crate fn run_global_ctxt(

krate = tcx.sess.time("create_format_cache", || Cache::populate(&mut ctxt, krate));

// The main crate doc comments are always collapsed.
krate.collapsed = true;

(krate, ctxt.render_options, ctxt.cache)
}

Expand Down
9 changes: 0 additions & 9 deletions src/librustdoc/html/render/context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,6 @@ crate struct SharedContext<'tcx> {
crate local_sources: FxHashMap<PathBuf, String>,
/// Show the memory layout of types in the docs.
pub(super) show_type_layout: bool,
/// Whether the collapsed pass ran
collapsed: bool,
/// The base-URL of the issue tracker for when an item has been tagged with
/// an issue number.
pub(super) issue_tracker_base_url: Option<String>,
Expand Down Expand Up @@ -142,12 +140,6 @@ impl SharedContext<'_> {
Ok(())
}

/// Returns the `collapsed_doc_value` of the given item if this is the main crate, otherwise
/// returns the `doc_value`.
crate fn maybe_collapsed_doc_value<'a>(&self, item: &'a clean::Item) -> Option<String> {
if self.collapsed { item.collapsed_doc_value() } else { item.doc_value() }
}

crate fn edition(&self) -> Edition {
self.tcx.sess.edition()
}
Expand Down Expand Up @@ -472,7 +464,6 @@ impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> {
let (sender, receiver) = channel();
let mut scx = SharedContext {
tcx,
collapsed: krate.collapsed,
src_root,
local_sources,
issue_tracker_base_url,
Expand Down
4 changes: 2 additions & 2 deletions src/librustdoc/html/render/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -567,7 +567,7 @@ fn document_full_inner(
is_collapsible: bool,
heading_offset: HeadingOffset,
) {
if let Some(s) = cx.shared.maybe_collapsed_doc_value(item) {
if let Some(s) = item.collapsed_doc_value() {
debug!("Doc block: =====\n{}\n=====", s);
if is_collapsible {
w.write_str(
Expand Down Expand Up @@ -1612,7 +1612,7 @@ fn render_impl(
write!(w, "</summary>")
}

if let Some(ref dox) = cx.shared.maybe_collapsed_doc_value(&i.impl_item) {
if let Some(ref dox) = i.impl_item.collapsed_doc_value() {
let mut ids = cx.id_map.borrow_mut();
write!(
w,
Expand Down

0 comments on commit 1f080f6

Please sign in to comment.