* [PATCH] rust: kernel: fix THIS_MODULE header path in ThisModule doc comment
@ 2024-10-19 9:52 Yutaro Ohno
2024-10-19 10:04 ` Greg KH
0 siblings, 1 reply; 3+ messages in thread
From: Yutaro Ohno @ 2024-10-19 9:52 UTC (permalink / raw)
To: rust-for-linux
Cc: Miguel Ojeda, Alex Gaynor, Boqun Feng, Gary Guo,
Björn Roy Baron, Benno Lossin, Andreas Hindborg, Alice Ryhl,
Trevor Gross, Wedson Almeida Filho, FUJITA Tomonori,
Danilo Krummrich, Valentin Obst
The doc comment for `ThisModule` incorrectly states the C header file
for `THIS_MODULE` as `include/linux/export.h`, while the correct path is
`include/linux/init.h`. This is because `THIS_MODULE` was moved in
commit 5b20755b7780 ("init: move THIS_MODULE from <linux/export.h> to
<linux/init.h>").
Update the doc comment for `ThisModule` to reflect the correct header
file path for `THIS_MODULE`.
Signed-off-by: Yutaro Ohno <yutaro.ono.418@gmail.com>
---
rust/kernel/lib.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs
index b5f4b3ce6b48..032c9089e686 100644
--- a/rust/kernel/lib.rs
+++ b/rust/kernel/lib.rs
@@ -83,7 +83,7 @@ pub trait Module: Sized + Sync + Send {
/// Equivalent to `THIS_MODULE` in the C API.
///
-/// C header: [`include/linux/export.h`](srctree/include/linux/export.h)
+/// C header: [`include/linux/init.h`](srctree/include/linux/init.h)
pub struct ThisModule(*mut bindings::module);
// SAFETY: `THIS_MODULE` may be used from all threads within a module.
--
2.47.0
^ permalink raw reply related [flat|nested] 3+ messages in thread* Re: [PATCH] rust: kernel: fix THIS_MODULE header path in ThisModule doc comment
2024-10-19 9:52 [PATCH] rust: kernel: fix THIS_MODULE header path in ThisModule doc comment Yutaro Ohno
@ 2024-10-19 10:04 ` Greg KH
2024-10-21 2:51 ` Yutaro Ohno
0 siblings, 1 reply; 3+ messages in thread
From: Greg KH @ 2024-10-19 10:04 UTC (permalink / raw)
To: Yutaro Ohno
Cc: rust-for-linux, Miguel Ojeda, Alex Gaynor, Boqun Feng, Gary Guo,
Björn Roy Baron, Benno Lossin, Andreas Hindborg, Alice Ryhl,
Trevor Gross, Wedson Almeida Filho, FUJITA Tomonori,
Danilo Krummrich, Valentin Obst
On Sat, Oct 19, 2024 at 06:52:27PM +0900, Yutaro Ohno wrote:
> The doc comment for `ThisModule` incorrectly states the C header file
> for `THIS_MODULE` as `include/linux/export.h`, while the correct path is
> `include/linux/init.h`. This is because `THIS_MODULE` was moved in
> commit 5b20755b7780 ("init: move THIS_MODULE from <linux/export.h> to
> <linux/init.h>").
>
> Update the doc comment for `ThisModule` to reflect the correct header
> file path for `THIS_MODULE`.
>
> Signed-off-by: Yutaro Ohno <yutaro.ono.418@gmail.com>
This should get:
Fixes: 5b20755b7780 ("init: move THIS_MODULE from <linux/export.h> to <linux/init.h>")
added to it when merged.
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH] rust: kernel: fix THIS_MODULE header path in ThisModule doc comment
2024-10-19 10:04 ` Greg KH
@ 2024-10-21 2:51 ` Yutaro Ohno
0 siblings, 0 replies; 3+ messages in thread
From: Yutaro Ohno @ 2024-10-21 2:51 UTC (permalink / raw)
To: Greg KH
Cc: rust-for-linux, Miguel Ojeda, Alex Gaynor, Boqun Feng, Gary Guo,
Björn Roy Baron, Benno Lossin, Andreas Hindborg, Alice Ryhl,
Trevor Gross, Wedson Almeida Filho, FUJITA Tomonori,
Danilo Krummrich, Valentin Obst
Hi Greg, thank you for reviewing.
On 10/19, Greg KH wrote:
> On Sat, Oct 19, 2024 at 06:52:27PM +0900, Yutaro Ohno wrote:
> > The doc comment for `ThisModule` incorrectly states the C header file
> > for `THIS_MODULE` as `include/linux/export.h`, while the correct path is
> > `include/linux/init.h`. This is because `THIS_MODULE` was moved in
> > commit 5b20755b7780 ("init: move THIS_MODULE from <linux/export.h> to
> > <linux/init.h>").
> >
> > Update the doc comment for `ThisModule` to reflect the correct header
> > file path for `THIS_MODULE`.
> >
> > Signed-off-by: Yutaro Ohno <yutaro.ono.418@gmail.com>
>
> This should get:
>
> Fixes: 5b20755b7780 ("init: move THIS_MODULE from <linux/export.h> to <linux/init.h>")
>
> added to it when merged.
You're right. I'll add in v2.
>
> Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
>
Cheers,
Yutaro
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2024-10-21 2:52 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-10-19 9:52 [PATCH] rust: kernel: fix THIS_MODULE header path in ThisModule doc comment Yutaro Ohno
2024-10-19 10:04 ` Greg KH
2024-10-21 2:51 ` Yutaro Ohno
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).