restored librustdoc to upstream version

Author: EtomicBomb

src/librustdoc/Cargo.toml

@@ -16,7 +16,7 @@ minifier = "0.3.0"
 pulldown-cmark-old = { version = "0.9.6", package = "pulldown-cmark", default-features = false }
 regex = "1"
 rustdoc-json-types = { path = "../rustdoc-json-types" }
-serde_json = { version = "1.0", features = ["preserve_order"] }
+serde_json = "1.0"
 serde = { version = "1.0", features = ["derive"] }
 smallvec = "1.8.1"
 tempfile = "3"

src/librustdoc/clean/types.rs

@@ -133,7 +133,7 @@ pub(crate) struct ExternalCrate {
 }
 
 impl ExternalCrate {
-    pub(crate) const LOCAL: Self = Self { crate_num: LOCAL_CRATE };
+    const LOCAL: Self = Self { crate_num: LOCAL_CRATE };
 
     #[inline]
     pub(crate) fn def_id(&self) -> DefId {

src/librustdoc/config.rs

@@ -292,16 +292,6 @@ pub(crate) struct RenderOptions {
     pub(crate) no_emit_shared: bool,
     /// If `true`, HTML source code pages won't be generated.
     pub(crate) html_no_source: bool,
-    /// If `true` (default) read the shared cross-crate information from the doc root for output
-    pub(crate) read_rendered_cci: bool,
-    /// If `true` (default) write the shared cross-crate information to the doc root
-    pub(crate) write_rendered_cci: bool,
-    /// Copies these externally documented crates into our doc root.
-    pub(crate) include_rendered_docs: Vec<PathToDocRoot>,
-    /// Path to crate-info.json for external crates.
-    pub(crate) parts_paths: Vec<PathToParts>,
-    /// Where to write crate-info.json.
-    pub(crate) parts_out_dir: Option<PathToParts>,
 }
 
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
@@ -506,17 +496,6 @@ impl Options {
             Err(err) => dcx.fatal(err),
         };
 
-        let include_rendered_docs = matches
-            .opt_strs("include-rendered-docs")
-            .into_iter()
-            .map(|p| PathToDocRoot(PathBuf::from(p)))
-            .collect();
-        let parts_paths = matches
-            .opt_strs("include-info-json")
-            .into_iter()
-            .map(|path| PathToParts(PathBuf::from(path)))
-            .collect();
-
         let default_settings: Vec<Vec<(String, String)>> = vec![
             matches
                 .opt_str("default-theme")
@@ -757,12 +736,6 @@ impl Options {
         let extern_html_root_takes_precedence =
             matches.opt_present("extern-html-root-takes-precedence");
         let html_no_source = matches.opt_present("html-no-source");
-        let ShouldMerge { read_rendered_cci, write_rendered_cci } = match parse_merge(matches) {
-            Ok(result) => result,
-            Err(e) => dcx.fatal(format!("could not parse --merge: {e}")),
-        };
-        let parts_out_dir =
-            matches.opt_str("write-info-json").map(|p| PathToParts(PathBuf::from(p)));
 
         if generate_link_to_definition && (show_coverage || output_format != OutputFormat::Html) {
             dcx.fatal(
@@ -848,11 +821,6 @@ impl Options {
             call_locations,
             no_emit_shared: false,
             html_no_source,
-            read_rendered_cci,
-            write_rendered_cci,
-            parts_paths,
-            include_rendered_docs,
-            parts_out_dir,
         };
         Some((options, render_options))
     }
@@ -930,36 +898,3 @@ fn parse_extern_html_roots(
     }
     Ok(externs)
 }
-
-/// Path to the doc root for a specific crate, for example `target/doc/serde_json`.
-#[derive(Clone, Debug)]
-pub(crate) struct PathToDocRoot(pub PathBuf);
-
-/// Path to crate-info.json
-///
-/// For example, `/home/user/project/target/doc.parts/<crate>/crate-info.json`.
-#[derive(Clone, Debug)]
-pub(crate) struct PathToParts(pub(crate) PathBuf);
-
-/// Controls merging of cross-crate information
-struct ShouldMerge {
-    /// Should we append to existing cci in the doc root
-    read_rendered_cci: bool,
-    /// Should we write cci to the doc root
-    write_rendered_cci: bool,
-}
-
-/// Extracts read_rendered_cci and write_rendered_cci from command line arguments, or
-/// reports an error.
-fn parse_merge(matches: &getopts::Matches) -> Result<ShouldMerge, &'static str> {
-    match matches.opt_str("merge").as_deref() {
-        // default = read-write
-        None => Ok(ShouldMerge { read_rendered_cci: true, write_rendered_cci: true }),
-        Some("read-write") => Ok(ShouldMerge { read_rendered_cci: true, write_rendered_cci: true }),
-        Some("none") => Ok(ShouldMerge { read_rendered_cci: false, write_rendered_cci: false }),
-        Some("write-only") => {
-            Ok(ShouldMerge { read_rendered_cci: false, write_rendered_cci: true })
-        }
-        Some(_) => Err("argument to --merge must be `read-write`, `none`, or `write-only`"),
-    }
-}

src/librustdoc/html/render/context.rs

@@ -12,8 +12,8 @@ use rustc_session::Session;
 use rustc_span::edition::Edition;
 use rustc_span::{sym, FileName, Symbol};
 
-use super::copy_dir::copy_dir_all;
 use super::print_item::{full_path, item_path, print_item};
+use super::search_index::build_index;
 use super::write_shared::write_shared;
 use super::{
     collect_spans_and_sources, scrape_examples_help,
@@ -133,8 +133,6 @@ pub(crate) struct SharedContext<'tcx> {
     pub(crate) cache: Cache,
 
     pub(crate) call_locations: AllCallLocations,
-    /// Controls whether we write to the doc root. Default is true from cli.
-    write_rendered_cci: bool,
 }
 
 impl SharedContext<'_> {
@@ -471,7 +469,6 @@ impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> {
             call_locations,
             no_emit_shared,
             html_no_source,
-            include_rendered_docs,
             ..
         } = options;
 
@@ -557,7 +554,6 @@ impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> {
             span_correspondence_map: matches,
             cache,
             call_locations,
-            write_rendered_cci: options.write_rendered_cci,
         };
 
         let dst = output;
@@ -575,16 +571,18 @@ impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> {
             is_inside_inlined_module: false,
         };
 
-        for extern_docs in include_rendered_docs.iter() {
-            try_err!(copy_dir_all(&extern_docs.0, &cx.dst), &extern_docs.0);
-        }
-
         if emit_crate {
             sources::render(&mut cx, &krate)?;
         }
 
         if !no_emit_shared {
-            write_shared(&mut cx, &krate, &md_opts, tcx)?;
+            // Build our search index
+            let index = build_index(&krate, &mut Rc::get_mut(&mut cx.shared).unwrap().cache, tcx);
+
+            // Write shared runs within a flock; disable thread dispatching of IO temporarily.
+            Rc::get_mut(&mut cx.shared).unwrap().fs.set_sync_only(true);
+            write_shared(&mut cx, &krate, index, &md_opts)?;
+            Rc::get_mut(&mut cx.shared).unwrap().fs.set_sync_only(false);
         }
 
         Ok((cx, krate))
@@ -649,99 +647,92 @@ impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> {
         );
         shared.fs.write(final_file, v)?;
 
-        // if to avoid writing files to doc root unless we're on the final invocation
-        if shared.write_rendered_cci {
-            // Generating settings page.
-            page.title = "Settings";
-            page.description = "Settings of Rustdoc";
-            page.root_path = "./";
-            page.rust_logo = true;
+        // Generating settings page.
+        page.title = "Settings";
+        page.description = "Settings of Rustdoc";
+        page.root_path = "./";
+        page.rust_logo = true;
 
-            let sidebar = "<h2 class=\"location\">Settings</h2><div class=\"sidebar-elems\"></div>";
-            let v = layout::render(
-                &shared.layout,
-                &page,
-                sidebar,
-                |buf: &mut Buffer| {
-                    write!(
-                        buf,
-                        "<div class=\"main-heading\">\
-                         <h1>Rustdoc settings</h1>\
-                         <span class=\"out-of-band\">\
-                             <a id=\"back\" href=\"javascript:void(0)\" onclick=\"history.back();\">\
-                                Back\
-                            </a>\
-                         </span>\
-                         </div>\
-                         <noscript>\
-                            <section>\
-                                You need to enable JavaScript be able to update your settings.\
-                            </section>\
-                         </noscript>\
-                         <script defer src=\"{static_root_path}{settings_js}\"></script>",
-                        static_root_path = page.get_static_root_path(),
-                        settings_js = static_files::STATIC_FILES.settings_js,
-                    );
-                    // Pre-load all theme CSS files, so that switching feels seamless.
-                    //
-                    // When loading settings.html as a popover, the equivalent HTML is
-                    // generated in main.js.
-                    for file in &shared.style_files {
-                        if let Ok(theme) = file.basename() {
-                            write!(
-                                buf,
-                                "<link rel=\"preload\" href=\"{root_path}{theme}{suffix}.css\" \
-                                    as=\"style\">",
-                                root_path = page.static_root_path.unwrap_or(""),
-                                suffix = page.resource_suffix,
-                            );
-                        }
+        let sidebar = "<h2 class=\"location\">Settings</h2><div class=\"sidebar-elems\"></div>";
+        let v = layout::render(
+            &shared.layout,
+            &page,
+            sidebar,
+            |buf: &mut Buffer| {
+                write!(
+                    buf,
+                    "<div class=\"main-heading\">\
+                     <h1>Rustdoc settings</h1>\
+                     <span class=\"out-of-band\">\
+                         <a id=\"back\" href=\"javascript:void(0)\" onclick=\"history.back();\">\
+                            Back\
+                        </a>\
+                     </span>\
+                     </div>\
+                     <noscript>\
+                        <section>\
+                            You need to enable JavaScript be able to update your settings.\
+                        </section>\
+                     </noscript>\
+                     <script defer src=\"{static_root_path}{settings_js}\"></script>",
+                    static_root_path = page.get_static_root_path(),
+                    settings_js = static_files::STATIC_FILES.settings_js,
+                );
+                // Pre-load all theme CSS files, so that switching feels seamless.
+                //
+                // When loading settings.html as a popover, the equivalent HTML is
+                // generated in main.js.
+                for file in &shared.style_files {
+                    if let Ok(theme) = file.basename() {
+                        write!(
+                            buf,
+                            "<link rel=\"preload\" href=\"{root_path}{theme}{suffix}.css\" \
+                                as=\"style\">",
+                            root_path = page.static_root_path.unwrap_or(""),
+                            suffix = page.resource_suffix,
+                        );
                     }
-                },
-                &shared.style_files,
-            );
-            shared.fs.write(settings_file, v)?;
-        }
+                }
+            },
+            &shared.style_files,
+        );
+        shared.fs.write(settings_file, v)?;
 
-        // if to avoid writing files to doc root unless we're on the final invocation
-        if shared.write_rendered_cci {
-            // Generating help page.
-            page.title = "Help";
-            page.description = "Documentation for Rustdoc";
-            page.root_path = "./";
-            page.rust_logo = true;
+        // Generating help page.
+        page.title = "Help";
+        page.description = "Documentation for Rustdoc";
+        page.root_path = "./";
+        page.rust_logo = true;
 
-            let sidebar = "<h2 class=\"location\">Help</h2><div class=\"sidebar-elems\"></div>";
-            let v = layout::render(
-                &shared.layout,
-                &page,
-                sidebar,
-                |buf: &mut Buffer| {
-                    write!(
-                        buf,
-                        "<div class=\"main-heading\">\
-                         <h1>Rustdoc help</h1>\
-                         <span class=\"out-of-band\">\
-                             <a id=\"back\" href=\"javascript:void(0)\" onclick=\"history.back();\">\
-                                Back\
-                            </a>\
-                         </span>\
-                         </div>\
-                         <noscript>\
-                            <section>\
-                                <p>You need to enable JavaScript to use keyboard commands or search.</p>\
-                                <p>For more information, browse the <a href=\"https://doc.rust-lang.org/rustdoc/\">rustdoc handbook</a>.</p>\
-                            </section>\
-                         </noscript>",
-                    )
-                },
-                &shared.style_files,
-            );
-            shared.fs.write(help_file, v)?;
-        }
+        let sidebar = "<h2 class=\"location\">Help</h2><div class=\"sidebar-elems\"></div>";
+        let v = layout::render(
+            &shared.layout,
+            &page,
+            sidebar,
+            |buf: &mut Buffer| {
+                write!(
+                    buf,
+                    "<div class=\"main-heading\">\
+                     <h1>Rustdoc help</h1>\
+                     <span class=\"out-of-band\">\
+                         <a id=\"back\" href=\"javascript:void(0)\" onclick=\"history.back();\">\
+                            Back\
+                        </a>\
+                     </span>\
+                     </div>\
+                     <noscript>\
+                        <section>\
+                            <p>You need to enable JavaScript to use keyboard commands or search.</p>\
+                            <p>For more information, browse the <a href=\"https://doc.rust-lang.org/rustdoc/\">rustdoc handbook</a>.</p>\
+                        </section>\
+                     </noscript>",
+                )
+            },
+            &shared.style_files,
+        );
+        shared.fs.write(help_file, v)?;
 
-        // if to avoid writing files to doc root unless we're on the final invocation
-        if shared.layout.scrape_examples_extension && shared.write_rendered_cci {
+        if shared.layout.scrape_examples_extension {
             page.title = "About scraped examples";
             page.description = "How the scraped examples feature works in Rustdoc";
             let v = layout::render(