firmware_loader: annotate doctests as `no_run`
authorDanilo Krummrich <dakr@redhat.com>
Mon, 8 Jul 2024 20:07:20 +0000 (22:07 +0200)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Wed, 10 Jul 2024 07:35:09 +0000 (09:35 +0200)
commit2c61b8c51d21d1b10c2881aa9c9918ff49f6fb7d
tree99038da49ad49032d00938f84433890dad04b2bd
parent997197b58bf6e22b8c6ef88a168d8292fa9acec9
firmware_loader: annotate doctests as `no_run`

The doctests of `Firmware` are compile-time only tests, since they
require a proper `Device` and a valid path to a (firmware) blob in order
to do something sane on runtime - we can't satisfy both of those
requirements.

Hence, configure the example as `no_run`.

Unfortunately, the kernel's Rust build system can't consider the
`no_run` attribute yet. Hence, for the meantime, wrap the example code
into a new function and never actually call it.

Fixes: de6582833db0 ("rust: add firmware abstractions")
Signed-off-by: Danilo Krummrich <dakr@redhat.com>
Link: https://lore.kernel.org/r/20240708200724.3203-1-dakr@redhat.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
rust/kernel/firmware.rs