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

Andrew Ballance posted 1 patch 1 year, 5 months ago
rust/kernel/firmware.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH v2] rust: firmware: fix invalid rustdoc link
Posted by Andrew Ballance 1 year, 5 months ago
remove an extra quote from the doc comment so that rustdoc
no longer genertes a link to a nonexistent file.

Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>
Reviewed-by: Danilo Krummrich <dakr@redhat.com>
Acked-by: Miguel Ojeda <ojeda@kernel.org>
Fixes: de6582833db0 ("rust: add firmware abstractions")
---
v1 -> v2: updated commit message

 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
Re: [PATCH v2] rust: firmware: fix invalid rustdoc link
Posted by Danilo Krummrich 1 year, 5 months ago
Hi Greg,

On Mon, Jul 08, 2024 at 07:44:26PM -0500, Andrew Ballance wrote:
> remove an extra quote from the doc comment so that rustdoc
> no longer genertes a link to a nonexistent file.
> 
> Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>
> Reviewed-by: Danilo Krummrich <dakr@redhat.com>
> Acked-by: Miguel Ojeda <ojeda@kernel.org>
> Fixes: de6582833db0 ("rust: add firmware abstractions")

Can you please pick this one up?

- Danilo

> ---
> v1 -> v2: updated commit message
> 
>  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
>
Re: [PATCH v2] rust: firmware: fix invalid rustdoc link
Posted by Greg KH 1 year, 5 months ago
On Sat, Jul 13, 2024 at 04:49:52PM +0200, Danilo Krummrich wrote:
> Hi Greg,
> 
> On Mon, Jul 08, 2024 at 07:44:26PM -0500, Andrew Ballance wrote:
> > remove an extra quote from the doc comment so that rustdoc
> > no longer genertes a link to a nonexistent file.
> > 
> > Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>
> > Reviewed-by: Danilo Krummrich <dakr@redhat.com>
> > Acked-by: Miguel Ojeda <ojeda@kernel.org>
> > Fixes: de6582833db0 ("rust: add firmware abstractions")
> 
> Can you please pick this one up?

Will do after -rc1 is out, sorry, my trees are closed now for the merge
window.

greg k-h