Skip to contentSkip to conversation

rust: firmware: fix invalid rustdoc link

PATCH Superseded Andrew Ballance 4 participants 8 messages Jul 8, 2024 – Jul 14, 2024

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 rust: firmware: fix invalid rustdoc link

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

---
 rust/kernel/firmware.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
rust/kernel/firmware.rs +1 -1
index 386c8fb44785..763d7cbefab5 100644
@@ -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;
Signature · 1 line
2.45.2
#2 lore raw
Quoted 11 lines · Miguel Ojeda
Quoted 4 lines · Andrew Ballance

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

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.

Quoted 6 lines
    https://lore.kernel.org/rust-for-linux/[email protected]/

Cheers,
Miguel

Acked-by
#3 lore raw
Quoted 2 lines · Danilo Krummrich

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:

Thanks!

Cheers,
Miguel

#4 lore raw

PATCH v2 1/1 rust: firmware: fix invalid rustdoc link

remove an extra quote from the doc comment so that rustdoc no longer genertes a link to a nonexistent file.

Fixes de6582833db0 ("rust: add firmware abstractions")

---
v1 -> v2: updated commit message

 rust/kernel/firmware.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
rust/kernel/firmware.rs +1 -1
index 386c8fb44785..763d7cbefab5 100644
@@ -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;
Signature · 1 line
2.45.2
#5 lore raw

Hi Greg,

Quoted 7 lines · Andrew Ballance

remove an extra quote from the doc comment so that rustdoc no longer genertes a link to a nonexistent file.

Fixes de6582833db0 ("rust: add firmware abstractions")

Can you please pick this one up?

- Danilo

Quoted 22 lines

---
v1 -> v2: updated commit message

 rust/kernel/firmware.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
rust/kernel/firmware.rs +1 -1
index 386c8fb44785..763d7cbefab5 100644
@@ -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;
Signature · 1 line
2.45.2
#6 lore raw
Quoted 6 lines · Danilo Krummrich

Hi Greg,

Quoted 3 lines · Andrew Ballance

remove an extra quote from the doc comment so that rustdoc no longer genertes a link to a nonexistent file.

Quoted 6 lines
Quoted 4 lines
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

Reviewed-by on v1 1/1
#7 lore raw
In reply to Andrew Ballance

+ Greg

Quoted 1 line · Andrew Ballance

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."

Quoted 2 lines

With that,

Quoted 20 lines
---
 rust/kernel/firmware.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
rust/kernel/firmware.rs +1 -1
index 386c8fb44785..763d7cbefab5 100644
@@ -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;
Signature · 1 line
2.45.2