rustdoc generates a link to a nonexistent file because of a extra quote

Signed-off-by: Andrew Ballance <andrewjballance@gmail.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

+ 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
>

On Mon, Jul 8, 2024 at 11:07 AM Andrew Ballance
<andrewjballance@gmail.com> wrote:
>
> rustdoc generates a link to a nonexistent file because of a extra quote
>
> Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>

Thanks for the patch!

I guess this is meant for staging/rust-device, but I think this should
be a review comment here:

    https://lore.kernel.org/rust-for-linux/20240618154841.6716-3-dakr@redhat.com/

Cheers,
Miguel

On Mon, Jul 08, 2024 at 11:16:34AM +0200, Miguel Ojeda wrote:
> On Mon, Jul 8, 2024 at 11:07 AM Andrew Ballance
> <andrewjballance@gmail.com> wrote:
> >
> > rustdoc generates a link to a nonexistent file because of a extra quote
> >
> > Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>
> 
> Thanks for the patch!
> 
> I guess this is meant for staging/rust-device, but I think this should
> be a review comment here:

Firmware and device abstractions were merged in driver-core-next.

> 
>     https://lore.kernel.org/rust-for-linux/20240618154841.6716-3-dakr@redhat.com/
> 
> Cheers,
> Miguel
> 

On Mon, Jul 8, 2024 at 1:25 PM Danilo Krummrich <dakr@redhat.com> wrote:
>
> Firmware and device abstractions were merged in driver-core-next.

Indeed, you are right -- then:

Fixes: de6582833db0 ("rust: add firmware abstractions")

And with the commit message fixed:

Acked-by: Miguel Ojeda <ojeda@kernel.org>

Thanks!

Cheers,
Miguel

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

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
>

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