Now the COPYRIGHT HTML files live at the root and CI checks they are correct.

Run ./x run generate-copyright to rebuild them.
Run ./x test generate-copyright to check them.

Author: jonathanpallant

COPYRIGHT

@@ -25,7 +25,8 @@ path = [
     "config.example.toml",
     "configure",
     "CONTRIBUTING.md",
-    "COPYRIGHT",
+    "COPYRIGHT.html",
+    "COPYRIGHT-library.html",
     "INSTALL.md",
     "LICENSE-APACHE",
     "LICENSE-MIT",

COPYRIGHT-library.html

@@ -197,7 +197,7 @@ impl Step for CollectLicenseMetadata {
 pub struct GenerateCopyright;
 
 impl Step for GenerateCopyright {
-    type Output = PathBuf;
+    type Output = (PathBuf, PathBuf);
     const ONLY_HOSTS: bool = true;
 
     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
@@ -211,18 +211,19 @@ impl Step for GenerateCopyright {
     fn run(self, builder: &Builder<'_>) -> Self::Output {
         let license_metadata = builder.ensure(CollectLicenseMetadata);
 
-        let dest = builder.out.join("COPYRIGHT.html");
-        let dest_libstd = builder.out.join("COPYRIGHT-library.html");
+        let dest = builder.src.join("COPYRIGHT.html");
+        let dest_libstd = builder.src.join("COPYRIGHT-library.html");
 
         let mut cmd = builder.tool_cmd(Tool::GenerateCopyright);
         cmd.env("LICENSE_METADATA", &license_metadata);
         cmd.env("DEST", &dest);
         cmd.env("DEST_LIBSTD", &dest_libstd);
         cmd.env("OUT_DIR", &builder.out);
+        cmd.env("CHECK", "0");
         cmd.env("CARGO", &builder.initial_cargo);
         cmd.run(builder);
 
-        dest
+        (dest, dest_libstd)
     }
 }
 

COPYRIGHT.html

@@ -3611,3 +3611,36 @@ impl Step for TestFloatParse {
         cargo_run.into_cmd().run(builder);
     }
 }
+
+#[derive(Debug, PartialOrd, Ord, Clone, Hash, PartialEq, Eq)]
+pub struct GenerateCopyright;
+
+impl Step for GenerateCopyright {
+    type Output = ();
+    const ONLY_HOSTS: bool = true;
+
+    fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
+        run.path("src/tools/generate-copyright")
+    }
+
+    fn make_run(run: RunConfig<'_>) {
+        run.builder.ensure(GenerateCopyright);
+    }
+
+    fn run(self, builder: &Builder<'_>) -> Self::Output {
+        let license_metadata =
+            builder.ensure(crate::core::build_steps::run::CollectLicenseMetadata);
+
+        let dest = builder.out.join("COPYRIGHT.html");
+        let dest_libstd = builder.out.join("COPYRIGHT-library.html");
+
+        let mut cmd = builder.tool_cmd(Tool::GenerateCopyright);
+        cmd.env("LICENSE_METADATA", &license_metadata);
+        cmd.env("DEST", &dest);
+        cmd.env("DEST_LIBSTD", &dest_libstd);
+        cmd.env("OUT_DIR", &builder.out);
+        cmd.env("CHECK", "1");
+        cmd.env("CARGO", &builder.initial_cargo);
+        cmd.run(builder);
+    }
+}

REUSE.toml

@@ -915,6 +915,7 @@ impl<'a> Builder<'a> {
                 test::HtmlCheck,
                 test::RustInstaller,
                 test::TestFloatParse,
+                test::GenerateCopyright,
                 // Run bootstrap close to the end as it's unlikely to fail
                 test::Bootstrap,
                 // Run run-make last, since these won't pass without make on Windows

src/bootstrap/src/core/build_steps/run.rs

@@ -67,4 +67,6 @@ ENV SCRIPT \
            es-check es2019 ../src/librustdoc/html/static/js/*.js && \
            eslint -c ../src/librustdoc/html/static/.eslintrc.js ../src/librustdoc/html/static/js/*.js && \
            eslint -c ../src/tools/rustdoc-js/.eslintrc.js ../src/tools/rustdoc-js/tester.js && \
-           eslint -c ../src/tools/rustdoc-gui/.eslintrc.js ../src/tools/rustdoc-gui/tester.js
+           eslint -c ../src/tools/rustdoc-gui/.eslintrc.js ../src/tools/rustdoc-gui/tester.js && \
+           # Check our COPYRIGHT files are still OK
+           python3 ../x.py test generate-copyright

src/bootstrap/src/core/build_steps/test.rs

@@ -10,10 +10,13 @@ mod cargo_metadata;
 ///
 /// You should probably let `bootstrap` execute this program instead of running it directly.
 ///
-/// Run `x.py run generate-copyright`
+/// Run `x.py run generate-copyright` to make the files, or
+/// `x.py test generate-copyright` to check the existing files.
 fn main() -> Result<(), Error> {
     let dest_file = env_path("DEST")?;
     let libstd_dest_file = env_path("DEST_LIBSTD")?;
+    let check_existing = env_str("CHECK")? == "1";
+
     let out_dir = env_path("OUT_DIR")?;
     let cargo = env_path("CARGO")?;
     let license_metadata = env_path("LICENSE_METADATA")?;
@@ -57,16 +60,35 @@ fn main() -> Result<(), Error> {
         dependencies: collected_cargo_metadata,
     };
     let output = template.render()?;
-    std::fs::write(&dest_file, output)?;
+    if check_existing {
+        check_file_contents(&dest_file, &output)?;
+    } else {
+        std::fs::write(&dest_file, &output)?;
+    }
 
     // Output libstd subset file
     let template = LibraryCopyrightTemplate {
         in_tree: library_collected_tree_metadata.files,
         dependencies: library_collected_cargo_metadata,
     };
     let output = template.render()?;
-    std::fs::write(&libstd_dest_file, output)?;
+    if check_existing {
+        check_file_contents(&libstd_dest_file, &output)?;
+    } else {
+        std::fs::write(&libstd_dest_file, &output)?;
+    }
+
+    Ok(())
+}
 
+/// Check two files have the same contents
+fn check_file_contents(path: &Path, new_contents: &str) -> Result<(), Error> {
+    let orig_contents = std::fs::read_to_string(&path)?;
+    if orig_contents != new_contents {
+        anyhow::bail!("File {} is out of date", path.display());
+    } else {
+        println!("File {} is OK", path.display());
+    }
     Ok(())
 }
 
@@ -186,3 +208,8 @@ fn env_path(var: &str) -> Result<PathBuf, Error> {
         anyhow::bail!("missing environment variable {var}")
     }
 }
+
+/// Grab an environment variable as a String, or fail nicely.
+fn env_str(var: &str) -> Result<String, Error> {
+    std::env::var(var).map_err(|_| anyhow::anyhow!("missing environment variable {var}"))
+}

src/bootstrap/src/core/builder/mod.rs

@@ -8,16 +8,39 @@
 
 <h1>Copyright notices for The Rust Standard Library</h1>
 
-<p>This file describes the copyright and licensing information for the Rust
-Standard Library source code within The Rust Project git tree, and the
-third-party dependencies used when building the Rust Standard Library.</p>
-
 <h2>Table of Contents</h2>
 <ul>
+    <li><a href="#short-version">Short version for non-lawyers</a></li>
+    <li><a href="#longer-version">Longer version</a></li>
     <li><a href="#in-tree-files">In-tree files</a></li>
     <li><a href="#out-of-tree-dependencies">Out-of-tree dependencies</a></li>
 </ul>
 
+<h2 id="short-version">Short version for non-lawyers</h2>
+
+The Rust Standard Library is dual-licensed under Apache 2.0 and MIT
+terms.
+
+<h2 id="longer-version">Longer version</h2>
+
+<p>Copyrights in the Rust Standard Library are retained by their contributors. No
+copyright assignment is required to contribute to the Rust project.</p>
+
+<p>Some files include explicit copyright notices and/or license notices.
+For full authorship information, see the version control history or
+<a href="https://thanks.rust-lang.org">https://thanks.rust-lang.org</a>.</p>
+
+<p></p>Except as otherwise noted (below and/or in individual files), the Rust
+Standard Library is licensed under the Apache License, Version 2.0
+(<tt>LICENSE-APACHE</tt> or
+<a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a>)
+or the MIT license (<tt>LICENSE-MIT</tt> or <a href="http://opensource.org/licenses/MIT">http://opensource.org/licenses/MIT</a>),
+at your option.</p>
+
+<p>This file describes the copyright and licensing information for the source
+code within The Rust Project git tree related to the Rust Standard Library, and
+the third-party dependencies used when building the Rust Standard Library.</p>
+
 <h2 id="in-tree-files">In-tree files</h2>
 
 <p>The following licenses cover the in-tree source files that were used in this