From f422e96b31b7086e9c27c7fd0735f3a568a5e95d Mon Sep 17 00:00:00 2001 From: Paul Mabileau Date: Mon, 26 Feb 2024 21:41:48 +0100 Subject: [PATCH] Docs(crates/cargo-test-*): Add external usage warning As discussed in #10147. Signed-off-by: Paul Mabileau --- crates/cargo-test-macro/README.md | 5 +++++ crates/cargo-test-macro/src/lib.rs | 11 +++++++++++ crates/cargo-test-support/README.md | 5 +++++ crates/cargo-test-support/src/lib.rs | 6 ++++++ 4 files changed, 27 insertions(+) create mode 100644 crates/cargo-test-macro/README.md create mode 100644 crates/cargo-test-support/README.md diff --git a/crates/cargo-test-macro/README.md b/crates/cargo-test-macro/README.md new file mode 100644 index 000000000..311d5ed6d --- /dev/null +++ b/crates/cargo-test-macro/README.md @@ -0,0 +1,5 @@ +WARNING: You might not want to use this outside of Cargo. + +* This is designed for testing Cargo itself. Use at your own risk. +* No guarantee on any stability across versions. +* No feature request would be accepted unless proved useful for testing Cargo. diff --git a/crates/cargo-test-macro/src/lib.rs b/crates/cargo-test-macro/src/lib.rs index f813b835a..9d4a5fbaa 100644 --- a/crates/cargo-test-macro/src/lib.rs +++ b/crates/cargo-test-macro/src/lib.rs @@ -1,3 +1,14 @@ +//! # Cargo test macro. +//! +//! This is meant to be consumed alongside `cargo-test-support`. See +//! for a guide on writing tests. +//! +//! WARNING: You might not want to use this outside of Cargo. +//! +//! * This is designed for testing Cargo itself. Use at your own risk. +//! * No guarantee on any stability across versions. +//! * No feature request would be accepted unless proved useful for testing Cargo. + use proc_macro::*; use std::path::Path; use std::process::Command; diff --git a/crates/cargo-test-support/README.md b/crates/cargo-test-support/README.md new file mode 100644 index 000000000..311d5ed6d --- /dev/null +++ b/crates/cargo-test-support/README.md @@ -0,0 +1,5 @@ +WARNING: You might not want to use this outside of Cargo. + +* This is designed for testing Cargo itself. Use at your own risk. +* No guarantee on any stability across versions. +* No feature request would be accepted unless proved useful for testing Cargo. diff --git a/crates/cargo-test-support/src/lib.rs b/crates/cargo-test-support/src/lib.rs index 15a77adc7..a02f82933 100644 --- a/crates/cargo-test-support/src/lib.rs +++ b/crates/cargo-test-support/src/lib.rs @@ -1,6 +1,12 @@ //! # Cargo test support. //! //! See for a guide on writing tests. +//! +//! WARNING: You might not want to use this outside of Cargo. +//! +//! * This is designed for testing Cargo itself. Use at your own risk. +//! * No guarantee on any stability across versions. +//! * No feature request would be accepted unless proved useful for testing Cargo. #![allow(clippy::disallowed_methods)] #![allow(clippy::print_stderr)]