Avoid filename collision in the monorepo structure

Warning: output filename collision appears in both stable and nightly builds.

It's slightly more impactful than just a warning. Running cargo +nightly
test, cargo test, cargo +nightly test in windows produces a linker error
where color-spantrace tries to use eyre's usage.exe, see error 2 below.
It's worked around pretty easily with cargo clean, but it's a problem
that might get worse as the monorepo effort expands!

This patch renames `usage.rs` to `CRATENAME-usage.rs`.

Issue #115
This commit is contained in:
nori li 2023-11-09 22:31:42 -08:00
parent 12479e96ef
commit 1fc5c56683
No known key found for this signature in database
4 changed files with 8 additions and 8 deletions

View File

@ -55,7 +55,7 @@ println!("{}", color_spantrace::colorize(&span_trace));
## Example
This example is taken from `examples/usage.rs`:
This example is taken from `examples/color-spantrace-usage.rs`:
```rust
use tracing::instrument;

View File

@ -45,17 +45,17 @@
//!
//! ## Output Format
//!
//! Running `examples/usage.rs` from the `color-spantrace` repo produces the following output:
//! Running `examples/color-spantrace-usage.rs` from the `color-spantrace` repo produces the following output:
//!
//! <pre><font color="#4E9A06"><b></b></font> cargo run --example usage
//! <pre><font color="#4E9A06"><b></b></font> cargo run --example color-spantrace-usage
//! <font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.04s
//! <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/usage`
//! <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/color-spantrace-usage`
//! ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ SPANTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
//!
//! 0: <font color="#F15D22">usage::two</font>
//! at <font color="#75507B">examples/usage.rs</font>:<font color="#75507B">18</font>
//! 1: <font color="#F15D22">usage::one</font> with <font color="#34E2E2">i=42</font>
//! at <font color="#75507B">examples/usage.rs</font>:<font color="#75507B">13</font></pre>
//! 0: <font color="#F15D22">color-spantrace-usage::two</font>
//! at <font color="#75507B">examples/color-spantrace-usage.rs</font>:<font color="#75507B">18</font>
//! 1: <font color="#F15D22">color-spantrace-usage::one</font> with <font color="#34E2E2">i=42</font>
//! at <font color="#75507B">examples/color-spantrace-usage.rs</font>:<font color="#75507B">13</font></pre>
//!
//! [`tracing_error::SpanTrace`]: https://docs.rs/tracing-error/*/tracing_error/struct.SpanTrace.html
//! [`color-backtrace`]: https://github.com/athre0z/color-backtrace