* [PATCH 1/2] scripts: generate_rust_analyzer.py: add missing include_dirs
2025-02-10 17:55 [PATCH 0/2] rust: fix rust-analyzer configuration for generated files Tamir Duberstein
@ 2025-02-10 17:55 ` Tamir Duberstein
2025-02-10 17:55 ` [PATCH 2/2] scripts: generate_rust_analyzer.py: add uapi crate Tamir Duberstein
2025-03-11 23:19 ` [PATCH 0/2] rust: fix rust-analyzer configuration for generated files Miguel Ojeda
2 siblings, 0 replies; 6+ messages in thread
From: Tamir Duberstein @ 2025-02-10 17:55 UTC (permalink / raw)
To: Miguel Ojeda, Alex Gaynor, Boqun Feng, Gary Guo,
Björn Roy Baron, Benno Lossin, Andreas Hindborg, Alice Ryhl,
Trevor Gross, Kees Cook, Fiona Behrens, Martin Rodriguez Reboredo,
Asahi Lina
Cc: Boris-Chengbiao Zhou, rust-for-linux, linux-kernel,
Tamir Duberstein
Commit 8c4555ccc55c ("scripts: add `generate_rust_analyzer.py`")
specified OBJTREE for the bindings crate, and `source.include_dirs` for
the kernel crate, likely in an attempt to support out-of-source builds
for those crates where the generated files reside in `objtree` rather
than `srctree`. This was insufficient because both bits of configuration
are required for each crate; the result is that rust-analyzer is unable
to resolve generated files for either crate in an out-of-source build.
Add the missing bits to improve the developer experience.
Fixes: 8c4555ccc55c ("scripts: add `generate_rust_analyzer.py`")
Signed-off-by: Tamir Duberstein <tamird@gmail.com>
---
scripts/generate_rust_analyzer.py | 40 +++++++++++++++++++--------------------
1 file changed, 20 insertions(+), 20 deletions(-)
diff --git a/scripts/generate_rust_analyzer.py b/scripts/generate_rust_analyzer.py
index aa8ea1a4dbe5..1f573d19cd99 100755
--- a/scripts/generate_rust_analyzer.py
+++ b/scripts/generate_rust_analyzer.py
@@ -85,27 +85,27 @@ def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs):
["core", "compiler_builtins"],
)
- append_crate(
- "bindings",
- srctree / "rust"/ "bindings" / "lib.rs",
- ["core"],
- cfg=cfg,
- )
- crates[-1]["env"]["OBJTREE"] = str(objtree.resolve(True))
+ def append_crate_with_generated(
+ display_name,
+ deps,
+ ):
+ append_crate(
+ display_name,
+ srctree / "rust"/ display_name / "lib.rs",
+ deps,
+ cfg=cfg,
+ )
+ crates[-1]["env"]["OBJTREE"] = str(objtree.resolve(True))
+ crates[-1]["source"] = {
+ "include_dirs": [
+ str(srctree / "rust" / display_name),
+ str(objtree / "rust")
+ ],
+ "exclude_dirs": [],
+ }
- append_crate(
- "kernel",
- srctree / "rust" / "kernel" / "lib.rs",
- ["core", "macros", "build_error", "bindings"],
- cfg=cfg,
- )
- crates[-1]["source"] = {
- "include_dirs": [
- str(srctree / "rust" / "kernel"),
- str(objtree / "rust")
- ],
- "exclude_dirs": [],
- }
+ append_crate_with_generated("bindings", ["core"])
+ append_crate_with_generated("kernel", ["core", "macros", "build_error", "bindings"])
def is_root_crate(build_file, target):
try:
--
2.48.1
^ permalink raw reply related [flat|nested] 6+ messages in thread* [PATCH 2/2] scripts: generate_rust_analyzer.py: add uapi crate
2025-02-10 17:55 [PATCH 0/2] rust: fix rust-analyzer configuration for generated files Tamir Duberstein
2025-02-10 17:55 ` [PATCH 1/2] scripts: generate_rust_analyzer.py: add missing include_dirs Tamir Duberstein
@ 2025-02-10 17:55 ` Tamir Duberstein
2025-02-10 18:02 ` Tamir Duberstein
2025-03-11 23:19 ` [PATCH 0/2] rust: fix rust-analyzer configuration for generated files Miguel Ojeda
2 siblings, 1 reply; 6+ messages in thread
From: Tamir Duberstein @ 2025-02-10 17:55 UTC (permalink / raw)
To: Miguel Ojeda, Alex Gaynor, Boqun Feng, Gary Guo,
Björn Roy Baron, Benno Lossin, Andreas Hindborg, Alice Ryhl,
Trevor Gross, Kees Cook, Fiona Behrens, Martin Rodriguez Reboredo,
Asahi Lina
Cc: Boris-Chengbiao Zhou, rust-for-linux, linux-kernel,
Tamir Duberstein
Commit 4e1746656839 ("rust: uapi: Add UAPI crate") did not update
rust-analyzer to include the new crate.
Add the missing definition to improve the developer experience.
Fixes: 4e1746656839 ("rust: uapi: Add UAPI crate")
Signed-off-by: Tamir Duberstein <tamird@gmail.com>
---
scripts/generate_rust_analyzer.py | 1 +
1 file changed, 1 insertion(+)
diff --git a/scripts/generate_rust_analyzer.py b/scripts/generate_rust_analyzer.py
index 1f573d19cd99..ee4f01ada277 100755
--- a/scripts/generate_rust_analyzer.py
+++ b/scripts/generate_rust_analyzer.py
@@ -105,6 +105,7 @@ def generate_crates(srctree, objtree, sysroot_src, external_src, cfgs):
}
append_crate_with_generated("bindings", ["core"])
+ append_crate_with_generated("uapi", ["core"])
append_crate_with_generated("kernel", ["core", "macros", "build_error", "bindings"])
def is_root_crate(build_file, target):
--
2.48.1
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [PATCH 0/2] rust: fix rust-analyzer configuration for generated files
2025-02-10 17:55 [PATCH 0/2] rust: fix rust-analyzer configuration for generated files Tamir Duberstein
2025-02-10 17:55 ` [PATCH 1/2] scripts: generate_rust_analyzer.py: add missing include_dirs Tamir Duberstein
2025-02-10 17:55 ` [PATCH 2/2] scripts: generate_rust_analyzer.py: add uapi crate Tamir Duberstein
@ 2025-03-11 23:19 ` Miguel Ojeda
2025-03-11 23:21 ` Miguel Ojeda
2 siblings, 1 reply; 6+ messages in thread
From: Miguel Ojeda @ 2025-03-11 23:19 UTC (permalink / raw)
To: Tamir Duberstein
Cc: Miguel Ojeda, Alex Gaynor, Boqun Feng, Gary Guo,
Björn Roy Baron, Benno Lossin, Andreas Hindborg, Alice Ryhl,
Trevor Gross, Kees Cook, Fiona Behrens, Martin Rodriguez Reboredo,
Asahi Lina, Boris-Chengbiao Zhou, rust-for-linux, linux-kernel
On Mon, Feb 10, 2025 at 6:56 PM Tamir Duberstein <tamird@gmail.com> wrote:
>
> The individual patches should be descriptive on their own. They are
> included in a single series because the second patch uses a function
> introduced in the first.
>
> I've confirmed this allows me to navigate to symbols defined in
> generated files as well as to the generated files themselves. I am using
> an out-of-source build.
>
> Signed-off-by: Tamir Duberstein <tamird@gmail.com>
Applied to `rust-fixes` -- thanks everyone!
[ Originally we were not using `OBJTREE` in the `kernel` crate, but
we did pass the variable anyway, so conceptually it could have been
there since then.
Regarding `include_dirs`, it started in `kernel` before being in
mainline because we included the bindings directly there (i.e.
there was no `bindings` crate). However, when that crate got
created, we moved the `OBJTREE` there but not the `include_dirs`.
Nowadays, though, we happen to need the `include_dirs` also in
the `kernel` crate for `generated_arch_static_branch_asm.rs` which
was not there back then -- Tamir confirms it is indeed required
for that reason. - Miguel ]
[ Slightly reworded title. - Miguel ]
[ Slightly reworded title. - Miguel ]
Cheers,
Miguel
^ permalink raw reply [flat|nested] 6+ messages in thread