[PATCH v2 00/11] `scripts/rust_is_available.sh` improvements

Miguel Ojeda
2023-06-16T00:17:02Z

This is the patch series to improve `scripts/rust_is_available.sh`.

The major addition in v2 is the test suite in the last commit. I added
it because I wanted to have a proper way to test any further changes to
it (such as the suggested `set --` idea to avoid forking by Masahiro),
and so that adding new checks was easier to justify too (i.e. vs. the
added complexity).

In addition, there are also a few new checks in the script, to cover for
even some more cases, which hopefully make problematic setups easier to
identify and solve by users building the kernel. For instance, running
the script externally gives:

$ scripts/rust_is_available.sh
***
*** Environment variable 'RUSTC' is not set.
***
*** This script is intended to be called from Kbuild.
*** Please use the 'rustavailable' target to call it instead.
*** Otherwise, the results may not be meaningful.
***
*** Please see Documentation/rust/quick-start.rst for details
*** on how to set up the Rust support.
***

I also changed it to avoid setting `-e` as Masahiro suggested.
Similarly, I now check for `$RUSTC`, `$BINDGEN` and `$CC`, instead of
`$MAKEFLAGS`, as he also suggested (but I gave it their own error
message rather than use the `${CC?: is not set}` approach. This goes in
line with the reasons outlined above, i.e. trying to give users a clear
error of what step exactly failed).

In the test suite I included previously problematic compiler version
strings we got reports for. The test suite covers all current branches
in the script, and we should keep it that way in the future.

The patch series also include Masahiro's patch to remove the `-v`
option, as well as Russell's patch for supporting multiple arguments
in `$CC`.

All in all, this should solve all the issues we got so far (unless I
have missed something) and improve things further with the new checks
plus the test suite to hopefully have an easier time in the future.

Testers for this one are appreciated, especially if you have uncommon or
custom setups for building the kernel.

This could go through either the Kbuild or the Rust tree.

Masahiro Yamada (1):
kbuild: rust_is_available: remove -v option

Miguel Ojeda (9):
docs: rust: add paragraph about finding a suitable `libclang`
kbuild: rust_is_available: print docs reference
kbuild: rust_is_available: add check for `bindgen` invocation
kbuild: rust_is_available: check that environment variables are set
kbuild: rust_is_available: fix confusion when a version appears in the
path
kbuild: rust_is_available: normalize version matching
kbuild: rust_is_available: handle failures calling `$RUSTC`/`$BINDGEN`
kbuild: rust_is_available: check that output looks as expected
kbuild: rust_is_available: add test suite

Russell Currey (1):
kbuild: rust_is_available: fix version check when CC has multiple
arguments

Documentation/rust/quick-start.rst | 17 ++
Makefile | 4 +-
scripts/rust_is_available.sh | 233 +++++++++++++------
scripts/rust_is_available_test.py | 346 +++++++++++++++++++++++++++++
4 files changed, 532 insertions(+), 68 deletions(-)
create mode 100755 scripts/rust_is_available_test.py

base-commit: 858fd168a95c5b9669aac8db6c14a9aeab446375
--
2.41.0