Skip to content

Commit f422e96

Browse files
committed
Docs(crates/cargo-test-*): Add external usage warning
As discussed in #10147. Signed-off-by: Paul Mabileau <[email protected]>
1 parent 29c45d0 commit f422e96

File tree

4 files changed

+27
-0
lines changed

4 files changed

+27
-0
lines changed

crates/cargo-test-macro/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
WARNING: You might not want to use this outside of Cargo.
2+
3+
* This is designed for testing Cargo itself. Use at your own risk.
4+
* No guarantee on any stability across versions.
5+
* No feature request would be accepted unless proved useful for testing Cargo.

crates/cargo-test-macro/src/lib.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
//! # Cargo test macro.
2+
//!
3+
//! This is meant to be consumed alongside `cargo-test-support`. See
4+
//! <https://rust-lang.github.io/cargo/contrib/> for a guide on writing tests.
5+
//!
6+
//! WARNING: You might not want to use this outside of Cargo.
7+
//!
8+
//! * This is designed for testing Cargo itself. Use at your own risk.
9+
//! * No guarantee on any stability across versions.
10+
//! * No feature request would be accepted unless proved useful for testing Cargo.
11+
112
use proc_macro::*;
213
use std::path::Path;
314
use std::process::Command;

crates/cargo-test-support/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
WARNING: You might not want to use this outside of Cargo.
2+
3+
* This is designed for testing Cargo itself. Use at your own risk.
4+
* No guarantee on any stability across versions.
5+
* No feature request would be accepted unless proved useful for testing Cargo.

crates/cargo-test-support/src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
//! # Cargo test support.
22
//!
33
//! See <https://rust-lang.github.io/cargo/contrib/> for a guide on writing tests.
4+
//!
5+
//! WARNING: You might not want to use this outside of Cargo.
6+
//!
7+
//! * This is designed for testing Cargo itself. Use at your own risk.
8+
//! * No guarantee on any stability across versions.
9+
//! * No feature request would be accepted unless proved useful for testing Cargo.
410
511
#![allow(clippy::disallowed_methods)]
612
#![allow(clippy::print_stderr)]

0 commit comments

Comments
 (0)