user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

internal: cleanup CLI flag documentation

Browse source
This commit is contained in:
David Barsky 2025-04-10 11:30:14 -04:00
parent 8f547bb82f
commit 9e50a3009f
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
src/tools/rust-analyzer/crates/rust-analyzer/src/cli/flags.rs
View file

@ -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