Rename feature gate test to std-stream-captured

Author: SpriteOvO

.github/workflows/ci.yml

@@ -65,7 +65,7 @@ jobs:
       matrix:
         os: ['ubuntu-latest', 'windows-latest', 'macos-latest']
         fn_features: ['', 'log native libsystemd multi-thread runtime-pattern serde serde_json sval']
-        cfg_feature: ['', 'flexible-string', 'source-location', 'test']
+        cfg_feature: ['', 'flexible-string', 'source-location', 'std-stream-captured']
     runs-on: ${{ matrix.os }}
     steps:
     - name: Checkout repository

justfile

@@ -11,7 +11,7 @@ fmt *ARGS:
 test *ARGS:
     cargo test \
       --features 'log native libsystemd multi-thread runtime-pattern serde serde_json sval' \
-      --features 'flexible-string source-location test' \
+      --features 'flexible-string source-location std-stream-captured' \
       {{ ARGS }}
 
 clippy *ARGS:

spdlog/Cargo.toml

@@ -34,7 +34,7 @@ release-level-info     = []
 release-level-debug    = []
 release-level-trace    = []
 
-test = []
+std-stream-captured = []
 source-location = []
 native = []
 libsystemd = ["dep:libsystemd-sys"]

spdlog/src/lib.rs

@@ -216,8 +216,9 @@
 //!
 //!  - `serde_json` enables [`formatter::JsonFormatter`].
 //!
-//!  - `test` changes the default behavior of [`StdStreamSink`] to use print
-//!    macros. See [`StdStreamSinkBuilder::via_print_macro`] for more details.
+//!  - `std-stream-captured` changes the default behavior of [`StdStreamSink`]
+//!    to use print macros. See [`StdStreamSinkBuilder::via_print_macro`] for
+//!    more details.
 //!
 //! # Supported Rust versions
 //!

spdlog/src/sink/std_stream_sink.rs

@@ -135,15 +135,15 @@ pub struct StdStreamSink {
 impl StdStreamSink {
     /// Gets a builder of `StdStreamSink` with default parameters:
     ///
-    /// | Parameter         | Default Value                                        |
-    /// |-------------------|------------------------------------------------------|
-    /// | [level_filter]    | [`LevelFilter::All`]                                 |
-    /// | [formatter]       | [`FullFormatter`]                                    |
-    /// | [error_handler]   | [`ErrorHandler::default()`]                          |
-    /// |                   |                                                      |
-    /// | [std_stream]      | *must be specified*                                  |
-    /// | [style_mode]      | [`StyleMode::Auto`]                                  |
-    /// | [via_print_macro] | `false`, or `true` if feature gate `test` is enabled |
+    /// | Parameter         | Default Value                                                       |
+    /// |-------------------|---------------------------------------------------------------------|
+    /// | [level_filter]    | [`LevelFilter::All`]                                                |
+    /// | [formatter]       | [`FullFormatter`]                                                   |
+    /// | [error_handler]   | [`ErrorHandler::default()`]                                         |
+    /// |                   |                                                                     |
+    /// | [std_stream]      | *must be specified*                                                 |
+    /// | [style_mode]      | [`StyleMode::Auto`]                                                 |
+    /// | [via_print_macro] | `false`, or `true` if feature gate `std-stream-captured` is enabled |
     ///
     /// [level_filter]: StdStreamSinkBuilder::level_filter
     /// [formatter]: StdStreamSinkBuilder::formatter
@@ -158,7 +158,7 @@ impl StdStreamSink {
             prop: SinkProp::default(),
             std_stream: (),
             style_mode: StyleMode::Auto,
-            via_print_macro: cfg!(feature = "test"),
+            via_print_macro: cfg!(feature = "std-stream-captured"),
         }
     }
 
@@ -334,7 +334,7 @@ impl<ArgSS> StdStreamSinkBuilder<ArgSS> {
     /// test` and `cargo bench`.
     ///
     /// This parameter is **optional**, and defaults to `false`, or defaults to
-    /// `true` if feature gate `test` is enabled.
+    /// `true` if feature gate `std-stream-captured` is enabled.
     ///
     /// A convienient way to enable it for `cargo test` and `cargo bench` is to
     /// add the following lines to your `Cargo.toml`:
@@ -343,7 +343,7 @@ impl<ArgSS> StdStreamSinkBuilder<ArgSS> {
     /// # Note that it's not [dependencies]
     ///
     /// [dev-dependencies]
-    /// spdlog-rs = { version = "...", features = ["test"] }
+    /// spdlog-rs = { version = "...", features = ["std-stream-captured"] }
     /// ```
     ///
     /// [captured]: https://doc.rust-lang.org/book/ch11-02-running-tests.html#showing-function-output

spdlog/tests/broken_stdio.rs

@@ -5,13 +5,13 @@
 
 #[cfg(target_os = "linux")]
 fn main() {
-    #[cfg(not(feature = "test"))]
+    #[cfg(not(feature = "std-stream-captured"))]
     run(); // Should not panic
 
-    // Expect this test to panic when the "test" feature is enabled, because we
-    // intentionally use print macros in `StdStreamSink` for capturing output
-    // for `cargo test`.
-    #[cfg(feature = "test")]
+    // Expect this test to panic when the "std-stream-captured" feature is enabled,
+    // because we intentionally use print macros in `StdStreamSink` for capturing
+    // output for `cargo test` and/or `cargo bench`.
+    #[cfg(feature = "std-stream-captured")]
     assert!(std::panic::catch_unwind(run).is_err());
 
     fn run() {