about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorLaurențiu Nicola <lnicola@dend.ro>2023-02-21 12:22:38 +0200
committerLaurențiu Nicola <lnicola@dend.ro>2023-02-21 12:43:22 +0200
commit563bd9c24a0620906e4640f57262ea33e48687f0 (patch)
tree21cf789359d0d6abc98d623b0deef9c7a8f6e386 /docs
parente59ada921fcc4a218a1489100c69f5af35b98736 (diff)
downloadrust-563bd9c24a0620906e4640f57262ea33e48687f0.tar.gz
rust-563bd9c24a0620906e4640f57262ea33e48687f0.zip
Try to improve the rustfmt.overrideCommand docs
Diffstat (limited to 'docs')
-rw-r--r--docs/user/generated_config.adoc5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc
index 50e3670a7a8..ed7df3eac3d 100644
--- a/docs/user/generated_config.adoc
+++ b/docs/user/generated_config.adoc
@@ -699,7 +699,10 @@ Additional arguments to `rustfmt`.
 +
 --
 Advanced option, fully override the command rust-analyzer uses for
-formatting.
+formatting. This should be the equivalent of `rustfmt` here, and
+not that of `cargo fmt`. The file contents will be passed on the
+standard input and the formatted result will be read from the
+standard output.
 --
 [[rust-analyzer.rustfmt.rangeFormatting.enable]]rust-analyzer.rustfmt.rangeFormatting.enable (default: `false`)::
 +