Commit c7305116 authored by Michael Vetter's avatar Michael Vetter Committed by Miguel Ojeda

rust: kernel: use docs.kernel.org links in code documentation

Use links to docs.kernel.org instead of www.kernel.org/doc/html/latest
in the code documentation. The links are shorter and cleaner.

Link: https://github.com/Rust-for-Linux/linux/issues/1101Signed-off-by: default avatarMichael Vetter <jubalh@iodoru.org>
[ Reworded slightly. - Miguel ]
Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent f3639304
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
//! //!
//! C header: [`include/linux/printk.h`](srctree/include/linux/printk.h) //! C header: [`include/linux/printk.h`](srctree/include/linux/printk.h)
//! //!
//! Reference: <https://www.kernel.org/doc/html/latest/core-api/printk-basics.html> //! Reference: <https://docs.kernel.org/core-api/printk-basics.html>
use core::{ use core::{
ffi::{c_char, c_void}, ffi::{c_char, c_void},
...@@ -197,7 +197,7 @@ macro_rules! print_macro ( ...@@ -197,7 +197,7 @@ macro_rules! print_macro (
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and /// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
/// `alloc::format!` for information about the formatting syntax. /// `alloc::format!` for information about the formatting syntax.
/// ///
/// [`pr_emerg`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_emerg /// [`pr_emerg`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_emerg
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html /// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
/// ///
/// # Examples /// # Examples
...@@ -221,7 +221,7 @@ macro_rules! pr_emerg ( ...@@ -221,7 +221,7 @@ macro_rules! pr_emerg (
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and /// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
/// `alloc::format!` for information about the formatting syntax. /// `alloc::format!` for information about the formatting syntax.
/// ///
/// [`pr_alert`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_alert /// [`pr_alert`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_alert
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html /// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
/// ///
/// # Examples /// # Examples
...@@ -245,7 +245,7 @@ macro_rules! pr_alert ( ...@@ -245,7 +245,7 @@ macro_rules! pr_alert (
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and /// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
/// `alloc::format!` for information about the formatting syntax. /// `alloc::format!` for information about the formatting syntax.
/// ///
/// [`pr_crit`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_crit /// [`pr_crit`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_crit
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html /// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
/// ///
/// # Examples /// # Examples
...@@ -269,7 +269,7 @@ macro_rules! pr_crit ( ...@@ -269,7 +269,7 @@ macro_rules! pr_crit (
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and /// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
/// `alloc::format!` for information about the formatting syntax. /// `alloc::format!` for information about the formatting syntax.
/// ///
/// [`pr_err`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_err /// [`pr_err`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_err
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html /// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
/// ///
/// # Examples /// # Examples
...@@ -293,7 +293,7 @@ macro_rules! pr_err ( ...@@ -293,7 +293,7 @@ macro_rules! pr_err (
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and /// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
/// `alloc::format!` for information about the formatting syntax. /// `alloc::format!` for information about the formatting syntax.
/// ///
/// [`pr_warn`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_warn /// [`pr_warn`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_warn
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html /// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
/// ///
/// # Examples /// # Examples
...@@ -317,7 +317,7 @@ macro_rules! pr_warn ( ...@@ -317,7 +317,7 @@ macro_rules! pr_warn (
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and /// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
/// `alloc::format!` for information about the formatting syntax. /// `alloc::format!` for information about the formatting syntax.
/// ///
/// [`pr_notice`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_notice /// [`pr_notice`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_notice
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html /// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
/// ///
/// # Examples /// # Examples
...@@ -341,7 +341,7 @@ macro_rules! pr_notice ( ...@@ -341,7 +341,7 @@ macro_rules! pr_notice (
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and /// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
/// `alloc::format!` for information about the formatting syntax. /// `alloc::format!` for information about the formatting syntax.
/// ///
/// [`pr_info`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_info /// [`pr_info`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_info
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html /// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
/// ///
/// # Examples /// # Examples
...@@ -367,7 +367,7 @@ macro_rules! pr_info ( ...@@ -367,7 +367,7 @@ macro_rules! pr_info (
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and /// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
/// `alloc::format!` for information about the formatting syntax. /// `alloc::format!` for information about the formatting syntax.
/// ///
/// [`pr_debug`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_debug /// [`pr_debug`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_debug
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html /// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
/// ///
/// # Examples /// # Examples
...@@ -395,7 +395,7 @@ macro_rules! pr_debug ( ...@@ -395,7 +395,7 @@ macro_rules! pr_debug (
/// `alloc::format!` for information about the formatting syntax. /// `alloc::format!` for information about the formatting syntax.
/// ///
/// [`pr_info!`]: crate::pr_info! /// [`pr_info!`]: crate::pr_info!
/// [`pr_cont`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_cont /// [`pr_cont`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_cont
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html /// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
/// ///
/// # Examples /// # Examples
......
...@@ -136,7 +136,7 @@ ...@@ -136,7 +136,7 @@
/// ///
/// [`std::dbg`]: https://doc.rust-lang.org/std/macro.dbg.html /// [`std::dbg`]: https://doc.rust-lang.org/std/macro.dbg.html
/// [`eprintln`]: https://doc.rust-lang.org/std/macro.eprintln.html /// [`eprintln`]: https://doc.rust-lang.org/std/macro.eprintln.html
/// [`printk`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html /// [`printk`]: https://docs.kernel.org/core-api/printk-basics.html
/// [`pr_info`]: crate::pr_info! /// [`pr_info`]: crate::pr_info!
/// [`pr_debug`]: crate::pr_debug! /// [`pr_debug`]: crate::pr_debug!
#[macro_export] #[macro_export]
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment