diff options
| author | Jonas Schievink <jonas.schievink@ferrous-systems.com> | 2022-08-05 15:28:53 +0200 |
|---|---|---|
| committer | Jonas Schievink <jonas.schievink@ferrous-systems.com> | 2022-08-05 15:28:53 +0200 |
| commit | fd00bd4d3b96109dcd1b9fb2ebfeb3b747776ad1 (patch) | |
| tree | 7bbfc0c8bf1177bf80b16948a7eac7a75d5945b1 | |
| parent | 97038e55cfa88eb43a3256d309df4053b7dd2a4e (diff) | |
| download | rust-fd00bd4d3b96109dcd1b9fb2ebfeb3b747776ad1.tar.gz rust-fd00bd4d3b96109dcd1b9fb2ebfeb3b747776ad1.zip | |
Document CLI flag stability
| -rw-r--r-- | crates/rust-analyzer/src/cli/flags.rs | 6 |
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 { |