Skip to content

Commit c730511

Browse files
jubalhojeda
authored andcommitted
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: #1101 Signed-off-by: Michael Vetter <[email protected]> [ Reworded slightly. - Miguel ] Signed-off-by: Miguel Ojeda <[email protected]>
1 parent f363930 commit c730511

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

rust/kernel/print.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
//!
55
//! C header: [`include/linux/printk.h`](srctree/include/linux/printk.h)
66
//!
7-
//! Reference: <https://www.kernel.org/doc/html/latest/core-api/printk-basics.html>
7+
//! Reference: <https://docs.kernel.org/core-api/printk-basics.html>
88
99
use core::{
1010
ffi::{c_char, c_void},
@@ -197,7 +197,7 @@ macro_rules! print_macro (
197197
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
198198
/// `alloc::format!` for information about the formatting syntax.
199199
///
200-
/// [`pr_emerg`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_emerg
200+
/// [`pr_emerg`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_emerg
201201
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
202202
///
203203
/// # Examples
@@ -221,7 +221,7 @@ macro_rules! pr_emerg (
221221
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
222222
/// `alloc::format!` for information about the formatting syntax.
223223
///
224-
/// [`pr_alert`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_alert
224+
/// [`pr_alert`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_alert
225225
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
226226
///
227227
/// # Examples
@@ -245,7 +245,7 @@ macro_rules! pr_alert (
245245
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
246246
/// `alloc::format!` for information about the formatting syntax.
247247
///
248-
/// [`pr_crit`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_crit
248+
/// [`pr_crit`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_crit
249249
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
250250
///
251251
/// # Examples
@@ -269,7 +269,7 @@ macro_rules! pr_crit (
269269
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
270270
/// `alloc::format!` for information about the formatting syntax.
271271
///
272-
/// [`pr_err`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_err
272+
/// [`pr_err`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_err
273273
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
274274
///
275275
/// # Examples
@@ -293,7 +293,7 @@ macro_rules! pr_err (
293293
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
294294
/// `alloc::format!` for information about the formatting syntax.
295295
///
296-
/// [`pr_warn`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_warn
296+
/// [`pr_warn`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_warn
297297
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
298298
///
299299
/// # Examples
@@ -317,7 +317,7 @@ macro_rules! pr_warn (
317317
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
318318
/// `alloc::format!` for information about the formatting syntax.
319319
///
320-
/// [`pr_notice`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_notice
320+
/// [`pr_notice`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_notice
321321
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
322322
///
323323
/// # Examples
@@ -341,7 +341,7 @@ macro_rules! pr_notice (
341341
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
342342
/// `alloc::format!` for information about the formatting syntax.
343343
///
344-
/// [`pr_info`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_info
344+
/// [`pr_info`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_info
345345
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
346346
///
347347
/// # Examples
@@ -367,7 +367,7 @@ macro_rules! pr_info (
367367
/// Mimics the interface of [`std::print!`]. See [`core::fmt`] and
368368
/// `alloc::format!` for information about the formatting syntax.
369369
///
370-
/// [`pr_debug`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_debug
370+
/// [`pr_debug`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_debug
371371
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
372372
///
373373
/// # Examples
@@ -395,7 +395,7 @@ macro_rules! pr_debug (
395395
/// `alloc::format!` for information about the formatting syntax.
396396
///
397397
/// [`pr_info!`]: crate::pr_info!
398-
/// [`pr_cont`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html#c.pr_cont
398+
/// [`pr_cont`]: https://docs.kernel.org/core-api/printk-basics.html#c.pr_cont
399399
/// [`std::print!`]: https://doc.rust-lang.org/std/macro.print.html
400400
///
401401
/// # Examples

rust/kernel/std_vendor.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@
136136
///
137137
/// [`std::dbg`]: https://doc.rust-lang.org/std/macro.dbg.html
138138
/// [`eprintln`]: https://doc.rust-lang.org/std/macro.eprintln.html
139-
/// [`printk`]: https://www.kernel.org/doc/html/latest/core-api/printk-basics.html
139+
/// [`printk`]: https://docs.kernel.org/core-api/printk-basics.html
140140
/// [`pr_info`]: crate::pr_info!
141141
/// [`pr_debug`]: crate::pr_debug!
142142
#[macro_export]

0 commit comments

Comments
 (0)