From 9e50a3009fd33beb024e48ab77ee751175d7356e Mon Sep 17 00:00:00 2001 From: David Barsky Date: Thu, 10 Apr 2025 11:30:14 -0400 Subject: [PATCH] internal: cleanup CLI flag documentation --- .../crates/rust-analyzer/src/cli/flags.rs | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/tools/rust-analyzer/crates/rust-analyzer/src/cli/flags.rs b/src/tools/rust-analyzer/crates/rust-analyzer/src/cli/flags.rs index 3675bd716945..57f95d114d9d 100644 --- a/src/tools/rust-analyzer/crates/rust-analyzer/src/cli/flags.rs +++ b/src/tools/rust-analyzer/crates/rust-analyzer/src/cli/flags.rs @@ -53,7 +53,7 @@ xflags::xflags! { /// Batch typecheck project and print summary statistics cmd analysis-stats { - /// Directory with Cargo.toml. + /// Directory with Cargo.toml or rust-project.json. required path: PathBuf optional --output format: OutputFormat @@ -74,7 +74,7 @@ xflags::xflags! { /// Don't run build scripts or load `OUT_DIR` values by running `cargo check` before analysis. optional --disable-build-scripts - /// Don't use expand proc macros. + /// Don't expand proc macros. optional --disable-proc-macros /// Run the proc-macro-srv binary at the specified path. optional --proc-macro-srv path: PathBuf @@ -101,7 +101,7 @@ xflags::xflags! { /// Run unit tests of the project using mir interpreter cmd run-tests { - /// Directory with Cargo.toml. + /// Directory with Cargo.toml or rust-project.json. required path: PathBuf } @@ -115,12 +115,12 @@ xflags::xflags! { } cmd diagnostics { - /// Directory with Cargo.toml. + /// Directory with Cargo.toml or rust-project.json. required path: PathBuf /// Don't run build scripts or load `OUT_DIR` values by running `cargo check` before analysis. optional --disable-build-scripts - /// Don't use expand proc macros. + /// Don't expand proc macros. optional --disable-proc-macros /// Run the proc-macro-srv binary at the specified path. optional --proc-macro-srv path: PathBuf @@ -128,25 +128,25 @@ xflags::xflags! { /// Report unresolved references cmd unresolved-references { - /// Directory with Cargo.toml. + /// Directory with Cargo.toml or rust-project.json. required path: PathBuf /// Don't run build scripts or load `OUT_DIR` values by running `cargo check` before analysis. optional --disable-build-scripts - /// Don't use expand proc macros. + /// Don't expand proc macros. optional --disable-proc-macros /// Run the proc-macro-srv binary at the specified path. optional --proc-macro-srv path: PathBuf } - /// prime caches, as rust-analyzer does typically at startup in interactive sessions. + /// Prime caches, as rust-analyzer does typically at startup in interactive sessions. cmd prime-caches { - /// Directory with Cargo.toml. + /// Directory with Cargo.toml or rust-project.json. required path: PathBuf /// Don't run build scripts or load `OUT_DIR` values by running `cargo check` before analysis. optional --disable-build-scripts - /// Don't use expand proc macros. + /// Don't expand proc macros. optional --disable-proc-macros /// Run the proc-macro-srv binary at the specified path. optional --proc-macro-srv path: PathBuf