Document CLI flag stability

This commit is contained in:
Jonas Schievink 2022-08-05 15:28:53 +02:00
parent 97038e55cf
commit fd00bd4d3b

View File

@ -10,6 +10,10 @@
src "./src/cli/flags.rs" src "./src/cli/flags.rs"
/// LSP server for the Rust programming language. /// 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 { cmd rust-analyzer {
/// Verbosity level, can be repeated multiple times. /// Verbosity level, can be repeated multiple times.
repeated -v, --verbose repeated -v, --verbose
@ -21,7 +25,7 @@
/// Flush log records to the file immediately. /// Flush log records to the file immediately.
optional --no-log-buffering 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 optional --wait-dbg
default cmd lsp-server { default cmd lsp-server {