about summary refs log tree commit diff
diff options
context:
space:
mode:
author许杰友 Jieyou Xu (Joe) <jieyouxu@outlook.com>2024-04-10 13:59:58 +0000
committer许杰友 Jieyou Xu (Joe) <jieyouxu@outlook.com>2024-04-13 14:50:07 +0000
commita67a119424377ec53a3b36bca251a30637ae42dd (patch)
treee2800f18ee53e115e473f378a43b4061cfc3a801
parent3d115b9cc9cf511b49d2e4812ae6a530bc6f61df (diff)
downloadrust-a67a119424377ec53a3b36bca251a30637ae42dd.tar.gz
rust-a67a119424377ec53a3b36bca251a30637ae42dd.zip
run-make-support: add some top-level docs
-rw-r--r--src/tools/run-make-support/src/lib.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/tools/run-make-support/src/lib.rs b/src/tools/run-make-support/src/lib.rs
index 504bd6030d9..47b46a0a699 100644
--- a/src/tools/run-make-support/src/lib.rs
+++ b/src/tools/run-make-support/src/lib.rs
@@ -1,3 +1,8 @@
+//! `run-make-support` is a support library for run-make tests. It provides command wrappers and
+//! convenience utility functions to help test writers reduce duplication. The support library
+//! notably is built via cargo: this means that if your test wants some non-trivial utility, such
+//! as `object` or `wasmparser`, they can be re-exported and be made available through this library.
+
 pub mod cc;
 pub mod run;
 pub mod rustc;