about summary refs log tree commit diff
diff options
context:
space:
mode:
authorEric Huss <eric@huss.org>2020-02-24 13:52:08 -0800
committerEric Huss <eric@huss.org>2020-03-12 19:19:18 -0700
commit3c48c89e7b9cea0b70a138571dec708fd09ba72f (patch)
tree69f17ca193ddb87e3d34f6e20dcde423ffbba0d3
parentbc738f239348dd62f18d40fdc001757ec00cfea5 (diff)
downloadrust-3c48c89e7b9cea0b70a138571dec708fd09ba72f.tar.gz
rust-3c48c89e7b9cea0b70a138571dec708fd09ba72f.zip
tidy: Add some clarifying comments in license checks.
-rw-r--r--src/tools/tidy/src/deps.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/tools/tidy/src/deps.rs b/src/tools/tidy/src/deps.rs
index aa4d86e2a84..886bdf6fbbf 100644
--- a/src/tools/tidy/src/deps.rs
+++ b/src/tools/tidy/src/deps.rs
@@ -4,6 +4,8 @@ use cargo_metadata::{Metadata, Package, PackageId, Resolve};
 use std::collections::{BTreeSet, HashSet};
 use std::path::Path;
 
+/// These are licenses that are allowed for all crates, including the runtime,
+/// rustc, tools, etc.
 const LICENSES: &[&str] = &[
     "MIT/Apache-2.0",
     "MIT / Apache-2.0",
@@ -58,6 +60,9 @@ const RUNTIME_CRATES: &[&str] = &["std", "core", "alloc", "panic_abort", "panic_
 const WHITELIST_CRATES: &[&str] = &["rustc", "rustc_codegen_llvm"];
 
 /// Whitelist of crates rustc is allowed to depend on. Avoid adding to the list if possible.
+///
+/// This list is here to provide a speed-bump to adding a new dependency to
+/// rustc. Please check with the compiler team before adding an entry.
 const WHITELIST: &[&str] = &[
     "adler32",
     "aho-corasick",