Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit 52eb4ee

Browse files
committed
run_make_support: cleanup and document some lib.rs reexports
1 parent 9f80c1d commit 52eb4ee

File tree

1 file changed

+10
-1
lines changed
  • src/tools/run-make-support/src

1 file changed

+10
-1
lines changed

src/tools/run-make-support/src/lib.rs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@
44
//! as `object` or `wasmparser`, they can be re-exported and be made available through this library.
55
66
mod command;
7+
mod macros;
8+
79
pub mod diff;
810
pub mod env_checked;
911
pub mod external_deps;
1012
pub mod fs_wrapper;
11-
mod macros;
1213
pub mod run;
1314
pub mod targets;
1415

@@ -17,6 +18,7 @@ use std::io;
1718
use std::panic;
1819
use std::path::{Path, PathBuf};
1920

21+
// Re-exports of third-party library crates.
2022
pub use bstr;
2123
pub use gimli;
2224
pub use object;
@@ -26,6 +28,7 @@ pub use wasmparser;
2628
// Re-exports of external dependencies.
2729
pub use external_deps::{cc, clang, htmldocck, llvm, python, rustc, rustdoc};
2830

31+
// These rely on external dependencies.
2932
pub use cc::{cc, extra_c_flags, extra_cxx_flags, Cc};
3033
pub use clang::{clang, Clang};
3134
pub use htmldocck::htmldocck;
@@ -37,12 +40,18 @@ pub use python::python_command;
3740
pub use rustc::{aux_build, bare_rustc, rustc, Rustc};
3841
pub use rustdoc::{bare_rustdoc, rustdoc, Rustdoc};
3942

43+
/// [`diff`] is implemented in terms of the [similar] library.
44+
///
45+
/// [similar]: https://github.com/mitsuhiko/similar
4046
pub use diff::{diff, Diff};
4147

48+
/// Panic-on-fail [`std::env::var`] and [`std::env::var_os`] wrappers.
4249
pub use env_checked::{env_var, env_var_os};
4350

51+
/// Convenience helpers for running binaries and other commands.
4452
pub use run::{cmd, run, run_fail, run_with_args};
4553

54+
/// Helpers for checking target information.
4655
pub use targets::{is_darwin, is_msvc, is_windows, target, uname};
4756

4857
use command::{Command, CompletedProcess};

0 commit comments

Comments
 (0)