diff options
| author | Tamir Duberstein <tamird@gmail.com> | 2025-02-10 12:03:24 -0500 | 
|---|---|---|
| committer | Miguel Ojeda <ojeda@kernel.org> | 2025-03-11 23:37:45 +0100 | 
| commit | 2e0f91aba507a3cb59f7a12fc3ea2b7d4d6675b7 (patch) | |
| tree | c0bbf43205cde1dd25e3e51d66d2bc688f0a861d | |
| parent | 5daa0c35a1f0e7a6c3b8ba9cb721e7d1ace6e619 (diff) | |
scripts: generate_rust_analyzer: add missing macros deps
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.
  [ Fiona had a different approach (thanks!) at:
        https://lore.kernel.org/rust-for-linux/20241205115438.234221-1-me@kloenk.dev/
    But Tamir and Fiona agreed to this one. - Miguel ]
Fixes: 8c4555ccc55c ("scripts: add `generate_rust_analyzer.py`")
Reviewed-by: Fiona Behrens <me@kloenk.dev>
Diagnosed-by: Chayim Refael Friedman <chayimfr@gmail.com>
Link: https://github.com/rust-lang/rust-analyzer/issues/17759#issuecomment-2646328275
Signed-off-by: Tamir Duberstein <tamird@gmail.com>
Tested-by: Andreas Hindborg <a.hindborg@kernel.org>
Link: https://lore.kernel.org/r/20250210-rust-analyzer-macros-core-dep-v3-1-45eb4836f218@gmail.com
[ Removed `return`. Changed tag name. Added Link. Slightly
  reworded. - Miguel ]
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
| -rwxr-xr-x | scripts/generate_rust_analyzer.py | 30 | 
1 files changed, 21 insertions, 9 deletions
| diff --git a/scripts/generate_rust_analyzer.py b/scripts/generate_rust_analyzer.py index aa8ea1a4dbe5..b40679a90843 100755 --- a/scripts/generate_rust_analyzer.py +++ b/scripts/generate_rust_analyzer.py @@ -57,14 +57,26 @@ 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, -    ) +    def append_sysroot_crate( +        display_name, +        deps, +        cfg=[], +    ): +        append_crate( +            display_name, +            sysroot_src / display_name / "src" / "lib.rs", +            deps, +            cfg, +            is_workspace_member=False, +        ) + +    # 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)`. +    append_sysroot_crate("core", [], cfg=crates_cfgs.get("core", [])) +    append_sysroot_crate("alloc", ["core"]) +    append_sysroot_crate("std", ["alloc", "core"]) +    append_sysroot_crate("proc_macro", ["core", "std"])      append_crate(          "compiler_builtins", @@ -75,7 +87,7 @@ def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs):      append_crate(          "macros",          srctree / "rust" / "macros" / "lib.rs", -        [], +        ["std", "proc_macro"],          is_proc_macro=True,      ) | 
