about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorWilfred Hughes <wilfred@meta.com>2023-10-04 10:34:34 -0400
committerLukas Wirth <lukastw97@gmail.com>2024-02-12 15:45:48 +0100
commitcdbf54f4bd6a20c782fa9a3a7d30f97906ecd2bf (patch)
treec90b7e21aecf7fb722fa340669aa805594ee7c94 /docs
parent47b4dd72730e1b3d475cee8361faf47b79b0f583 (diff)
downloadrust-cdbf54f4bd6a20c782fa9a3a7d30f97906ecd2bf.tar.gz
rust-cdbf54f4bd6a20c782fa9a3a7d30f97906ecd2bf.zip
flycheck: initial implementation of `$saved_file`
If the custom command has a $saved_file placeholder, and we know the
file being saved, replace the placeholder and then run a check command.

If there's a placeholder and we don't know the saved file, do nothing.
Diffstat (limited to 'docs')
-rw-r--r--docs/user/generated_config.adoc5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc
index a86ef709411..b9e82c5527b 100644
--- a/docs/user/generated_config.adoc
+++ b/docs/user/generated_config.adoc
@@ -234,6 +234,11 @@ each of them, with the working directory being the workspace root
 by changing `#rust-analyzer.check.invocationStrategy#` and
 `#rust-analyzer.check.invocationLocation#`.
 
+If `$saved_file` is part of the command, rust-analyzer will pass
+the absolute path of the saved file to the provided command. This is
+intended to be used with non-Cargo build systems.
+Note that `$saved_file` is experimental and may be removed in the futureg.
+
 An example command would be:
 
 ```bash