Skip to contentSkip to conversation

Makefile: rust-analyzer target: better error handling and comments

PATCH Superseded John Hubbard 4 participants 7 messages Jun 1, 2024 – Jun 20, 2024

Subsystems (2)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Makefile: rust-analyzer target: better error handling and comments

1) Provide a more self-explanatory error message for the "Rust not available" case. Without this patch, if Rust is not set up properly (which happens a lot, seeing as how one must routinely run "rustup override ..." with each new kernel release), the "make rust-analyzer" invocation generates a somewhat confusing message:

"No rule to make target 'rust-analyzer"

This is confusing at first, because there is, in fact, a rust-analyzer build target. It's just not set up to handle errors gracefully.

Instead of inflicting that on the developer, just print that Rust is not available, with a blank line above and below, so it doesn't get lost in the noise. Now the error case looks like this:

    $ make rust-analyzer
    Rust is not available

    make[1]: *** [/kernel_work/linux-github/Makefile:1975: rust-analyzer] Error 1
    make: *** [Makefile:240: __sub-make] Error 2

2) As long as I'm there, also add some documentation about what rust-analyzer provides.

---
 Makefile | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
Makefile +5 -1
index f975b6396328..aca2c96820aa 100644
@@ -1967,9 +1967,13 @@ quiet_cmd_tags = GEN     $@
 tags TAGS cscope gtags: FORCE
 	$(call cmd,tags)
 
-# IDE support targets
+# Generate rust-project.json, which does for Rust what clangd's
+# compile_commands.json does for C/C++: provides a browsing database for code
+# editors and IDEs.
 PHONY += rust-analyzer
 rust-analyzer:
+	$(Q)$(CONFIG_SHELL) $(srctree)/scripts/rust_is_available.sh 2>/dev/null || \
+	    { echo; echo "Rust is not available"; echo; false; }
 	$(Q)$(MAKE) $(build)=rust $@
 
 # Script to generate missing namespace dependencies

base-commit: b050496579632f86ee1ef7e7501906db579f3457

Signature · 1 line
2.45.1
reviewer Reviewed-by Tested-by on v1 1/1
#1 lore raw
Quoted 23 lines · John Hubbard

1) Provide a more self-explanatory error message for the "Rust not available" case. Without this patch, if Rust is not set up properly (which happens a lot, seeing as how one must routinely run "rustup override ..." with each new kernel release), the "make rust-analyzer" invocation generates a somewhat confusing message:

"No rule to make target 'rust-analyzer"

This is confusing at first, because there is, in fact, a rust-analyzer build target. It's just not set up to handle errors gracefully.

Instead of inflicting that on the developer, just print that Rust is not available, with a blank line above and below, so it doesn't get lost in the noise. Now the error case looks like this:

    $ make rust-analyzer
    Rust is not available

    make[1]: *** [/kernel_work/linux-github/Makefile:1975: rust-analyzer] Error 1
    make: *** [Makefile:240: __sub-make] Error 2
Quoted 4 lines

2) As long as I'm there, also add some documentation about what rust-analyzer provides.

Acked-by on v1 1/1
#2 lore raw
In reply to John Hubbard
Quoted 2 lines · John Hubbard

Rust is not available

Maybe we should use the *** notation that is used elsewhere?

Quoted 2 lines

2) As long as I'm there, also add some documentation about what rust-analyzer provides.

Perhaps this could go in a separate patch.

But those are nits -- if Masahiro is OK with this approach:

Happy to take it too.

Cheers,
Miguel

#3 lore raw
Quoted 5 lines · Miguel Ojeda
Quoted 2 lines · John Hubbard

Rust is not available

Maybe we should use the *** notation that is used elsewhere?

What exactly did you have in mind for how that should look? The "make rustavailable" target has some leading *** and some bare statements, so I'm not quite sure exactly how to lay it out:

$ make rustavailable
***
*** Rust bindings generator 'bindgen' is too new. This may or may not work.
***   Your version:     0.69.4
***   Expected version: 0.65.1
***
***
*** Please see Documentation/rust/quick-start.rst for details
*** on how to set up the Rust support.
***
Rust is available!
Quoted 5 lines
Quoted 3 lines

2) As long as I'm there, also add some documentation about what rust-analyzer provides.

Perhaps this could go in a separate patch.

Sure, I'll split it out if you all prefer.

Quoted 9 lines

But those are nits -- if Masahiro is OK with this approach:

Happy to take it too.

Cheers,
Miguel

thanks,

Signature · 2 lines
John Hubbard
NVIDIA
#4 lore raw
Quoted 4 lines · John Hubbard

What exactly did you have in mind for how that should look? The "make rustavailable" target has some leading *** and some bare statements, so I'm not quite sure exactly how to lay it out:

I was thinking something like:

    ***
    *** Rust is not available.
    ***

(the *** prefix is used also in other similar scripts and by Make itself).

However, thinking about it a bit more, we should perhaps just let rust_is_available.sh tell the user why it fails, since it is likely the next step the user would do anyway:

    $ make LLVM=1 rust-analyzer
    ***
    *** Rust compiler 'rustc' is too old.
    ***   Your version:    1.62.0
    ***   Minimum version: 1.78.0
    ***
    ***
    *** Please see Documentation/rust/quick-start.rst for details
    *** on how to set up the Rust support.
    ***
    make[1]: *** [linux/Makefile:1973: rust-analyzer] Error 1
    make: *** [Makefile:240: __sub-make] Error 2

What do you think? Then there is no need for extra output here and the patch becomes simpler too.

The bare statement we have there for the successful case was mainly so that the explicit make rustavailable did not look empty if there was no issue, i.e. we don't print anything extra when there is an error (and if we wanted to print something for the failure case, then we should probably do it in the script, rather than here).

Cheers,
Miguel

#5 lore raw
Quoted 31 lines · Miguel Ojeda
Quoted 4 lines · John Hubbard

What exactly did you have in mind for how that should look? The "make rustavailable" target has some leading *** and some bare statements, so I'm not quite sure exactly how to lay it out:

I was thinking something like:

    ***
    *** Rust is not available.
    ***

(the *** prefix is used also in other similar scripts and by Make itself).

However, thinking about it a bit more, we should perhaps just let rust_is_available.sh tell the user why it fails, since it is likely the next step the user would do anyway:

    $ make LLVM=1 rust-analyzer
    ***
    *** Rust compiler 'rustc' is too old.
    ***   Your version:    1.62.0
    ***   Minimum version: 1.78.0
    ***
    ***
    *** Please see Documentation/rust/quick-start.rst for details
    *** on how to set up the Rust support.
    ***
    make[1]: *** [linux/Makefile:1973: rust-analyzer] Error 1
    make: *** [Makefile:240: __sub-make] Error 2
Quoted 2 lines

What do you think? Then there is no need for extra output here and the patch becomes simpler too.

As someone who just ran into the "wait, how do I get rust to build on this machine again?" problem, yes, having the link to the documentation right there would be helpful. I did know where to find it, but others might not, and it's free to add.

thanks,

greg k-h

#6 lore raw
Quoted 32 lines · Greg KH
Quoted 31 lines · Miguel Ojeda
Quoted 4 lines · John Hubbard

What exactly did you have in mind for how that should look? The "make rustavailable" target has some leading *** and some bare statements, so I'm not quite sure exactly how to lay it out:

I was thinking something like:

     ***
     *** Rust is not available.
     ***

(the *** prefix is used also in other similar scripts and by Make itself).

However, thinking about it a bit more, we should perhaps just let rust_is_available.sh tell the user why it fails, since it is likely the next step the user would do anyway:

     $ make LLVM=1 rust-analyzer
     ***
     *** Rust compiler 'rustc' is too old.
     ***   Your version:    1.62.0
     ***   Minimum version: 1.78.0
     ***
     ***
     *** Please see Documentation/rust/quick-start.rst for details
     *** on how to set up the Rust support.
     ***
     make[1]: *** [linux/Makefile:1973: rust-analyzer] Error 1
     make: *** [Makefile:240: __sub-make] Error 2
Quoted 2 lines
Quoted 2 lines

What do you think? Then there is no need for extra output here and the patch becomes simpler too.

Yes, that's perfect, actually.

Quoted 8 lines

As someone who just ran into the "wait, how do I get rust to build on this machine again?" problem, yes, having the link to the documentation right there would be helpful. I did know where to find it, but others might not, and it's free to add.

thanks,

greg k-h

Right, we get this for free by just letting scripts/rust_is_available.sh report its results "out loud".

I'll post a v2, and with the comment part split into a separate patch as requested.

thanks,

Signature · 2 lines
John Hubbard
NVIDIA