Clarify --output's help text

This commit is contained in:
Tavian Barnes authored and David Peter committed 2022-05-17 22:30:45 +02:00
1 parent 277807cb5a
commit dfd1046d63
1 file changed
+6 -4
+6 -4
View File
@@ -266,10 +266,12 @@ fn build_command() -> Command<'static> {
.takes_value(true)
.value_name("WHERE")
.help(
"Control where the output of the benchmark is redirected.\n\n \
null: Redirect output to /dev/null (the default).\n\n \
pipe: Feed the output through a pipe before discarding it.\n \
Useful if the benchmark special-cases /dev/null.\n\n \
"Control where the output of the benchmark is redirected. <WHERE> can be:\n\n\
null: Redirect output to /dev/null (the default). \
Note that some programs like 'grep' detect when standard output is /dev/null \
and apply certain optimizations. To avoid that, consider using \
'--output=pipe'.\n\n\
pipe: Feed the output through a pipe before discarding it.\n\n\
<FILE>: Write the output to the given file.",
),
)