1 use std
::collections
::BTreeMap
;
2 use std
::convert
::TryFrom
;
5 use std
::path
::PathBuf
;
8 use rustc_data_structures
::fx
::FxHashMap
;
9 use rustc_driver
::print_flag_list
;
10 use rustc_session
::config
::{
11 self, parse_crate_types_from_list
, parse_externs
, parse_target_triple
, CrateType
,
13 use rustc_session
::config
::{get_cmd_lint_options, nightly_options}
;
14 use rustc_session
::config
::{
15 CodegenOptions
, ErrorOutputType
, Externs
, JsonUnusedExterns
, UnstableOptions
,
17 use rustc_session
::getopts
;
18 use rustc_session
::lint
::Level
;
19 use rustc_session
::search_paths
::SearchPath
;
20 use rustc_span
::edition
::Edition
;
21 use rustc_target
::spec
::TargetTriple
;
23 use crate::core
::new_handler
;
24 use crate::externalfiles
::ExternalHtml
;
26 use crate::html
::markdown
::IdMap
;
27 use crate::html
::render
::StylePath
;
28 use crate::html
::static_files
;
30 use crate::passes
::{self, Condition}
;
31 use crate::scrape_examples
::{AllCallLocations, ScrapeExamplesOptions}
;
34 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
35 pub(crate) enum OutputFormat
{
40 impl Default
for OutputFormat
{
41 fn default() -> OutputFormat
{
47 pub(crate) fn is_json(&self) -> bool
{
48 matches
!(self, OutputFormat
::Json
)
52 impl TryFrom
<&str> for OutputFormat
{
55 fn try_from(value
: &str) -> Result
<Self, Self::Error
> {
57 "json" => Ok(OutputFormat
::Json
),
58 "html" => Ok(OutputFormat
::Html
),
59 _
=> Err(format
!("unknown output format `{}`", value
)),
64 /// Configuration options for rustdoc.
66 pub(crate) struct Options
{
67 // Basic options / Options passed directly to rustc
68 /// The crate root or Markdown file to load.
69 pub(crate) input
: PathBuf
,
70 /// The name of the crate being documented.
71 pub(crate) crate_name
: Option
<String
>,
72 /// Whether or not this is a proc-macro crate
73 pub(crate) proc_macro_crate
: bool
,
74 /// How to format errors and warnings.
75 pub(crate) error_format
: ErrorOutputType
,
76 /// Width of output buffer to truncate errors appropriately.
77 pub(crate) diagnostic_width
: Option
<usize>,
78 /// Library search paths to hand to the compiler.
79 pub(crate) libs
: Vec
<SearchPath
>,
80 /// Library search paths strings to hand to the compiler.
81 pub(crate) lib_strs
: Vec
<String
>,
82 /// The list of external crates to link against.
83 pub(crate) externs
: Externs
,
84 /// The list of external crates strings to link against.
85 pub(crate) extern_strs
: Vec
<String
>,
86 /// List of `cfg` flags to hand to the compiler. Always includes `rustdoc`.
87 pub(crate) cfgs
: Vec
<String
>,
88 /// List of check cfg flags to hand to the compiler.
89 pub(crate) check_cfgs
: Vec
<String
>,
90 /// Codegen options to hand to the compiler.
91 pub(crate) codegen_options
: CodegenOptions
,
92 /// Codegen options strings to hand to the compiler.
93 pub(crate) codegen_options_strs
: Vec
<String
>,
94 /// Unstable (`-Z`) options to pass to the compiler.
95 pub(crate) unstable_opts
: UnstableOptions
,
96 /// Unstable (`-Z`) options strings to pass to the compiler.
97 pub(crate) unstable_opts_strs
: Vec
<String
>,
98 /// The target used to compile the crate against.
99 pub(crate) target
: TargetTriple
,
100 /// Edition used when reading the crate. Defaults to "2015". Also used by default when
101 /// compiling doctests from the crate.
102 pub(crate) edition
: Edition
,
103 /// The path to the sysroot. Used during the compilation process.
104 pub(crate) maybe_sysroot
: Option
<PathBuf
>,
105 /// Lint information passed over the command-line.
106 pub(crate) lint_opts
: Vec
<(String
, Level
)>,
107 /// Whether to ask rustc to describe the lints it knows.
108 pub(crate) describe_lints
: bool
,
109 /// What level to cap lints at.
110 pub(crate) lint_cap
: Option
<Level
>,
112 // Options specific to running doctests
113 /// Whether we should run doctests instead of generating docs.
114 pub(crate) should_test
: bool
,
115 /// List of arguments to pass to the test harness, if running tests.
116 pub(crate) test_args
: Vec
<String
>,
117 /// The working directory in which to run tests.
118 pub(crate) test_run_directory
: Option
<PathBuf
>,
119 /// Optional path to persist the doctest executables to, defaults to a
120 /// temporary directory if not set.
121 pub(crate) persist_doctests
: Option
<PathBuf
>,
122 /// Runtool to run doctests with
123 pub(crate) runtool
: Option
<String
>,
124 /// Arguments to pass to the runtool
125 pub(crate) runtool_args
: Vec
<String
>,
126 /// Whether to allow ignoring doctests on a per-target basis
127 /// For example, using ignore-foo to ignore running the doctest on any target that
128 /// contains "foo" as a substring
129 pub(crate) enable_per_target_ignores
: bool
,
130 /// Do not run doctests, compile them if should_test is active.
131 pub(crate) no_run
: bool
,
133 /// The path to a rustc-like binary to build tests with. If not set, we
134 /// default to loading from `$sysroot/bin/rustc`.
135 pub(crate) test_builder
: Option
<PathBuf
>,
137 // Options that affect the documentation process
138 /// Whether to run the `calculate-doc-coverage` pass, which counts the number of public items
139 /// with and without documentation.
140 pub(crate) show_coverage
: bool
,
142 // Options that alter generated documentation pages
143 /// Crate version to note on the sidebar of generated docs.
144 pub(crate) crate_version
: Option
<String
>,
145 /// The format that we output when rendering.
147 /// Currently used only for the `--show-coverage` option.
148 pub(crate) output_format
: OutputFormat
,
149 /// If this option is set to `true`, rustdoc will only run checks and not generate
151 pub(crate) run_check
: bool
,
152 /// Whether doctests should emit unused externs
153 pub(crate) json_unused_externs
: JsonUnusedExterns
,
154 /// Whether to skip capturing stdout and stderr of tests.
155 pub(crate) nocapture
: bool
,
157 /// Configuration for scraping examples from the current crate. If this option is Some(..) then
158 /// the compiler will scrape examples and not generate documentation.
159 pub(crate) scrape_examples_options
: Option
<ScrapeExamplesOptions
>,
161 /// Note: this field is duplicated in `RenderOptions` because it's useful
162 /// to have it in both places.
163 pub(crate) unstable_features
: rustc_feature
::UnstableFeatures
,
166 impl fmt
::Debug
for Options
{
167 fn fmt(&self, f
: &mut fmt
::Formatter
<'_
>) -> fmt
::Result
{
168 struct FmtExterns
<'a
>(&'a Externs
);
170 impl<'a
> fmt
::Debug
for FmtExterns
<'a
> {
171 fn fmt(&self, f
: &mut fmt
::Formatter
<'_
>) -> fmt
::Result
{
172 f
.debug_map().entries(self.0.iter
()).finish()
176 f
.debug_struct("Options")
177 .field("input", &self.input
)
178 .field("crate_name", &self.crate_name
)
179 .field("proc_macro_crate", &self.proc_macro_crate
)
180 .field("error_format", &self.error_format
)
181 .field("libs", &self.libs
)
182 .field("externs", &FmtExterns(&self.externs
))
183 .field("cfgs", &self.cfgs
)
184 .field("check-cfgs", &self.check_cfgs
)
185 .field("codegen_options", &"...")
186 .field("unstable_options", &"...")
187 .field("target", &self.target
)
188 .field("edition", &self.edition
)
189 .field("maybe_sysroot", &self.maybe_sysroot
)
190 .field("lint_opts", &self.lint_opts
)
191 .field("describe_lints", &self.describe_lints
)
192 .field("lint_cap", &self.lint_cap
)
193 .field("should_test", &self.should_test
)
194 .field("test_args", &self.test_args
)
195 .field("test_run_directory", &self.test_run_directory
)
196 .field("persist_doctests", &self.persist_doctests
)
197 .field("show_coverage", &self.show_coverage
)
198 .field("crate_version", &self.crate_version
)
199 .field("runtool", &self.runtool
)
200 .field("runtool_args", &self.runtool_args
)
201 .field("enable-per-target-ignores", &self.enable_per_target_ignores
)
202 .field("run_check", &self.run_check
)
203 .field("no_run", &self.no_run
)
204 .field("nocapture", &self.nocapture
)
205 .field("scrape_examples_options", &self.scrape_examples_options
)
206 .field("unstable_features", &self.unstable_features
)
211 /// Configuration options for the HTML page-creation process.
212 #[derive(Clone, Debug)]
213 pub(crate) struct RenderOptions
{
214 /// Output directory to generate docs into. Defaults to `doc`.
215 pub(crate) output
: PathBuf
,
216 /// External files to insert into generated pages.
217 pub(crate) external_html
: ExternalHtml
,
218 /// A pre-populated `IdMap` with the default headings and any headings added by Markdown files
219 /// processed by `external_html`.
220 pub(crate) id_map
: IdMap
,
221 /// If present, playground URL to use in the "Run" button added to code samples.
223 /// Be aware: This option can come both from the CLI and from crate attributes!
224 pub(crate) playground_url
: Option
<String
>,
225 /// What sorting mode to use for module pages.
226 /// `ModuleSorting::Alphabetical` by default.
227 pub(crate) module_sorting
: ModuleSorting
,
228 /// List of themes to extend the docs with. Original argument name is included to assist in
229 /// displaying errors if it fails a theme check.
230 pub(crate) themes
: Vec
<StylePath
>,
231 /// If present, CSS file that contains rules to add to the default CSS.
232 pub(crate) extension_css
: Option
<PathBuf
>,
233 /// A map of crate names to the URL to use instead of querying the crate's `html_root_url`.
234 pub(crate) extern_html_root_urls
: BTreeMap
<String
, String
>,
235 /// Whether to give precedence to `html_root_url` or `--exten-html-root-url`.
236 pub(crate) extern_html_root_takes_precedence
: bool
,
237 /// A map of the default settings (values are as for DOM storage API). Keys should lack the
238 /// `rustdoc-` prefix.
239 pub(crate) default_settings
: FxHashMap
<String
, String
>,
240 /// If present, suffix added to CSS/JavaScript files when referencing them in generated pages.
241 pub(crate) resource_suffix
: String
,
242 /// Whether to run the static CSS/JavaScript through a minifier when outputting them. `true` by
244 pub(crate) enable_minification
: bool
,
245 /// Whether to create an index page in the root of the output directory. If this is true but
246 /// `enable_index_page` is None, generate a static listing of crates instead.
247 pub(crate) enable_index_page
: bool
,
248 /// A file to use as the index page at the root of the output directory. Overrides
249 /// `enable_index_page` to be true if set.
250 pub(crate) index_page
: Option
<PathBuf
>,
251 /// An optional path to use as the location of static files. If not set, uses combinations of
252 /// `../` to reach the documentation root.
253 pub(crate) static_root_path
: Option
<String
>,
255 // Options specific to reading standalone Markdown files
256 /// Whether to generate a table of contents on the output file when reading a standalone
258 pub(crate) markdown_no_toc
: bool
,
259 /// Additional CSS files to link in pages generated from standalone Markdown files.
260 pub(crate) markdown_css
: Vec
<String
>,
261 /// If present, playground URL to use in the "Run" button added to code samples generated from
262 /// standalone Markdown files. If not present, `playground_url` is used.
263 pub(crate) markdown_playground_url
: Option
<String
>,
264 /// Document items that have lower than `pub` visibility.
265 pub(crate) document_private
: bool
,
266 /// Document items that have `doc(hidden)`.
267 pub(crate) document_hidden
: bool
,
268 /// If `true`, generate a JSON file in the crate folder instead of HTML redirection files.
269 pub(crate) generate_redirect_map
: bool
,
270 /// Show the memory layout of types in the docs.
271 pub(crate) show_type_layout
: bool
,
272 /// Note: this field is duplicated in `Options` because it's useful to have
273 /// it in both places.
274 pub(crate) unstable_features
: rustc_feature
::UnstableFeatures
,
275 pub(crate) emit
: Vec
<EmitType
>,
276 /// If `true`, HTML source pages will generate links for items to their definition.
277 pub(crate) generate_link_to_definition
: bool
,
278 /// Set of function-call locations to include as examples
279 pub(crate) call_locations
: AllCallLocations
,
280 /// If `true`, Context::init will not emit shared files.
281 pub(crate) no_emit_shared
: bool
,
284 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
285 pub(crate) enum ModuleSorting
{
290 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
291 pub(crate) enum EmitType
{
297 impl FromStr
for EmitType
{
300 fn from_str(s
: &str) -> Result
<Self, Self::Err
> {
303 "unversioned-shared-resources" => Ok(Unversioned
),
304 "toolchain-shared-resources" => Ok(Toolchain
),
305 "invocation-specific" => Ok(InvocationSpecific
),
312 pub(crate) fn should_emit_crate(&self) -> bool
{
313 self.emit
.is_empty() || self.emit
.contains(&EmitType
::InvocationSpecific
)
318 /// Parses the given command-line for options. If an error message or other early-return has
319 /// been printed, returns `Err` with the exit code.
320 pub(crate) fn from_matches(
321 matches
: &getopts
::Matches
,
323 ) -> Result
<(Options
, RenderOptions
), i32> {
324 let args
= &args
[1..];
325 // Check for unstable options.
326 nightly_options
::check_nightly_options(matches
, &opts());
328 if args
.is_empty() || matches
.opt_present("h") || matches
.opt_present("help") {
329 crate::usage("rustdoc");
331 } else if matches
.opt_present("version") {
332 rustc_driver
::version("rustdoc", matches
);
336 let z_flags
= matches
.opt_strs("Z");
337 if z_flags
.iter().any(|x
| *x
== "help") {
338 print_flag_list("-Z", config
::Z_OPTIONS
);
341 let c_flags
= matches
.opt_strs("C");
342 if c_flags
.iter().any(|x
| *x
== "help") {
343 print_flag_list("-C", config
::CG_OPTIONS
);
347 let color
= config
::parse_color(matches
);
348 let config
::JsonConfig { json_rendered, json_unused_externs, .. }
=
349 config
::parse_json(matches
);
350 let error_format
= config
::parse_error_format(matches
, color
, json_rendered
);
351 let diagnostic_width
= matches
.opt_get("diagnostic-width").unwrap_or_default();
353 let codegen_options
= CodegenOptions
::build(matches
, error_format
);
354 let unstable_opts
= UnstableOptions
::build(matches
, error_format
);
356 let diag
= new_handler(error_format
, None
, diagnostic_width
, &unstable_opts
);
358 // check for deprecated options
359 check_deprecated_options(matches
, &diag
);
361 if matches
.opt_strs("passes") == ["list"] {
362 println
!("Available passes for running rustdoc:");
363 for pass
in passes
::PASSES
{
364 println
!("{:>20} - {}", pass
.name
, pass
.description
);
366 println
!("\nDefault passes for rustdoc:");
367 for p
in passes
::DEFAULT_PASSES
{
368 print
!("{:>20}", p
.pass
.name
);
369 println_condition(p
.condition
);
372 if nightly_options
::match_is_nightly_build(matches
) {
373 println
!("\nPasses run with `--show-coverage`:");
374 for p
in passes
::COVERAGE_PASSES
{
375 print
!("{:>20}", p
.pass
.name
);
376 println_condition(p
.condition
);
380 fn println_condition(condition
: Condition
) {
383 Always
=> println
!(),
384 WhenDocumentPrivate
=> println
!(" (when --document-private-items)"),
385 WhenNotDocumentPrivate
=> println
!(" (when not --document-private-items)"),
386 WhenNotDocumentHidden
=> println
!(" (when not --document-hidden-items)"),
393 let mut emit
= Vec
::new();
394 for list
in matches
.opt_strs("emit") {
395 for kind
in list
.split('
,'
) {
397 Ok(kind
) => emit
.push(kind
),
399 diag
.err(&format
!("unrecognized emission type: {}", kind
));
406 // check for `--output-format=json`
407 if !matches
!(matches
.opt_str("output-format").as_deref(), None
| Some("html"))
408 && !matches
.opt_present("show-coverage")
409 && !nightly_options
::is_unstable_enabled(matches
)
411 rustc_session
::early_error(
413 "the -Z unstable-options flag must be passed to enable --output-format for documentation generation (see https://github.com/rust-lang/rust/issues/76578)",
417 let to_check
= matches
.opt_strs("check-theme");
418 if !to_check
.is_empty() {
419 let paths
= match theme
::load_css_paths(static_files
::themes
::LIGHT
) {
422 diag
.struct_err(&e
.to_string()).emit();
428 println
!("rustdoc: [check-theme] Starting tests! (Ignoring all other arguments)");
429 for theme_file
in to_check
.iter() {
430 print
!(" - Checking \"{}\"...", theme_file
);
431 let (success
, differences
) = theme
::test_theme_against(theme_file
, &paths
, &diag
);
432 if !differences
.is_empty() || !success
{
435 if !differences
.is_empty() {
436 println
!("{}", differences
.join("\n"));
448 let (lint_opts
, describe_lints
, lint_cap
) = get_cmd_lint_options(matches
, error_format
);
450 let input
= PathBuf
::from(if describe_lints
{
451 "" // dummy, this won't be used
452 } else if matches
.free
.is_empty() {
453 diag
.struct_err("missing file operand").emit();
455 } else if matches
.free
.len() > 1 {
456 diag
.struct_err("too many file operands").emit();
465 .map(|s
| SearchPath
::from_cli_opt(s
, error_format
))
467 let externs
= parse_externs(matches
, &unstable_opts
, error_format
);
468 let extern_html_root_urls
= match parse_extern_html_roots(matches
) {
471 diag
.struct_err(err
).emit();
476 let default_settings
: Vec
<Vec
<(String
, String
)>> = vec
![
478 .opt_str("default-theme")
482 ("use-system-theme".to_string(), "false".to_string()),
483 ("theme".to_string(), theme
.to_string()),
488 .opt_strs("default-setting")
490 .map(|s
| match s
.split_once('
='
) {
491 None
=> (s
.clone(), "true".to_string()),
492 Some((k
, v
)) => (k
.to_string(), v
.to_string()),
496 let default_settings
= default_settings
500 // The keys here become part of `data-` attribute names in the generated HTML. The
501 // browser does a strange mapping when converting them into attributes on the
502 // `dataset` property on the DOM HTML Node:
503 // https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dataset
505 // The original key values we have are the same as the DOM storage API keys and the
506 // command line options, so contain `-`. Our Javascript needs to be able to look
507 // these values up both in `dataset` and in the storage API, so it needs to be able
508 // to convert the names back and forth. Despite doing this kebab-case to
509 // StudlyCaps transformation automatically, the JS DOM API does not provide a
510 // mechanism for doing the just transformation on a string. So we want to avoid
511 // the StudlyCaps representation in the `dataset` property.
513 // We solve this by replacing all the `-`s with `_`s. We do that here, when we
514 // generate the `data-` attributes, and in the JS, when we look them up. (See
515 // `getSettingValue` in `storage.js.`) Converting `-` to `_` is simple in JS.
517 // The values will be HTML-escaped by the default Tera escaping.
518 |(k
, v
)| (k
.replace('
-'
, "_"), v
),
522 let test_args
= matches
.opt_strs("test-args");
523 let test_args
: Vec
<String
> =
524 test_args
.iter().flat_map(|s
| s
.split_whitespace()).map(|s
| s
.to_string()).collect();
526 let should_test
= matches
.opt_present("test");
527 let no_run
= matches
.opt_present("no-run");
529 if !should_test
&& no_run
{
530 diag
.err("the `--test` flag must be passed to enable `--no-run`");
534 let out_dir
= matches
.opt_str("out-dir").map(|s
| PathBuf
::from(&s
));
535 let output
= matches
.opt_str("output").map(|s
| PathBuf
::from(&s
));
536 let output
= match (out_dir
, output
) {
537 (Some(_
), Some(_
)) => {
538 diag
.struct_err("cannot use both 'out-dir' and 'output' at once").emit();
541 (Some(out_dir
), None
) => out_dir
,
542 (None
, Some(output
)) => output
,
543 (None
, None
) => PathBuf
::from("doc"),
546 let cfgs
= matches
.opt_strs("cfg");
547 let check_cfgs
= matches
.opt_strs("check-cfg");
549 let extension_css
= matches
.opt_str("e").map(|s
| PathBuf
::from(&s
));
551 if let Some(ref p
) = extension_css
{
553 diag
.struct_err("option --extend-css argument must be a file").emit();
558 let mut themes
= Vec
::new();
559 if matches
.opt_present("theme") {
560 let paths
= match theme
::load_css_paths(static_files
::themes
::LIGHT
) {
563 diag
.struct_err(&e
.to_string()).emit();
568 for (theme_file
, theme_s
) in
569 matches
.opt_strs("theme").iter().map(|s
| (PathBuf
::from(&s
), s
.to_owned()))
571 if !theme_file
.is_file() {
572 diag
.struct_err(&format
!("invalid argument: \"{}\"", theme_s
))
573 .help("arguments to --theme must be files")
577 if theme_file
.extension() != Some(OsStr
::new("css")) {
578 diag
.struct_err(&format
!("invalid argument: \"{}\"", theme_s
))
579 .help("arguments to --theme must have a .css extension")
583 let (success
, ret
) = theme
::test_theme_against(&theme_file
, &paths
, &diag
);
585 diag
.struct_err(&format
!("error loading theme file: \"{}\"", theme_s
)).emit();
587 } else if !ret
.is_empty() {
588 diag
.struct_warn(&format
!(
589 "theme file \"{}\" is missing CSS rules from the default theme",
592 .warn("the theme may appear incorrect when loaded")
594 "to see what rules are missing, call `rustdoc --check-theme \"{}\"`",
599 themes
.push(StylePath { path: theme_file }
);
603 let edition
= config
::parse_crate_edition(matches
);
605 let mut id_map
= html
::markdown
::IdMap
::new();
606 let Some(external_html
) = ExternalHtml
::load(
607 &matches
.opt_strs("html-in-header"),
608 &matches
.opt_strs("html-before-content"),
609 &matches
.opt_strs("html-after-content"),
610 &matches
.opt_strs("markdown-before-content"),
611 &matches
.opt_strs("markdown-after-content"),
612 nightly_options
::match_is_nightly_build(matches
),
621 match matches
.opt_str("r").as_deref() {
622 Some("rust") | None
=> {}
624 diag
.struct_err(&format
!("unknown input format: {}", s
)).emit();
629 let index_page
= matches
.opt_str("index-page").map(|s
| PathBuf
::from(&s
));
630 if let Some(ref index_page
) = index_page
{
631 if !index_page
.is_file() {
632 diag
.struct_err("option `--index-page` argument must be a file").emit();
637 let target
= parse_target_triple(matches
, error_format
);
639 let show_coverage
= matches
.opt_present("show-coverage");
641 let crate_types
= match parse_crate_types_from_list(matches
.opt_strs("crate-type")) {
644 diag
.struct_err(&format
!("unknown crate type: {}", e
)).emit();
649 let output_format
= match matches
.opt_str("output-format") {
650 Some(s
) => match OutputFormat
::try_from(s
.as_str()) {
652 if !out_fmt
.is_json() && show_coverage
{
654 "html output format isn't supported for the --show-coverage option",
662 diag
.struct_err(&e
).emit();
666 None
=> OutputFormat
::default(),
668 let crate_name
= matches
.opt_str("crate-name");
669 let proc_macro_crate
= crate_types
.contains(&CrateType
::ProcMacro
);
670 let playground_url
= matches
.opt_str("playground-url");
671 let maybe_sysroot
= matches
.opt_str("sysroot").map(PathBuf
::from
);
672 let module_sorting
= if matches
.opt_present("sort-modules-by-appearance") {
673 ModuleSorting
::DeclarationOrder
675 ModuleSorting
::Alphabetical
677 let resource_suffix
= matches
.opt_str("resource-suffix").unwrap_or_default();
678 let enable_minification
= !matches
.opt_present("disable-minification");
679 let markdown_no_toc
= matches
.opt_present("markdown-no-toc");
680 let markdown_css
= matches
.opt_strs("markdown-css");
681 let markdown_playground_url
= matches
.opt_str("markdown-playground-url");
682 let crate_version
= matches
.opt_str("crate-version");
683 let enable_index_page
= matches
.opt_present("enable-index-page") || index_page
.is_some();
684 let static_root_path
= matches
.opt_str("static-root-path");
685 let test_run_directory
= matches
.opt_str("test-run-directory").map(PathBuf
::from
);
686 let persist_doctests
= matches
.opt_str("persist-doctests").map(PathBuf
::from
);
687 let test_builder
= matches
.opt_str("test-builder").map(PathBuf
::from
);
688 let codegen_options_strs
= matches
.opt_strs("C");
689 let unstable_opts_strs
= matches
.opt_strs("Z");
690 let lib_strs
= matches
.opt_strs("L");
691 let extern_strs
= matches
.opt_strs("extern");
692 let runtool
= matches
.opt_str("runtool");
693 let runtool_args
= matches
.opt_strs("runtool-arg");
694 let enable_per_target_ignores
= matches
.opt_present("enable-per-target-ignores");
695 let document_private
= matches
.opt_present("document-private-items");
696 let document_hidden
= matches
.opt_present("document-hidden-items");
697 let run_check
= matches
.opt_present("check");
698 let generate_redirect_map
= matches
.opt_present("generate-redirect-map");
699 let show_type_layout
= matches
.opt_present("show-type-layout");
700 let nocapture
= matches
.opt_present("nocapture");
701 let generate_link_to_definition
= matches
.opt_present("generate-link-to-definition");
702 let extern_html_root_takes_precedence
=
703 matches
.opt_present("extern-html-root-takes-precedence");
705 if generate_link_to_definition
&& (show_coverage
|| output_format
!= OutputFormat
::Html
) {
707 "--generate-link-to-definition option can only be used with HTML output format",
713 let scrape_examples_options
= ScrapeExamplesOptions
::new(matches
, &diag
)?
;
714 let with_examples
= matches
.opt_strs("with-examples");
715 let call_locations
= crate::scrape_examples
::load_call_locations(with_examples
, &diag
)?
;
717 let unstable_features
=
718 rustc_feature
::UnstableFeatures
::from_environment(crate_name
.as_deref());
719 let options
= Options
{
731 codegen_options_strs
,
748 enable_per_target_ignores
,
756 scrape_examples_options
,
759 let render_options
= RenderOptions
{
767 extern_html_root_urls
,
768 extern_html_root_takes_precedence
,
777 markdown_playground_url
,
780 generate_redirect_map
,
784 generate_link_to_definition
,
786 no_emit_shared
: false,
788 Ok((options
, render_options
))
791 /// Returns `true` if the file given as `self.input` is a Markdown file.
792 pub(crate) fn markdown_input(&self) -> bool
{
793 self.input
.extension().map_or(false, |e
| e
== "md" || e
== "markdown")
797 /// Prints deprecation warnings for deprecated options
798 fn check_deprecated_options(matches
: &getopts
::Matches
, diag
: &rustc_errors
::Handler
) {
799 let deprecated_flags
= [];
801 for &flag
in deprecated_flags
.iter() {
802 if matches
.opt_present(flag
) {
803 diag
.struct_warn(&format
!("the `{}` flag is deprecated", flag
))
805 "see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
806 for more information",
812 let removed_flags
= ["plugins", "plugin-path", "no-defaults", "passes", "input-format"];
814 for &flag
in removed_flags
.iter() {
815 if matches
.opt_present(flag
) {
816 let mut err
= diag
.struct_warn(&format
!("the `{}` flag no longer functions", flag
));
818 "see issue #44136 <https://github.com/rust-lang/rust/issues/44136> \
819 for more information",
822 if flag
== "no-defaults" || flag
== "passes" {
823 err
.help("you may want to use --document-private-items");
824 } else if flag
== "plugins" || flag
== "plugin-path" {
825 err
.warn("see CVE-2018-1000622");
833 /// Extracts `--extern-html-root-url` arguments from `matches` and returns a map of crate names to
834 /// the given URLs. If an `--extern-html-root-url` argument was ill-formed, returns an error
835 /// describing the issue.
836 fn parse_extern_html_roots(
837 matches
: &getopts
::Matches
,
838 ) -> Result
<BTreeMap
<String
, String
>, &'
static str> {
839 let mut externs
= BTreeMap
::new();
840 for arg
in &matches
.opt_strs("extern-html-root-url") {
842 arg
.split_once('
='
).ok_or("--extern-html-root-url must be of the form name=url")?
;
843 externs
.insert(name
.to_string(), url
.to_string());