mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] rust: print: fix broken `_printk` Rustdoc link
@ 2026-07-17 11:44 Younes Akhouayri via B4 Relay
  2026-07-17 11:51 ` Onur Özkan
  2026-07-17 11:52 ` Miguel Ojeda
  0 siblings, 2 replies; 3+ messages in thread
From: Younes Akhouayri via B4 Relay @ 2026-07-17 11:44 UTC (permalink / raw)
  To: Miguel Ojeda, Boqun Feng, Gary Guo, Björn Roy Baron,
	Benno Lossin, Andreas Hindborg, Alice Ryhl, Trevor Gross,
	Danilo Krummrich, Daniel Almeida, Tamir Duberstein,
	Alexandre Courbot, Onur Özkan
  Cc: rust-for-linux, linux-kernel

From: Younes Akhouayri <git@younes.io>

The Rustdoc link for `_printk` points to `include/linux/_printk.h`,
which does not exist. Point it to `include/linux/printk.h`, where
`_printk` is declared.

Fixes: 247b365dc8dc ("rust: add `kernel` crate")
Signed-off-by: Younes Akhouayri <git@younes.io>
---
 rust/kernel/print.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rust/kernel/print.rs b/rust/kernel/print.rs
index 6fd84389a858..0d62beeedca5 100644
--- a/rust/kernel/print.rs
+++ b/rust/kernel/print.rs
@@ -99,7 +99,7 @@ pub mod format_strings {
 /// The format string must be one of the ones in [`format_strings`], and
 /// the module name must be null-terminated.
 ///
-/// [`_printk`]: srctree/include/linux/_printk.h
+/// [`_printk`]: srctree/include/linux/printk.h
 #[doc(hidden)]
 #[cfg_attr(not(CONFIG_PRINTK), allow(unused_variables))]
 pub unsafe fn call_printk(

---
base-commit: 7059bdf4f04a3e14f4fafb3ac35fdca913e3e21a
change-id: 20260717-docs-printk-rustdoc-link-a6645b2873ba

Best regards,
--  
Younes Akhouayri <git@younes.io>



^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] rust: print: fix broken `_printk` Rustdoc link
  2026-07-17 11:44 [PATCH] rust: print: fix broken `_printk` Rustdoc link Younes Akhouayri via B4 Relay
@ 2026-07-17 11:51 ` Onur Özkan
  2026-07-17 11:52 ` Miguel Ojeda
  1 sibling, 0 replies; 3+ messages in thread
From: Onur Özkan @ 2026-07-17 11:51 UTC (permalink / raw)
  To: Younes Akhouayri via B4 Relay
  Cc: Miguel Ojeda, Boqun Feng, Gary Guo, Björn Roy Baron,
	Benno Lossin, Andreas Hindborg, Alice Ryhl, Trevor Gross,
	Danilo Krummrich, Daniel Almeida, Tamir Duberstein,
	Alexandre Courbot, rust-for-linux, linux-kernel, Onur Özkan

On Fri, 17 Jul 2026 13:44:06 +0200
Younes Akhouayri via B4 Relay <devnull+git.younes.io@kernel.org> wrote:

> From: Younes Akhouayri <git@younes.io>
> 
> The Rustdoc link for `_printk` points to `include/linux/_printk.h`,
> which does not exist. Point it to `include/linux/printk.h`, where
> `_printk` is declared.
> 
> Fixes: 247b365dc8dc ("rust: add `kernel` crate")
> Signed-off-by: Younes Akhouayri <git@younes.io>
> ---
>  rust/kernel/print.rs | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/rust/kernel/print.rs b/rust/kernel/print.rs
> index 6fd84389a858..0d62beeedca5 100644
> --- a/rust/kernel/print.rs
> +++ b/rust/kernel/print.rs
> @@ -99,7 +99,7 @@ pub mod format_strings {
>  /// The format string must be one of the ones in [`format_strings`], and
>  /// the module name must be null-terminated.
>  ///
> -/// [`_printk`]: srctree/include/linux/_printk.h
> +/// [`_printk`]: srctree/include/linux/printk.h
>  #[doc(hidden)]
>  #[cfg_attr(not(CONFIG_PRINTK), allow(unused_variables))]
>  pub unsafe fn call_printk(
> 
> ---
> base-commit: 7059bdf4f04a3e14f4fafb3ac35fdca913e3e21a
> change-id: 20260717-docs-printk-rustdoc-link-a6645b2873ba
> 
> Best regards,
> --  
> Younes Akhouayri <git@younes.io>
> 
> 

Thanks!

Reviewed-by: Onur Özkan <work@onurozkan.dev>

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] rust: print: fix broken `_printk` Rustdoc link
  2026-07-17 11:44 [PATCH] rust: print: fix broken `_printk` Rustdoc link Younes Akhouayri via B4 Relay
  2026-07-17 11:51 ` Onur Özkan
@ 2026-07-17 11:52 ` Miguel Ojeda
  1 sibling, 0 replies; 3+ messages in thread
From: Miguel Ojeda @ 2026-07-17 11:52 UTC (permalink / raw)
  To: git
  Cc: Miguel Ojeda, Boqun Feng, Gary Guo, Björn Roy Baron,
	Benno Lossin, Andreas Hindborg, Alice Ryhl, Trevor Gross,
	Danilo Krummrich, Daniel Almeida, Tamir Duberstein,
	Alexandre Courbot, Onur Özkan, rust-for-linux, linux-kernel

On Fri, Jul 17, 2026 at 1:44 PM Younes Akhouayri via B4 Relay
<devnull+git.younes.io@kernel.org> wrote:
>
> From: Younes Akhouayri <git@younes.io>
>
> The Rustdoc link for `_printk` points to `include/linux/_printk.h`,
> which does not exist. Point it to `include/linux/printk.h`, where
> `_printk` is declared.
>
> Fixes: 247b365dc8dc ("rust: add `kernel` crate")
> Signed-off-by: Younes Akhouayri <git@younes.io>

Looks good to me, thanks for reporting it and fixing it!

Link: https://github.com/Rust-for-Linux/linux/issues/1246

(Normally it would be Closes:, but there are two issues in the same
one, so we use Link: for that instead.)

Finally, given it is `doc(hidden)`, I will skip Cc: stable@ -- if the
stable team auto-selects it, it is fine.

Cheers,
Miguel

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2026-07-17 11:52 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-07-17 11:44 [PATCH] rust: print: fix broken `_printk` Rustdoc link Younes Akhouayri via B4 Relay
2026-07-17 11:51 ` Onur Özkan
2026-07-17 11:52 ` Miguel Ojeda

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox