Re: [PATCH] docs: update rust-analyzer command
From: Gary Guo
Date: Wed May 13 2026 - 07:05:19 EST
On Wed May 13, 2026 at 10:19 AM BST, Onur Özkan wrote:
> On a fresh checkout, generating rust-project.json alone is not enough
> for rust-analyzer to work reliably. The issue only becomes apparent
> later when the LSP fails on a proc macro or binding types/functions.
>
> Recommend running prepare together with the rust-analyzer target so the
> generated files expected by rust-analyzer are available from the start.
This should be fixed by marking `prepare` as a dependency of `rust-analyzer`
instead.
Best,
Gary
>
> Link: https://rust-for-linux.zulipchat.com/#narrow/channel/597064-rust-analyzer
> Signed-off-by: Onur Özkan <work@xxxxxxxxxxxxx>
> ---
> Documentation/rust/quick-start.rst | 2 +-
> Documentation/translations/zh_CN/rust/quick-start.rst | 2 +-
> 2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst
> index a6ec3fa94d33..df5b54b51deb 100644
> --- a/Documentation/rust/quick-start.rst
> +++ b/Documentation/rust/quick-start.rst
> @@ -314,7 +314,7 @@ definition, and other features.
> ``rust-analyzer`` needs a configuration file, ``rust-project.json``, which
> can be generated by the ``rust-analyzer`` Make target::
>
> - make LLVM=1 rust-analyzer
> + make LLVM=1 prepare rust-analyzer
>
>
> Configuration
> diff --git a/Documentation/translations/zh_CN/rust/quick-start.rst b/Documentation/translations/zh_CN/rust/quick-start.rst
> index 5f0ece6411f5..3f7efd3a63ad 100644
> --- a/Documentation/translations/zh_CN/rust/quick-start.rst
> +++ b/Documentation/translations/zh_CN/rust/quick-start.rst
> @@ -291,7 +291,7 @@ rust-analyzer
> ``rust-analyzer`` 需要一个配置文件, ``rust-project.json``, 它可以由 ``rust-analyzer``
> Make 目标生成::
>
> - make LLVM=1 rust-analyzer
> + make LLVM=1 prepare rust-analyzer
>
>
> 配置