rustdoc: Nuke --passes=list

Author: fmease

src/librustdoc/config.rs

@@ -24,7 +24,6 @@ use crate::externalfiles::ExternalHtml;
 use crate::html::markdown::IdMap;
 use crate::html::render::StylePath;
 use crate::html::static_files;
-use crate::passes::{self, Condition};
 use crate::scrape_examples::{AllCallLocations, ScrapeExamplesOptions};
 use crate::{html, opts, theme};
 
@@ -421,38 +420,6 @@ impl Options {
         // check for deprecated options
         check_deprecated_options(matches, dcx);
 
-        if matches.opt_strs("passes") == ["list"] {
-            println!("Available passes for running rustdoc:");
-            for pass in passes::PASSES {
-                println!("{:>20} - {}", pass.name, pass.description);
-            }
-            println!("\nDefault passes for rustdoc:");
-            for p in passes::DEFAULT_PASSES {
-                print!("{:>20}", p.pass.name);
-                println_condition(p.condition);
-            }
-
-            if nightly_options::match_is_nightly_build(matches) {
-                println!("\nPasses run with `--show-coverage`:");
-                for p in passes::COVERAGE_PASSES {
-                    print!("{:>20}", p.pass.name);
-                    println_condition(p.condition);
-                }
-            }
-
-            fn println_condition(condition: Condition) {
-                use Condition::*;
-                match condition {
-                    Always => println!(),
-                    WhenDocumentPrivate => println!("  (when --document-private-items)"),
-                    WhenNotDocumentPrivate => println!("  (when not --document-private-items)"),
-                    WhenNotDocumentHidden => println!("  (when not --document-hidden-items)"),
-                }
-            }
-
-            return None;
-        }
-
         let mut emit = FxIndexMap::<_, EmitType>::default();
         for list in matches.opt_strs("emit") {
             for kind in list.split(',') {

src/librustdoc/passes/calculate_doc_coverage.rs

@@ -1,4 +1,7 @@
-//! Calculates information used for the --show-coverage flag.
+//! Calculates information used for the `--show-coverage` flag.
+//!
+//! More specifically, it counts the number of items with documentation, ones with
+//! "examples" (i.e., non-ignored Rust code blocks) and various totals.
 
 use std::collections::BTreeMap;
 use std::ops;
@@ -18,11 +21,8 @@ use crate::passes::Pass;
 use crate::passes::check_doc_test_visibility::{Tests, should_have_doc_example};
 use crate::visit::DocVisitor;
 
-pub(crate) const CALCULATE_DOC_COVERAGE: Pass = Pass {
-    name: "calculate-doc-coverage",
-    run: Some(calculate_doc_coverage),
-    description: "counts the number of items with and without documentation",
-};
+pub(crate) const CALCULATE_DOC_COVERAGE: Pass =
+    Pass { name: "calculate-doc-coverage", run: Some(calculate_doc_coverage) };
 
 fn calculate_doc_coverage(krate: clean::Crate, ctx: &mut DocContext<'_>) -> clean::Crate {
     let mut calc = CoverageCalculator { items: Default::default(), ctx };

src/librustdoc/passes/check_doc_cfg.rs

@@ -1,3 +1,5 @@
+//! Checks `#[doc(cfg(…))]` for unexpected cfgs wrt. `--check-cfg`.
+
 use rustc_hir::HirId;
 use rustc_hir::def_id::LocalDefId;
 use rustc_middle::ty::TyCtxt;
@@ -8,11 +10,7 @@ use crate::clean::{Attributes, Crate, Item};
 use crate::core::DocContext;
 use crate::visit::DocVisitor;
 
-pub(crate) const CHECK_DOC_CFG: Pass = Pass {
-    name: "check-doc-cfg",
-    run: Some(check_doc_cfg),
-    description: "checks `#[doc(cfg(...))]` for stability feature and unexpected cfgs",
-};
+pub(crate) const CHECK_DOC_CFG: Pass = Pass { name: "check-doc-cfg", run: Some(check_doc_cfg) };
 
 pub(crate) fn check_doc_cfg(krate: Crate, cx: &mut DocContext<'_>) -> Crate {
     let mut checker = DocCfgChecker { cx };

src/librustdoc/passes/check_doc_test_visibility.rs

@@ -18,11 +18,8 @@ use crate::core::DocContext;
 use crate::html::markdown::{ErrorCodes, Ignore, LangString, MdRelLine, find_testable_code};
 use crate::visit::DocVisitor;
 
-pub(crate) const CHECK_DOC_TEST_VISIBILITY: Pass = Pass {
-    name: "check_doc_test_visibility",
-    run: Some(check_doc_test_visibility),
-    description: "run various visibility-related lints on doctests",
-};
+pub(crate) const CHECK_DOC_TEST_VISIBILITY: Pass =
+    Pass { name: "check_doc_test_visibility", run: Some(check_doc_test_visibility) };
 
 struct DocTestVisibilityLinter<'a, 'tcx> {
     cx: &'a mut DocContext<'tcx>,

src/librustdoc/passes/collect_intra_doc_links.rs

@@ -1,6 +1,6 @@
-//! This module implements [RFC 1946]: Intra-rustdoc-links
+//! Resolves intra-doc links ([RFC 1946]).
 //!
-//! [RFC 1946]: https://github.com/rust-lang/rfcs/blob/master/text/1946-intra-rustdoc-links.md
+//! [RFC 1946]: https://rust-lang.github.io/rfcs/1946-intra-rustdoc-links.html
 
 use std::borrow::Cow;
 use std::fmt::Display;
@@ -38,7 +38,7 @@ use crate::passes::Pass;
 use crate::visit::DocVisitor;
 
 pub(crate) const COLLECT_INTRA_DOC_LINKS: Pass =
-    Pass { name: "collect-intra-doc-links", run: None, description: "resolves intra-doc links" };
+    Pass { name: "collect-intra-doc-links", run: None };
 
 pub(crate) fn collect_intra_doc_links<'a, 'tcx>(
     krate: Crate,

src/librustdoc/passes/collect_trait_impls.rs

@@ -1,6 +1,7 @@
-//! Collects trait impls for each item in the crate. For example, if a crate
-//! defines a struct that implements a trait, this pass will note that the
-//! struct implements that trait.
+//! Collects trait impls for each item in the crate.
+//!
+//! For example, if a crate defines a struct that implements a trait,
+//! this pass will note that the struct implements that trait.
 
 use rustc_data_structures::fx::FxHashSet;
 use rustc_hir::def_id::{DefId, DefIdMap, DefIdSet, LOCAL_CRATE};
@@ -14,11 +15,8 @@ use crate::core::DocContext;
 use crate::formats::cache::Cache;
 use crate::visit::DocVisitor;
 
-pub(crate) const COLLECT_TRAIT_IMPLS: Pass = Pass {
-    name: "collect-trait-impls",
-    run: Some(collect_trait_impls),
-    description: "retrieves trait impls for items in the crate",
-};
+pub(crate) const COLLECT_TRAIT_IMPLS: Pass =
+    Pass { name: "collect-trait-impls", run: Some(collect_trait_impls) };
 
 pub(crate) fn collect_trait_impls(mut krate: Crate, cx: &mut DocContext<'_>) -> Crate {
     let tcx = cx.tcx;

src/librustdoc/passes/lint.rs

@@ -1,5 +1,4 @@
-//! Runs several rustdoc lints, consolidating them into a single pass for
-//! efficiency and simplicity.
+//! Runs several rustdoc lints, consolidating them into a single pass for efficiency and simplicity.
 
 mod bare_urls;
 mod check_code_block_syntax;
@@ -12,8 +11,7 @@ use crate::clean::*;
 use crate::core::DocContext;
 use crate::visit::DocVisitor;
 
-pub(crate) const RUN_LINTS: Pass =
-    Pass { name: "run-lints", run: Some(run_lints), description: "runs some of rustdoc's lints" };
+pub(crate) const RUN_LINTS: Pass = Pass { name: "run-lints", run: Some(run_lints) };
 
 struct Linter<'a, 'tcx> {
     cx: &'a mut DocContext<'tcx>,

src/librustdoc/passes/mod.rs

@@ -8,41 +8,18 @@ use crate::core::DocContext;
 mod stripper;
 pub(crate) use stripper::*;
 
-mod strip_aliased_non_local;
-pub(crate) use self::strip_aliased_non_local::STRIP_ALIASED_NON_LOCAL;
-
-mod strip_hidden;
-pub(crate) use self::strip_hidden::STRIP_HIDDEN;
-
-mod strip_private;
-pub(crate) use self::strip_private::STRIP_PRIVATE;
-
-mod strip_priv_imports;
-pub(crate) use self::strip_priv_imports::STRIP_PRIV_IMPORTS;
-
-mod propagate_doc_cfg;
-pub(crate) use self::propagate_doc_cfg::PROPAGATE_DOC_CFG;
-
-mod propagate_stability;
-pub(crate) use self::propagate_stability::PROPAGATE_STABILITY;
-
-pub(crate) mod collect_intra_doc_links;
-pub(crate) use self::collect_intra_doc_links::COLLECT_INTRA_DOC_LINKS;
-
-mod check_doc_test_visibility;
-pub(crate) use self::check_doc_test_visibility::CHECK_DOC_TEST_VISIBILITY;
-
+mod calculate_doc_coverage;
 mod check_doc_cfg;
-pub(crate) use self::check_doc_cfg::CHECK_DOC_CFG;
-
+mod check_doc_test_visibility;
+pub(crate) mod collect_intra_doc_links;
 mod collect_trait_impls;
-pub(crate) use self::collect_trait_impls::COLLECT_TRAIT_IMPLS;
-
-mod calculate_doc_coverage;
-pub(crate) use self::calculate_doc_coverage::CALCULATE_DOC_COVERAGE;
-
 mod lint;
-pub(crate) use self::lint::RUN_LINTS;
+mod propagate_doc_cfg;
+mod propagate_stability;
+mod strip_aliased_non_local;
+mod strip_hidden;
+mod strip_priv_imports;
+mod strip_private;
 
 /// A single pass over the cleaned documentation.
 ///
@@ -51,7 +28,6 @@ pub(crate) use self::lint::RUN_LINTS;
 pub(crate) struct Pass {
     pub(crate) name: &'static str,
     pub(crate) run: Option<fn(clean::Crate, &mut DocContext<'_>) -> clean::Crate>,
-    pub(crate) description: &'static str,
 }
 
 /// In a list of passes, a pass that may or may not need to be run depending on options.
@@ -73,42 +49,26 @@ pub(crate) enum Condition {
     WhenNotDocumentHidden,
 }
 
-/// The full list of passes.
-pub(crate) const PASSES: &[Pass] = &[
-    CHECK_DOC_CFG,
-    CHECK_DOC_TEST_VISIBILITY,
-    PROPAGATE_DOC_CFG,
-    STRIP_ALIASED_NON_LOCAL,
-    STRIP_HIDDEN,
-    STRIP_PRIVATE,
-    STRIP_PRIV_IMPORTS,
-    PROPAGATE_STABILITY,
-    COLLECT_INTRA_DOC_LINKS,
-    COLLECT_TRAIT_IMPLS,
-    CALCULATE_DOC_COVERAGE,
-    RUN_LINTS,
-];
-
 /// The list of passes run by default.
-pub(crate) const DEFAULT_PASSES: &[ConditionalPass] = &[
-    ConditionalPass::always(COLLECT_TRAIT_IMPLS),
-    ConditionalPass::always(CHECK_DOC_TEST_VISIBILITY),
-    ConditionalPass::always(CHECK_DOC_CFG),
-    ConditionalPass::always(STRIP_ALIASED_NON_LOCAL),
-    ConditionalPass::always(PROPAGATE_DOC_CFG),
-    ConditionalPass::new(STRIP_HIDDEN, WhenNotDocumentHidden),
-    ConditionalPass::new(STRIP_PRIVATE, WhenNotDocumentPrivate),
-    ConditionalPass::new(STRIP_PRIV_IMPORTS, WhenDocumentPrivate),
-    ConditionalPass::always(COLLECT_INTRA_DOC_LINKS),
-    ConditionalPass::always(PROPAGATE_STABILITY),
-    ConditionalPass::always(RUN_LINTS),
+const DEFAULT_PASSES: &[ConditionalPass] = &[
+    ConditionalPass::always(collect_trait_impls::COLLECT_TRAIT_IMPLS),
+    ConditionalPass::always(check_doc_test_visibility::CHECK_DOC_TEST_VISIBILITY),
+    ConditionalPass::always(check_doc_cfg::CHECK_DOC_CFG),
+    ConditionalPass::always(strip_aliased_non_local::STRIP_ALIASED_NON_LOCAL),
+    ConditionalPass::always(propagate_doc_cfg::PROPAGATE_DOC_CFG),
+    ConditionalPass::new(strip_hidden::STRIP_HIDDEN, WhenNotDocumentHidden),
+    ConditionalPass::new(strip_private::STRIP_PRIVATE, WhenNotDocumentPrivate),
+    ConditionalPass::new(strip_priv_imports::STRIP_PRIV_IMPORTS, WhenDocumentPrivate),
+    ConditionalPass::always(collect_intra_doc_links::COLLECT_INTRA_DOC_LINKS),
+    ConditionalPass::always(propagate_stability::PROPAGATE_STABILITY),
+    ConditionalPass::always(lint::RUN_LINTS),
 ];
 
 /// The list of default passes run when `--doc-coverage` is passed to rustdoc.
-pub(crate) const COVERAGE_PASSES: &[ConditionalPass] = &[
-    ConditionalPass::new(STRIP_HIDDEN, WhenNotDocumentHidden),
-    ConditionalPass::new(STRIP_PRIVATE, WhenNotDocumentPrivate),
-    ConditionalPass::always(CALCULATE_DOC_COVERAGE),
+const COVERAGE_PASSES: &[ConditionalPass] = &[
+    ConditionalPass::new(strip_hidden::STRIP_HIDDEN, WhenNotDocumentHidden),
+    ConditionalPass::new(strip_private::STRIP_PRIVATE, WhenNotDocumentPrivate),
+    ConditionalPass::always(calculate_doc_coverage::CALCULATE_DOC_COVERAGE),
 ];
 
 impl ConditionalPass {

src/librustdoc/passes/propagate_doc_cfg.rs

@@ -1,4 +1,6 @@
-//! Propagates [`#[doc(cfg(...))]`](https://github.com/rust-lang/rust/issues/43781) to child items.
+//! Propagates `#[doc(cfg(…))]` ([RFC 3631]) to child items.
+//!
+//! [RFC 3631]: https://rust-lang.github.io/rfcs/3631-rustdoc-cfgs-handling.html
 
 use rustc_ast::token::{Token, TokenKind};
 use rustc_ast::tokenstream::{TokenStream, TokenTree};
@@ -11,11 +13,8 @@ use crate::core::DocContext;
 use crate::fold::DocFolder;
 use crate::passes::Pass;
 
-pub(crate) const PROPAGATE_DOC_CFG: Pass = Pass {
-    name: "propagate-doc-cfg",
-    run: Some(propagate_doc_cfg),
-    description: "propagates `#[doc(cfg(...))]` to child items",
-};
+pub(crate) const PROPAGATE_DOC_CFG: Pass =
+    Pass { name: "propagate-doc-cfg", run: Some(propagate_doc_cfg) };
 
 pub(crate) fn propagate_doc_cfg(cr: Crate, cx: &mut DocContext<'_>) -> Crate {
     if cx.tcx.features().doc_cfg() {

src/librustdoc/passes/propagate_stability.rs

@@ -14,11 +14,8 @@ use crate::core::DocContext;
 use crate::fold::DocFolder;
 use crate::passes::Pass;
 
-pub(crate) const PROPAGATE_STABILITY: Pass = Pass {
-    name: "propagate-stability",
-    run: Some(propagate_stability),
-    description: "propagates stability to child items",
-};
+pub(crate) const PROPAGATE_STABILITY: Pass =
+    Pass { name: "propagate-stability", run: Some(propagate_stability) };
 
 pub(crate) fn propagate_stability(cr: Crate, cx: &mut DocContext<'_>) -> Crate {
     let crate_stability = cx.tcx.lookup_stability(CRATE_DEF_ID);