Skip to content

Commit facf8fa

Browse files
Add extra descriptive comments to collect-license-metadata.
1 parent eeb4601 commit facf8fa

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

src/tools/collect-license-metadata/Cargo.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
name = "collect-license-metadata"
33
version = "0.1.0"
44
edition = "2021"
5+
description = "Runs the reuse tool and caches the output, so rust toolchain devs don't need to have reuse installed"
6+
license = "MIT OR Apache-2.0"
57

68
[dependencies]
79
anyhow = "1.0.65"

src/tools/collect-license-metadata/src/main.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ use std::path::PathBuf;
1616
const CONDENSED_DIRECTORIES: &[(&str, &str)] =
1717
&[("./src/llvm-project/", "./src/llvm-project/README.md")];
1818

19+
/// The entry point to the binary.
20+
///
21+
/// You should probably let `bootstrap` execute this program instead of running it directly.
22+
///
23+
/// Run `x.py run collect-license-metadata`
1924
fn main() -> Result<(), Error> {
2025
let reuse_exe: PathBuf = std::env::var_os("REUSE_EXE").expect("Missing REUSE_EXE").into();
2126
let dest: PathBuf = std::env::var_os("DEST").expect("Missing DEST").into();

0 commit comments

Comments
 (0)