Re: [PATCH v2] scripts: generate_rust_analyzer.py: add missing macros deps
From: Tamir Duberstein
Date: Sun Feb 09 2025 - 12:35:23 EST
On Sun, Feb 9, 2025 at 12:12 PM Tamir Duberstein <tamird@xxxxxxxxx> wrote:
>
> The macros crate has depended on std and proc_macro since its
> introduction in commit 1fbde52bde73 ("rust: add `macros` crate"). These
> dependencies were omitted from commit 8c4555ccc55c ("scripts: add
> `generate_rust_analyzer.py`") resulting in missing go-to-definition and
> autocomplete, and false-positive warnings emitted from rust-analyzer
> such as:
>
> [{
> "resource": "/Users/tamird/src/linux/rust/macros/module.rs",
> "owner": "_generated_diagnostic_collection_name_#1",
> "code": {
> "value": "non_snake_case",
> "target": {
> "$mid": 1,
> "path": "/rustc/",
> "scheme": "https",
> "authority": "doc.rust-lang.org",
> "query": "search=non_snake_case"
> }
> },
> "severity": 4,
> "message": "Variable `None` should have snake_case name, e.g. `none`",
> "source": "rust-analyzer",
> "startLineNumber": 123,
> "startColumn": 17,
> "endLineNumber": 123,
> "endColumn": 21
> }]
>
> Add the missing dependencies to improve the developer experience.
>
> Fixes: 8c4555ccc55c ("scripts: add `generate_rust_analyzer.py`")
> Suggested-by: Chayim Refael Friedman <chayimfr@xxxxxxxxx>
> Signed-off-by: Tamir Duberstein <tamird@xxxxxxxxx>
> ---
> Changes in v2:
> - Change macros deps from [core] to [std, proc_macro], improving
> autocomplete and go-to-definition.
> - Remove Wedson Almeida Filho <wedsonaf@xxxxxxxxxx> from cc; email
> bounced.
> - Link to v1: https://lore.kernel.org/r/20250209-rust-analyzer-macros-core-dep-v1-1-5ebeb3eb60a9@xxxxxxxxx
> ---
> scripts/generate_rust_analyzer.py | 28 ++++++++++++++++++----------
> 1 file changed, 18 insertions(+), 10 deletions(-)
>
> diff --git a/scripts/generate_rust_analyzer.py b/scripts/generate_rust_analyzer.py
> index aa8ea1a4dbe5..316174c22346 100755
> --- a/scripts/generate_rust_analyzer.py
> +++ b/scripts/generate_rust_analyzer.py
> @@ -57,25 +57,33 @@ def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs):
> crates_indexes[display_name] = len(crates)
> crates.append(crate)
>
> - # First, the ones in `rust/` since they are a bit special.
> - append_crate(
> - "core",
> - sysroot_src / "core" / "src" / "lib.rs",
> - [],
> - cfg=crates_cfgs.get("core", []),
> - is_workspace_member=False,
> - )
> -
> append_crate(
> "compiler_builtins",
> srctree / "rust" / "compiler_builtins.rs",
> [],
> )
>
> + # NB: sysroot crates reexport items from one another so setting up our transitive dependencies
> + # here is important for ensuring that rust-analyzer can resolve symbols. The sources of truth
> + # for this dependency graph are `(sysroot_src / crate / "Cargo.toml" for crate in crates)`.
> + for crate, deps in [
> + ("core", []),
> + ("alloc", ["compiler_builtins", "core"]),
> + ("std", ["alloc", "compiler_builtins", "core"]),
> + ("proc_macro", ["core", "std"]),
> + ]:
> + append_crate(
> + crate,
> + sysroot_src / crate / "src" / "lib.rs",
> + deps=deps,
> + cfg=crates_cfgs.get(crate, []),
> + is_workspace_member=False,
> + )
> +
> append_crate(
> "macros",
> srctree / "rust" / "macros" / "lib.rs",
> - [],
> + ["std", "proc_macro"],
> is_proc_macro=True,
> )
>
>
> ---
> base-commit: 6273a058383e05465083b535ed9469f2c8a48321
> change-id: 20250209-rust-analyzer-macros-core-dep-0f57868dd19f
>
> Best regards,
> --
> Tamir Duberstein <tamird@xxxxxxxxx>
>
Adding Danilo and Lukas, missed from v1.