Skip to content

Commit

Permalink
Docs(crates/cargo-test-*): Add external usage warning
Browse files Browse the repository at this point in the history
As discussed in #10147.

Signed-off-by: Paul Mabileau <paulmabileau@hotmail.fr>
  • Loading branch information
PaulDance committed Mar 26, 2024
1 parent 29c45d0 commit f422e96
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 0 deletions.
5 changes: 5 additions & 0 deletions crates/cargo-test-macro/README.md
Original file line number Diff line number Diff line change
@@ -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.
11 changes: 11 additions & 0 deletions crates/cargo-test-macro/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
//! # Cargo test macro.
//!
//! This is meant to be consumed alongside `cargo-test-support`. See
//! <https://rust-lang.github.io/cargo/contrib/> 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;
Expand Down
5 changes: 5 additions & 0 deletions crates/cargo-test-support/README.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 6 additions & 0 deletions crates/cargo-test-support/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
//! # Cargo test support.
//!
//! See <https://rust-lang.github.io/cargo/contrib/> 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)]
Expand Down

0 comments on commit f422e96

Please sign in to comment.