src/librustdoc/lib.rs

   1 #![doc(
   2     html_root_url = "https://doc.rust-lang.org/nightly/",
   3     html_playground_url = "https://play.rust-lang.org/"
   4 )]
   5 #![feature(rustc_private)]
   6 #![feature(array_methods)]
   7 #![feature(assert_matches)]
   8 #![feature(box_patterns)]
   9 #![feature(control_flow_enum)]
  10 #![feature(drain_filter)]
  11 #![feature(let_chains)]
  12 #![feature(test)]
  13 #![feature(never_type)]
  14 #![feature(once_cell)]
  15 #![feature(type_ascription)]
  16 #![feature(iter_intersperse)]
  17 #![feature(type_alias_impl_trait)]
  18 #![recursion_limit = "256"]
  19 #![warn(rustc::internal)]
  20 #![allow(clippy::collapsible_if, clippy::collapsible_else_if)]
  21 #![allow(rustc::potential_query_instability)]
  22
  23 #[macro_use]
  24 extern crate tracing;
  25
  26 // N.B. these need `extern crate` even in 2018 edition
  27 // because they're loaded implicitly from the sysroot.
  28 // The reason they're loaded from the sysroot is because
  29 // the rustdoc artifacts aren't stored in rustc's cargo target directory.
  30 // So if `rustc` was specified in Cargo.toml, this would spuriously rebuild crates.
  31 //
  32 // Dependencies listed in Cargo.toml do not need `extern crate`.
  33
  34 extern crate rustc_ast;
  35 extern crate rustc_ast_pretty;
  36 extern crate rustc_attr;
  37 extern crate rustc_const_eval;
  38 extern crate rustc_data_structures;
  39 extern crate rustc_driver;
  40 extern crate rustc_errors;
  41 extern crate rustc_expand;
  42 extern crate rustc_feature;
  43 extern crate rustc_hir;
  44 extern crate rustc_hir_analysis;
  45 extern crate rustc_hir_pretty;
  46 extern crate rustc_index;
  47 extern crate rustc_infer;
  48 extern crate rustc_interface;
  49 extern crate rustc_lexer;
  50 extern crate rustc_lint;
  51 extern crate rustc_lint_defs;
  52 extern crate rustc_macros;
  53 extern crate rustc_metadata;
  54 extern crate rustc_middle;
  55 extern crate rustc_parse;
  56 extern crate rustc_passes;
  57 extern crate rustc_resolve;
  58 extern crate rustc_serialize;
  59 extern crate rustc_session;
  60 extern crate rustc_span;
  61 extern crate rustc_target;
  62 extern crate rustc_trait_selection;
  63 extern crate test;
  64
  65 // See docs in https://github.com/rust-lang/rust/blob/master/compiler/rustc/src/main.rs
  66 // about jemalloc.
  67 #[cfg(feature = "jemalloc")]
  68 extern crate jemalloc_sys;
  69
  70 use std::default::Default;
  71 use std::env::{self, VarError};
  72 use std::io;
  73 use std::process;
  74
  75 use rustc_driver::abort_on_err;
  76 use rustc_errors::ErrorGuaranteed;
  77 use rustc_interface::interface;
  78 use rustc_middle::ty::TyCtxt;
  79 use rustc_session::config::{make_crate_type_option, ErrorOutputType, RustcOptGroup};
  80 use rustc_session::getopts;
  81 use rustc_session::{early_error, early_warn};
  82
  83 use crate::clean::utils::DOC_RUST_LANG_ORG_CHANNEL;
  84 use crate::passes::collect_intra_doc_links;
  85
  86 /// A macro to create a FxHashMap.
  87 ///
  88 /// Example:
  89 ///
  90 /// ```ignore(cannot-test-this-because-non-exported-macro)
  91 /// let letters = map!{"a" => "b", "c" => "d"};
  92 /// ```
  93 ///
  94 /// Trailing commas are allowed.
  95 /// Commas between elements are required (even if the expression is a block).
  96 macro_rules! map {
  97     ($( $key: expr => $val: expr ),* $(,)*) => {{
  98         let mut map = ::rustc_data_structures::fx::FxHashMap::default();
  99         $( map.insert($key, $val); )*
 100         map
 101     }}
 102 }
 103
 104 mod clean;
 105 mod config;
 106 mod core;
 107 mod docfs;
 108 mod doctest;
 109 mod error;
 110 mod externalfiles;
 111 mod fold;
 112 mod formats;
 113 // used by the error-index generator, so it needs to be public
 114 pub mod html;
 115 mod json;
 116 pub(crate) mod lint;
 117 mod markdown;
 118 mod passes;
 119 mod scrape_examples;
 120 mod theme;
 121 mod visit;
 122 mod visit_ast;
 123 mod visit_lib;
 124
 125 pub fn main() {
 126     // See docs in https://github.com/rust-lang/rust/blob/master/compiler/rustc/src/main.rs
 127     // about jemalloc.
 128     #[cfg(feature = "jemalloc")]
 129     {
 130         use std::os::raw::{c_int, c_void};
 131
 132         #[used]
 133         static _F1: unsafe extern "C" fn(usize, usize) -> *mut c_void = jemalloc_sys::calloc;
 134         #[used]
 135         static _F2: unsafe extern "C" fn(*mut *mut c_void, usize, usize) -> c_int =
 136             jemalloc_sys::posix_memalign;
 137         #[used]
 138         static _F3: unsafe extern "C" fn(usize, usize) -> *mut c_void = jemalloc_sys::aligned_alloc;
 139         #[used]
 140         static _F4: unsafe extern "C" fn(usize) -> *mut c_void = jemalloc_sys::malloc;
 141         #[used]
 142         static _F5: unsafe extern "C" fn(*mut c_void, usize) -> *mut c_void = jemalloc_sys::realloc;
 143         #[used]
 144         static _F6: unsafe extern "C" fn(*mut c_void) = jemalloc_sys::free;
 145
 146         #[cfg(target_os = "macos")]
 147         {
 148             extern "C" {
 149                 fn _rjem_je_zone_register();
 150             }
 151
 152             #[used]
 153             static _F7: unsafe extern "C" fn() = _rjem_je_zone_register;
 154         }
 155     }
 156
 157     rustc_driver::set_sigpipe_handler();
 158     rustc_driver::install_ice_hook();
 159
 160     // When using CI artifacts (with `download_stage1 = true`), tracing is unconditionally built
 161     // with `--features=static_max_level_info`, which disables almost all rustdoc logging. To avoid
 162     // this, compile our own version of `tracing` that logs all levels.
 163     // NOTE: this compiles both versions of tracing unconditionally, because
 164     // - The compile time hit is not that bad, especially compared to rustdoc's incremental times, and
 165     // - Otherwise, there's no warning that logging is being ignored when `download_stage1 = true`.
 166     // NOTE: The reason this doesn't show double logging when `download_stage1 = false` and
 167     // `debug_logging = true` is because all rustc logging goes to its version of tracing (the one
 168     // in the sysroot), and all of rustdoc's logging goes to its version (the one in Cargo.toml).
 169     init_logging();
 170     rustc_driver::init_env_logger("RUSTDOC_LOG");
 171
 172     let exit_code = rustc_driver::catch_with_exit_code(|| match get_args() {
 173         Some(args) => main_args(&args),
 174         _ => Err(ErrorGuaranteed::unchecked_claim_error_was_emitted()),
 175     });
 176     process::exit(exit_code);
 177 }
 178
 179 fn init_logging() {
 180     let color_logs = match std::env::var("RUSTDOC_LOG_COLOR").as_deref() {
 181         Ok("always") => true,
 182         Ok("never") => false,
 183         Ok("auto") | Err(VarError::NotPresent) => atty::is(atty::Stream::Stdout),
 184         Ok(value) => early_error(
 185             ErrorOutputType::default(),
 186             &format!("invalid log color value '{}': expected one of always, never, or auto", value),
 187         ),
 188         Err(VarError::NotUnicode(value)) => early_error(
 189             ErrorOutputType::default(),
 190             &format!(
 191                 "invalid log color value '{}': expected one of always, never, or auto",
 192                 value.to_string_lossy()
 193             ),
 194         ),
 195     };
 196     let filter = tracing_subscriber::EnvFilter::from_env("RUSTDOC_LOG");
 197     let layer = tracing_tree::HierarchicalLayer::default()
 198         .with_writer(io::stderr)
 199         .with_indent_lines(true)
 200         .with_ansi(color_logs)
 201         .with_targets(true)
 202         .with_wraparound(10)
 203         .with_verbose_exit(true)
 204         .with_verbose_entry(true)
 205         .with_indent_amount(2);
 206     #[cfg(parallel_compiler)]
 207     let layer = layer.with_thread_ids(true).with_thread_names(true);
 208
 209     use tracing_subscriber::layer::SubscriberExt;
 210     let subscriber = tracing_subscriber::Registry::default().with(filter).with(layer);
 211     tracing::subscriber::set_global_default(subscriber).unwrap();
 212 }
 213
 214 fn get_args() -> Option<Vec<String>> {
 215     env::args_os()
 216         .enumerate()
 217         .map(|(i, arg)| {
 218             arg.into_string()
 219                 .map_err(|arg| {
 220                     early_warn(
 221                         ErrorOutputType::default(),
 222                         &format!("Argument {} is not valid Unicode: {:?}", i, arg),
 223                     );
 224                 })
 225                 .ok()
 226         })
 227         .collect()
 228 }
 229
 230 fn opts() -> Vec<RustcOptGroup> {
 231     let stable: fn(_, fn(&mut getopts::Options) -> &mut _) -> _ = RustcOptGroup::stable;
 232     let unstable: fn(_, fn(&mut getopts::Options) -> &mut _) -> _ = RustcOptGroup::unstable;
 233     vec![
 234         stable("h", |o| o.optflagmulti("h", "help", "show this help message")),
 235         stable("V", |o| o.optflagmulti("V", "version", "print rustdoc's version")),
 236         stable("v", |o| o.optflagmulti("v", "verbose", "use verbose output")),
 237         stable("w", |o| o.optopt("w", "output-format", "the output type to write", "[html]")),
 238         stable("output", |o| {
 239             o.optopt(
 240                 "",
 241                 "output",
 242                 "Which directory to place the output. \
 243                  This option is deprecated, use --out-dir instead.",
 244                 "PATH",
 245             )
 246         }),
 247         stable("o", |o| o.optopt("o", "out-dir", "which directory to place the output", "PATH")),
 248         stable("crate-name", |o| {
 249             o.optopt("", "crate-name", "specify the name of this crate", "NAME")
 250         }),
 251         make_crate_type_option(),
 252         stable("L", |o| {
 253             o.optmulti("L", "library-path", "directory to add to crate search path", "DIR")
 254         }),
 255         stable("cfg", |o| o.optmulti("", "cfg", "pass a --cfg to rustc", "")),
 256         unstable("check-cfg", |o| o.optmulti("", "check-cfg", "pass a --check-cfg to rustc", "")),
 257         stable("extern", |o| o.optmulti("", "extern", "pass an --extern to rustc", "NAME[=PATH]")),
 258         unstable("extern-html-root-url", |o| {
 259             o.optmulti(
 260                 "",
 261                 "extern-html-root-url",
 262                 "base URL to use for dependencies; for example, \
 263                  \"std=/doc\" links std::vec::Vec to /doc/std/vec/struct.Vec.html",
 264                 "NAME=URL",
 265             )
 266         }),
 267         unstable("extern-html-root-takes-precedence", |o| {
 268             o.optflagmulti(
 269                 "",
 270                 "extern-html-root-takes-precedence",
 271                 "give precedence to `--extern-html-root-url`, not `html_root_url`",
 272             )
 273         }),
 274         stable("C", |o| {
 275             o.optmulti("C", "codegen", "pass a codegen option to rustc", "OPT[=VALUE]")
 276         }),
 277         stable("document-private-items", |o| {
 278             o.optflagmulti("", "document-private-items", "document private items")
 279         }),
 280         unstable("document-hidden-items", |o| {
 281             o.optflagmulti("", "document-hidden-items", "document items that have doc(hidden)")
 282         }),
 283         stable("test", |o| o.optflagmulti("", "test", "run code examples as tests")),
 284         stable("test-args", |o| {
 285             o.optmulti("", "test-args", "arguments to pass to the test runner", "ARGS")
 286         }),
 287         unstable("test-run-directory", |o| {
 288             o.optopt(
 289                 "",
 290                 "test-run-directory",
 291                 "The working directory in which to run tests",
 292                 "PATH",
 293             )
 294         }),
 295         stable("target", |o| o.optopt("", "target", "target triple to document", "TRIPLE")),
 296         stable("markdown-css", |o| {
 297             o.optmulti(
 298                 "",
 299                 "markdown-css",
 300                 "CSS files to include via <link> in a rendered Markdown file",
 301                 "FILES",
 302             )
 303         }),
 304         stable("html-in-header", |o| {
 305             o.optmulti(
 306                 "",
 307                 "html-in-header",
 308                 "files to include inline in the <head> section of a rendered Markdown file \
 309                  or generated documentation",
 310                 "FILES",
 311             )
 312         }),
 313         stable("html-before-content", |o| {
 314             o.optmulti(
 315                 "",
 316                 "html-before-content",
 317                 "files to include inline between <body> and the content of a rendered \
 318                  Markdown file or generated documentation",
 319                 "FILES",
 320             )
 321         }),
 322         stable("html-after-content", |o| {
 323             o.optmulti(
 324                 "",
 325                 "html-after-content",
 326                 "files to include inline between the content and </body> of a rendered \
 327                  Markdown file or generated documentation",
 328                 "FILES",
 329             )
 330         }),
 331         unstable("markdown-before-content", |o| {
 332             o.optmulti(
 333                 "",
 334                 "markdown-before-content",
 335                 "files to include inline between <body> and the content of a rendered \
 336                  Markdown file or generated documentation",
 337                 "FILES",
 338             )
 339         }),
 340         unstable("markdown-after-content", |o| {
 341             o.optmulti(
 342                 "",
 343                 "markdown-after-content",
 344                 "files to include inline between the content and </body> of a rendered \
 345                  Markdown file or generated documentation",
 346                 "FILES",
 347             )
 348         }),
 349         stable("markdown-playground-url", |o| {
 350             o.optopt("", "markdown-playground-url", "URL to send code snippets to", "URL")
 351         }),
 352         stable("markdown-no-toc", |o| {
 353             o.optflagmulti("", "markdown-no-toc", "don't include table of contents")
 354         }),
 355         stable("e", |o| {
 356             o.optopt(
 357                 "e",
 358                 "extend-css",
 359                 "To add some CSS rules with a given file to generate doc with your \
 360                  own theme. However, your theme might break if the rustdoc's generated HTML \
 361                  changes, so be careful!",
 362                 "PATH",
 363             )
 364         }),
 365         unstable("Z", |o| {
 366             o.optmulti("Z", "", "unstable / perma-unstable options (only on nightly build)", "FLAG")
 367         }),
 368         stable("sysroot", |o| o.optopt("", "sysroot", "Override the system root", "PATH")),
 369         unstable("playground-url", |o| {
 370             o.optopt(
 371                 "",
 372                 "playground-url",
 373                 "URL to send code snippets to, may be reset by --markdown-playground-url \
 374                  or `#![doc(html_playground_url=...)]`",
 375                 "URL",
 376             )
 377         }),
 378         unstable("display-doctest-warnings", |o| {
 379             o.optflagmulti(
 380                 "",
 381                 "display-doctest-warnings",
 382                 "show warnings that originate in doctests",
 383             )
 384         }),
 385         stable("crate-version", |o| {
 386             o.optopt("", "crate-version", "crate version to print into documentation", "VERSION")
 387         }),
 388         unstable("sort-modules-by-appearance", |o| {
 389             o.optflagmulti(
 390                 "",
 391                 "sort-modules-by-appearance",
 392                 "sort modules by where they appear in the program, rather than alphabetically",
 393             )
 394         }),
 395         stable("default-theme", |o| {
 396             o.optopt(
 397                 "",
 398                 "default-theme",
 399                 "Set the default theme. THEME should be the theme name, generally lowercase. \
 400                  If an unknown default theme is specified, the builtin default is used. \
 401                  The set of themes, and the rustdoc built-in default, are not stable.",
 402                 "THEME",
 403             )
 404         }),
 405         unstable("default-setting", |o| {
 406             o.optmulti(
 407                 "",
 408                 "default-setting",
 409                 "Default value for a rustdoc setting (used when \"rustdoc-SETTING\" is absent \
 410                  from web browser Local Storage). If VALUE is not supplied, \"true\" is used. \
 411                  Supported SETTINGs and VALUEs are not documented and not stable.",
 412                 "SETTING[=VALUE]",
 413             )
 414         }),
 415         stable("theme", |o| {
 416             o.optmulti(
 417                 "",
 418                 "theme",
 419                 "additional themes which will be added to the generated docs",
 420                 "FILES",
 421             )
 422         }),
 423         stable("check-theme", |o| {
 424             o.optmulti("", "check-theme", "check if given theme is valid", "FILES")
 425         }),
 426         unstable("resource-suffix", |o| {
 427             o.optopt(
 428                 "",
 429                 "resource-suffix",
 430                 "suffix to add to CSS and JavaScript files, e.g., \"light.css\" will become \
 431                  \"light-suffix.css\"",
 432                 "PATH",
 433             )
 434         }),
 435         stable("edition", |o| {
 436             o.optopt(
 437                 "",
 438                 "edition",
 439                 "edition to use when compiling rust code (default: 2015)",
 440                 "EDITION",
 441             )
 442         }),
 443         stable("color", |o| {
 444             o.optopt(
 445                 "",
 446                 "color",
 447                 "Configure coloring of output:
 448                                           auto   = colorize, if output goes to a tty (default);
 449                                           always = always colorize output;
 450                                           never  = never colorize output",
 451                 "auto|always|never",
 452             )
 453         }),
 454         stable("error-format", |o| {
 455             o.optopt(
 456                 "",
 457                 "error-format",
 458                 "How errors and other messages are produced",
 459                 "human|json|short",
 460             )
 461         }),
 462         stable("diagnostic-width", |o| {
 463             o.optopt(
 464                 "",
 465                 "diagnostic-width",
 466                 "Provide width of the output for truncated error messages",
 467                 "WIDTH",
 468             )
 469         }),
 470         stable("json", |o| {
 471             o.optopt("", "json", "Configure the structure of JSON diagnostics", "CONFIG")
 472         }),
 473         unstable("disable-minification", |o| {
 474             o.optflagmulti("", "disable-minification", "Disable minification applied on JS files")
 475         }),
 476         stable("allow", |o| o.optmulti("A", "allow", "Set lint allowed", "LINT")),
 477         stable("warn", |o| o.optmulti("W", "warn", "Set lint warnings", "LINT")),
 478         stable("force-warn", |o| o.optmulti("", "force-warn", "Set lint force-warn", "LINT")),
 479         stable("deny", |o| o.optmulti("D", "deny", "Set lint denied", "LINT")),
 480         stable("forbid", |o| o.optmulti("F", "forbid", "Set lint forbidden", "LINT")),
 481         stable("cap-lints", |o| {
 482             o.optmulti(
 483                 "",
 484                 "cap-lints",
 485                 "Set the most restrictive lint level. \
 486                  More restrictive lints are capped at this \
 487                  level. By default, it is at `forbid` level.",
 488                 "LEVEL",
 489             )
 490         }),
 491         unstable("index-page", |o| {
 492             o.optopt("", "index-page", "Markdown file to be used as index page", "PATH")
 493         }),
 494         unstable("enable-index-page", |o| {
 495             o.optflagmulti("", "enable-index-page", "To enable generation of the index page")
 496         }),
 497         unstable("static-root-path", |o| {
 498             o.optopt(
 499                 "",
 500                 "static-root-path",
 501                 "Path string to force loading static files from in output pages. \
 502                  If not set, uses combinations of '../' to reach the documentation root.",
 503                 "PATH",
 504             )
 505         }),
 506         unstable("disable-per-crate-search", |o| {
 507             o.optflagmulti(
 508                 "",
 509                 "disable-per-crate-search",
 510                 "disables generating the crate selector on the search box",
 511             )
 512         }),
 513         unstable("persist-doctests", |o| {
 514             o.optopt(
 515                 "",
 516                 "persist-doctests",
 517                 "Directory to persist doctest executables into",
 518                 "PATH",
 519             )
 520         }),
 521         unstable("show-coverage", |o| {
 522             o.optflagmulti(
 523                 "",
 524                 "show-coverage",
 525                 "calculate percentage of public items with documentation",
 526             )
 527         }),
 528         unstable("enable-per-target-ignores", |o| {
 529             o.optflagmulti(
 530                 "",
 531                 "enable-per-target-ignores",
 532                 "parse ignore-foo for ignoring doctests on a per-target basis",
 533             )
 534         }),
 535         unstable("runtool", |o| {
 536             o.optopt(
 537                 "",
 538                 "runtool",
 539                 "",
 540                 "The tool to run tests with when building for a different target than host",
 541             )
 542         }),
 543         unstable("runtool-arg", |o| {
 544             o.optmulti(
 545                 "",
 546                 "runtool-arg",
 547                 "",
 548                 "One (of possibly many) arguments to pass to the runtool",
 549             )
 550         }),
 551         unstable("test-builder", |o| {
 552             o.optopt("", "test-builder", "The rustc-like binary to use as the test builder", "PATH")
 553         }),
 554         unstable("check", |o| o.optflagmulti("", "check", "Run rustdoc checks")),
 555         unstable("generate-redirect-map", |o| {
 556             o.optflagmulti(
 557                 "",
 558                 "generate-redirect-map",
 559                 "Generate JSON file at the top level instead of generating HTML redirection files",
 560             )
 561         }),
 562         unstable("emit", |o| {
 563             o.optmulti(
 564                 "",
 565                 "emit",
 566                 "Comma separated list of types of output for rustdoc to emit",
 567                 "[unversioned-shared-resources,toolchain-shared-resources,invocation-specific]",
 568             )
 569         }),
 570         unstable("no-run", |o| {
 571             o.optflagmulti("", "no-run", "Compile doctests without running them")
 572         }),
 573         unstable("show-type-layout", |o| {
 574             o.optflagmulti("", "show-type-layout", "Include the memory layout of types in the docs")
 575         }),
 576         unstable("nocapture", |o| {
 577             o.optflag("", "nocapture", "Don't capture stdout and stderr of tests")
 578         }),
 579         unstable("generate-link-to-definition", |o| {
 580             o.optflag(
 581                 "",
 582                 "generate-link-to-definition",
 583                 "Make the identifiers in the HTML source code pages navigable",
 584             )
 585         }),
 586         unstable("scrape-examples-output-path", |o| {
 587             o.optopt(
 588                 "",
 589                 "scrape-examples-output-path",
 590                 "",
 591                 "collect function call information and output at the given path",
 592             )
 593         }),
 594         unstable("scrape-examples-target-crate", |o| {
 595             o.optmulti(
 596                 "",
 597                 "scrape-examples-target-crate",
 598                 "",
 599                 "collect function call information for functions from the target crate",
 600             )
 601         }),
 602         unstable("scrape-tests", |o| {
 603             o.optflag("", "scrape-tests", "Include test code when scraping examples")
 604         }),
 605         unstable("with-examples", |o| {
 606             o.optmulti(
 607                 "",
 608                 "with-examples",
 609                 "",
 610                 "path to function call information (for displaying examples in the documentation)",
 611             )
 612         }),
 613         // deprecated / removed options
 614         stable("plugin-path", |o| {
 615             o.optmulti(
 616                 "",
 617                 "plugin-path",
 618                 "removed, see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
 619                 for more information",
 620                 "DIR",
 621             )
 622         }),
 623         stable("passes", |o| {
 624             o.optmulti(
 625                 "",
 626                 "passes",
 627                 "removed, see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
 628                 for more information",
 629                 "PASSES",
 630             )
 631         }),
 632         stable("plugins", |o| {
 633             o.optmulti(
 634                 "",
 635                 "plugins",
 636                 "removed, see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
 637                 for more information",
 638                 "PLUGINS",
 639             )
 640         }),
 641         stable("no-default", |o| {
 642             o.optflagmulti(
 643                 "",
 644                 "no-defaults",
 645                 "removed, see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
 646                 for more information",
 647             )
 648         }),
 649         stable("r", |o| {
 650             o.optopt(
 651                 "r",
 652                 "input-format",
 653                 "removed, see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
 654                 for more information",
 655                 "[rust]",
 656             )
 657         }),
 658     ]
 659 }
 660
 661 fn usage(argv0: &str) {
 662     let mut options = getopts::Options::new();
 663     for option in opts() {
 664         (option.apply)(&mut options);
 665     }
 666     println!("{}", options.usage(&format!("{} [options] <input>", argv0)));
 667     println!("    @path               Read newline separated options from `path`\n");
 668     println!(
 669         "More information available at {}/rustdoc/what-is-rustdoc.html",
 670         DOC_RUST_LANG_ORG_CHANNEL
 671     );
 672 }
 673
 674 /// A result type used by several functions under `main()`.
 675 type MainResult = Result<(), ErrorGuaranteed>;
 676
 677 fn main_args(at_args: &[String]) -> MainResult {
 678     let args = rustc_driver::args::arg_expand_all(at_args);
 679
 680     let mut options = getopts::Options::new();
 681     for option in opts() {
 682         (option.apply)(&mut options);
 683     }
 684     let matches = match options.parse(&args[1..]) {
 685         Ok(m) => m,
 686         Err(err) => {
 687             early_error(ErrorOutputType::default(), &err.to_string());
 688         }
 689     };
 690
 691     // Note that we discard any distinction between different non-zero exit
 692     // codes from `from_matches` here.
 693     let options = match config::Options::from_matches(&matches, args) {
 694         Ok(opts) => opts,
 695         Err(code) => {
 696             return if code == 0 {
 697                 Ok(())
 698             } else {
 699                 Err(ErrorGuaranteed::unchecked_claim_error_was_emitted())
 700             };
 701         }
 702     };
 703     rustc_interface::util::run_in_thread_pool_with_globals(
 704         options.edition,
 705         1, // this runs single-threaded, even in a parallel compiler
 706         move || main_options(options),
 707     )
 708 }
 709
 710 fn wrap_return(diag: &rustc_errors::Handler, res: Result<(), String>) -> MainResult {
 711     match res {
 712         Ok(()) => Ok(()),
 713         Err(err) => {
 714             let reported = diag.struct_err(&err).emit();
 715             Err(reported)
 716         }
 717     }
 718 }
 719
 720 fn run_renderer<'tcx, T: formats::FormatRenderer<'tcx>>(
 721     krate: clean::Crate,
 722     renderopts: config::RenderOptions,
 723     cache: formats::cache::Cache,
 724     tcx: TyCtxt<'tcx>,
 725 ) -> MainResult {
 726     match formats::run_format::<T>(krate, renderopts, cache, tcx) {
 727         Ok(_) => Ok(()),
 728         Err(e) => {
 729             let mut msg =
 730                 tcx.sess.struct_err(&format!("couldn't generate documentation: {}", e.error));
 731             let file = e.file.display().to_string();
 732             if !file.is_empty() {
 733                 msg.note(&format!("failed to create or modify \"{}\"", file));
 734             }
 735             Err(msg.emit())
 736         }
 737     }
 738 }
 739
 740 fn main_options(options: config::Options) -> MainResult {
 741     let diag = core::new_handler(
 742         options.error_format,
 743         None,
 744         options.diagnostic_width,
 745         &options.unstable_opts,
 746     );
 747
 748     match (options.should_test, options.markdown_input()) {
 749         (true, true) => return wrap_return(&diag, markdown::test(options)),
 750         (true, false) => return doctest::run(options),
 751         (false, true) => {
 752             return wrap_return(
 753                 &diag,
 754                 markdown::render(&options.input, options.render_options, options.edition),
 755             );
 756         }
 757         (false, false) => {}
 758     }
 759
 760     // need to move these items separately because we lose them by the time the closure is called,
 761     // but we can't create the Handler ahead of time because it's not Send
 762     let show_coverage = options.show_coverage;
 763     let run_check = options.run_check;
 764
 765     // First, parse the crate and extract all relevant information.
 766     info!("starting to run rustc");
 767
 768     // Interpret the input file as a rust source file, passing it through the
 769     // compiler all the way through the analysis passes. The rustdoc output is
 770     // then generated from the cleaned AST of the crate. This runs all the
 771     // plug/cleaning passes.
 772     let crate_version = options.crate_version.clone();
 773
 774     let output_format = options.output_format;
 775     // FIXME: fix this clone (especially render_options)
 776     let externs = options.externs.clone();
 777     let render_options = options.render_options.clone();
 778     let scrape_examples_options = options.scrape_examples_options.clone();
 779     let document_private = options.render_options.document_private;
 780     let config = core::create_config(options);
 781
 782     interface::create_compiler_and_run(config, |compiler| {
 783         let sess = compiler.session();
 784
 785         if sess.opts.describe_lints {
 786             let mut lint_store = rustc_lint::new_lint_store(
 787                 sess.opts.unstable_opts.no_interleave_lints,
 788                 sess.enable_internal_lints(),
 789             );
 790             let registered_lints = if let Some(register_lints) = compiler.register_lints() {
 791                 register_lints(sess, &mut lint_store);
 792                 true
 793             } else {
 794                 false
 795             };
 796             rustc_driver::describe_lints(sess, &lint_store, registered_lints);
 797             return Ok(());
 798         }
 799
 800         compiler.enter(|queries| {
 801             // We need to hold on to the complete resolver, so we cause everything to be
 802             // cloned for the analysis passes to use. Suboptimal, but necessary in the
 803             // current architecture.
 804             // FIXME(#83761): Resolver cloning can lead to inconsistencies between data in the
 805             // two copies because one of the copies can be modified after `TyCtxt` construction.
 806             let (resolver, resolver_caches) = {
 807                 let (krate, resolver, _) = &*abort_on_err(queries.expansion(), sess).peek();
 808                 let resolver_caches = resolver.borrow_mut().access(|resolver| {
 809                     collect_intra_doc_links::early_resolve_intra_doc_links(
 810                         resolver,
 811                         sess,
 812                         krate,
 813                         externs,
 814                         document_private,
 815                     )
 816                 });
 817                 (resolver.clone(), resolver_caches)
 818             };
 819
 820             if sess.diagnostic().has_errors_or_lint_errors().is_some() {
 821                 sess.fatal("Compilation failed, aborting rustdoc");
 822             }
 823
 824             let mut global_ctxt = abort_on_err(queries.global_ctxt(), sess).peek_mut();
 825
 826             global_ctxt.enter(|tcx| {
 827                 let (krate, render_opts, mut cache) = sess.time("run_global_ctxt", || {
 828                     core::run_global_ctxt(
 829                         tcx,
 830                         resolver,
 831                         resolver_caches,
 832                         show_coverage,
 833                         render_options,
 834                         output_format,
 835                     )
 836                 });
 837                 info!("finished with rustc");
 838
 839                 if let Some(options) = scrape_examples_options {
 840                     return scrape_examples::run(krate, render_opts, cache, tcx, options);
 841                 }
 842
 843                 cache.crate_version = crate_version;
 844
 845                 if show_coverage {
 846                     // if we ran coverage, bail early, we don't need to also generate docs at this point
 847                     // (also we didn't load in any of the useful passes)
 848                     return Ok(());
 849                 } else if run_check {
 850                     // Since we're in "check" mode, no need to generate anything beyond this point.
 851                     return Ok(());
 852                 }
 853
 854                 info!("going to format");
 855                 match output_format {
 856                     config::OutputFormat::Html => sess.time("render_html", || {
 857                         run_renderer::<html::render::Context<'_>>(krate, render_opts, cache, tcx)
 858                     }),
 859                     config::OutputFormat::Json => sess.time("render_json", || {
 860                         run_renderer::<json::JsonRenderer<'_>>(krate, render_opts, cache, tcx)
 861                     }),
 862                 }
 863             })
 864         })
 865     })
 866 }