Re: [PATCH] rust: firmware: fix invalid rustdoc link

Danilo Krummrich
2024-07-08T11:24:42Z

+ Greg

On Mon, Jul 08, 2024 at 04:06:15AM -0500, Andrew Ballance wrote:
> rustdoc generates a link to a nonexistent file because of a extra quote

Please use the imperative like you did in the summary and write a full sentence,
e.g. "Remove an extra quote in the doc comment in order to prevent rustdoc from
generating a link to a non-existent file."

>
> Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>

With that,

Reviewed-by: Danilo Krummrich <dakr@redhat.com>

> ---
> rust/kernel/firmware.rs | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/rust/kernel/firmware.rs b/rust/kernel/firmware.rs
> index 386c8fb44785..763d7cbefab5 100644
> --- a/rust/kernel/firmware.rs
> +++ b/rust/kernel/firmware.rs
> @@ -2,7 +2,7 @@
>
> //! Firmware abstraction
> //!
> -//! C header: [`include/linux/firmware.h`](srctree/include/linux/firmware.h")
> +//! C header: [`include/linux/firmware.h`](srctree/include/linux/firmware.h)
>
> use crate::{bindings, device::Device, error::Error, error::Result, str::CStr};
> use core::ptr::NonNull;
> --
> 2.45.2
>