about summary refs log tree commit diff
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2022-08-08 11:56:44 +0000
committerbors <bors@rust-lang.org>2022-08-08 11:56:44 +0000
commit20d64412c0c3974708c8cb00d8c50c8a82d27191 (patch)
tree4a2ad1bfde51e785e310fcf7b1e0497c5660606b
parent3805067bf548f02f0fc2a709f2cdfb05cdbce314 (diff)
parentfd00bd4d3b96109dcd1b9fb2ebfeb3b747776ad1 (diff)
downloadrust-20d64412c0c3974708c8cb00d8c50c8a82d27191.tar.gz
rust-20d64412c0c3974708c8cb00d8c50c8a82d27191.zip
Auto merge of #12951 - jonas-schievink:doc-cli-stability, r=Veykril
internal: Document CLI flag stability
-rw-r--r--crates/rust-analyzer/src/cli/flags.rs6
1 files changed, 5 insertions, 1 deletions
diff --git a/crates/rust-analyzer/src/cli/flags.rs b/crates/rust-analyzer/src/cli/flags.rs
index 19907ebddb6..080e2fb4438 100644
--- a/crates/rust-analyzer/src/cli/flags.rs
+++ b/crates/rust-analyzer/src/cli/flags.rs
@@ -10,6 +10,10 @@ xflags::xflags! {
     src "./src/cli/flags.rs"
 
     /// LSP server for the Rust programming language.
+    ///
+    /// Subcommands and their flags do not provide any stability guarantees and may be removed or
+    /// changed without notice. Top-level flags that are not are marked as [Unstable] provide
+    /// backwards-compatibility and may be relied on.
     cmd rust-analyzer {
         /// Verbosity level, can be repeated multiple times.
         repeated -v, --verbose
@@ -21,7 +25,7 @@ xflags::xflags! {
         /// Flush log records to the file immediately.
         optional --no-log-buffering
 
-        /// Wait until a debugger is attached to (requires debug build).
+        /// [Unstable] Wait until a debugger is attached to (requires debug build).
         optional --wait-dbg
 
         default cmd lsp-server {