* [PATCH] rust: firmware: fix invalid rustdoc link
@ 2024-07-08 9:06 Andrew Ballance
2024-07-08 9:16 ` Miguel Ojeda
2024-07-08 11:24 ` [PATCH] " Danilo Krummrich
0 siblings, 2 replies; 8+ messages in thread
From: Andrew Ballance @ 2024-07-08 9:06 UTC (permalink / raw)
To: linux-kernel
Cc: linux-kernel-mentees, skhan, mcgrof, russ.weight, dakr, ojeda,
alex.gaynor, wedsonaf, boqun.feng, gary, bjorn3_gh, benno.lossin,
a.hindborg, aliceryhl, rust-for-linux, Andrew Ballance
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
^ permalink raw reply related [flat|nested] 8+ messages in thread* Re: [PATCH] rust: firmware: fix invalid rustdoc link
2024-07-08 9:06 [PATCH] rust: firmware: fix invalid rustdoc link Andrew Ballance
@ 2024-07-08 9:16 ` Miguel Ojeda
2024-07-08 11:25 ` Danilo Krummrich
2024-07-08 11:24 ` [PATCH] " Danilo Krummrich
1 sibling, 1 reply; 8+ messages in thread
From: Miguel Ojeda @ 2024-07-08 9:16 UTC (permalink / raw)
To: Andrew Ballance
Cc: linux-kernel, linux-kernel-mentees, skhan, mcgrof, russ.weight,
dakr, ojeda, alex.gaynor, wedsonaf, boqun.feng, gary, bjorn3_gh,
benno.lossin, a.hindborg, aliceryhl, rust-for-linux
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
^ permalink raw reply [flat|nested] 8+ messages in thread* Re: [PATCH] rust: firmware: fix invalid rustdoc link
2024-07-08 9:16 ` Miguel Ojeda
@ 2024-07-08 11:25 ` Danilo Krummrich
2024-07-08 11:56 ` Miguel Ojeda
0 siblings, 1 reply; 8+ messages in thread
From: Danilo Krummrich @ 2024-07-08 11:25 UTC (permalink / raw)
To: Miguel Ojeda
Cc: Andrew Ballance, linux-kernel, gregkh, linux-kernel-mentees,
skhan, mcgrof, russ.weight, ojeda, alex.gaynor, wedsonaf,
boqun.feng, gary, bjorn3_gh, benno.lossin, a.hindborg, aliceryhl,
rust-for-linux
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
>
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] rust: firmware: fix invalid rustdoc link
2024-07-08 11:25 ` Danilo Krummrich
@ 2024-07-08 11:56 ` Miguel Ojeda
2024-07-09 0:44 ` [PATCH v2] " Andrew Ballance
0 siblings, 1 reply; 8+ messages in thread
From: Miguel Ojeda @ 2024-07-08 11:56 UTC (permalink / raw)
To: Danilo Krummrich
Cc: Andrew Ballance, linux-kernel, gregkh, linux-kernel-mentees,
skhan, mcgrof, russ.weight, ojeda, alex.gaynor, wedsonaf,
boqun.feng, gary, bjorn3_gh, benno.lossin, a.hindborg, aliceryhl,
rust-for-linux
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
^ permalink raw reply [flat|nested] 8+ messages in thread* [PATCH v2] rust: firmware: fix invalid rustdoc link
2024-07-08 11:56 ` Miguel Ojeda
@ 2024-07-09 0:44 ` Andrew Ballance
2024-07-13 14:49 ` Danilo Krummrich
0 siblings, 1 reply; 8+ messages in thread
From: Andrew Ballance @ 2024-07-09 0:44 UTC (permalink / raw)
To: miguel.ojeda.sandonis
Cc: a.hindborg, alex.gaynor, aliceryhl, andrewjballance, benno.lossin,
bjorn3_gh, boqun.feng, dakr, gary, gregkh, linux-kernel-mentees,
linux-kernel, mcgrof, ojeda, russ.weight, rust-for-linux, skhan,
wedsonaf
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
^ permalink raw reply related [flat|nested] 8+ messages in thread* Re: [PATCH v2] rust: firmware: fix invalid rustdoc link
2024-07-09 0:44 ` [PATCH v2] " Andrew Ballance
@ 2024-07-13 14:49 ` Danilo Krummrich
2024-07-14 6:16 ` Greg KH
0 siblings, 1 reply; 8+ messages in thread
From: Danilo Krummrich @ 2024-07-13 14:49 UTC (permalink / raw)
To: gregkh
Cc: miguel.ojeda.sandonis, a.hindborg, alex.gaynor, aliceryhl,
benno.lossin, bjorn3_gh, boqun.feng, gary, andrewjballance,
linux-kernel-mentees, linux-kernel, mcgrof, ojeda, russ.weight,
rust-for-linux, skhan, wedsonaf
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
>
^ permalink raw reply [flat|nested] 8+ messages in thread* Re: [PATCH v2] rust: firmware: fix invalid rustdoc link
2024-07-13 14:49 ` Danilo Krummrich
@ 2024-07-14 6:16 ` Greg KH
0 siblings, 0 replies; 8+ messages in thread
From: Greg KH @ 2024-07-14 6:16 UTC (permalink / raw)
To: Danilo Krummrich
Cc: miguel.ojeda.sandonis, a.hindborg, alex.gaynor, aliceryhl,
benno.lossin, bjorn3_gh, boqun.feng, gary, andrewjballance,
linux-kernel-mentees, linux-kernel, mcgrof, ojeda, russ.weight,
rust-for-linux, skhan, wedsonaf
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
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] rust: firmware: fix invalid rustdoc link
2024-07-08 9:06 [PATCH] rust: firmware: fix invalid rustdoc link Andrew Ballance
2024-07-08 9:16 ` Miguel Ojeda
@ 2024-07-08 11:24 ` Danilo Krummrich
1 sibling, 0 replies; 8+ messages in thread
From: Danilo Krummrich @ 2024-07-08 11:24 UTC (permalink / raw)
To: Andrew Ballance
Cc: linux-kernel, gregkh, linux-kernel-mentees, skhan, mcgrof,
russ.weight, ojeda, alex.gaynor, wedsonaf, boqun.feng, gary,
bjorn3_gh, benno.lossin, a.hindborg, aliceryhl, rust-for-linux
+ 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
>
^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2024-07-14 6:16 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-07-08 9:06 [PATCH] rust: firmware: fix invalid rustdoc link Andrew Ballance
2024-07-08 9:16 ` Miguel Ojeda
2024-07-08 11:25 ` Danilo Krummrich
2024-07-08 11:56 ` Miguel Ojeda
2024-07-09 0:44 ` [PATCH v2] " Andrew Ballance
2024-07-13 14:49 ` Danilo Krummrich
2024-07-14 6:16 ` Greg KH
2024-07-08 11:24 ` [PATCH] " Danilo Krummrich
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).