docs(irtt-cli): expand duration flag documentation

Add detailed help text to clarify the difference in statistics handling between finite and continuous test modes.
This commit is contained in:
Nils Andreas Svee committed 2026-05-13 21:36:30 +07:00
1 parent 480cb4fa92
commit c19dac5aef
1 file changed
+7 -2
+7 -2
View File
@@ -24,8 +24,13 @@ pub struct CliArgs {
/// Server address or host, with optional port. /// Server address or host, with optional port.
pub server: String, pub server: String,
/// Test duration; use 0 for continuous mode. #[arg(
#[arg(long, default_value = "10s", value_parser = parse_test_duration)] long,
default_value = "10s",
value_parser = parse_test_duration,
help = "Test duration; use 0 for continuous mode",
long_help = "Test duration; use 0 for continuous mode.\n\nFinite runs retain exact statistics for final summaries. Continuous mode uses bounded-memory running statistics and does not print a finite summary."
)]
pub duration: Duration, pub duration: Duration,
/// Probe interval. /// Probe interval.