Skip to content

Commit 20d6441

Browse files
committed
Auto merge of #12951 - jonas-schievink:doc-cli-stability, r=Veykril
internal: Document CLI flag stability
2 parents 3805067 + fd00bd4 commit 20d6441

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

crates/rust-analyzer/src/cli/flags.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ xflags::xflags! {
1010
src "./src/cli/flags.rs"
1111

1212
/// LSP server for the Rust programming language.
13+
///
14+
/// Subcommands and their flags do not provide any stability guarantees and may be removed or
15+
/// changed without notice. Top-level flags that are not are marked as [Unstable] provide
16+
/// backwards-compatibility and may be relied on.
1317
cmd rust-analyzer {
1418
/// Verbosity level, can be repeated multiple times.
1519
repeated -v, --verbose
@@ -21,7 +25,7 @@ xflags::xflags! {
2125
/// Flush log records to the file immediately.
2226
optional --no-log-buffering
2327

24-
/// Wait until a debugger is attached to (requires debug build).
28+
/// [Unstable] Wait until a debugger is attached to (requires debug build).
2529
optional --wait-dbg
2630

2731
default cmd lsp-server {

0 commit comments

Comments
 (0)