From: Miguel Ojeda Date: Mon, 24 Mar 2025 21:03:56 +0000 (+0100) Subject: rust: task: add missing Markdown code spans and intra-doc links X-Git-Tag: v6.16-rc1~45^2~16 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=f54c750333381bfeaa0e4a69b9563d4e4e21f1b3;p=thirdparty%2Fkernel%2Fstable.git rust: task: add missing Markdown code spans and intra-doc links Add missing Markdown code spans and also convert them into intra-doc links. This was found using the Clippy `doc_markdown` lint, which we may want to enable. Fixes: e0020ba6cbcb ("rust: add PidNamespace") Reviewed-by: Benno Lossin Link: https://lore.kernel.org/r/20250324210359.1199574-10-ojeda@kernel.org Signed-off-by: Miguel Ojeda --- diff --git a/rust/kernel/task.rs b/rust/kernel/task.rs index 9e6f6854948d9..9dce3705ff634 100644 --- a/rust/kernel/task.rs +++ b/rust/kernel/task.rs @@ -158,10 +158,10 @@ impl Task { } } - /// Returns a PidNamespace reference for the currently executing task's/thread's pid namespace. + /// Returns a [`PidNamespace`] reference for the currently executing task's/thread's pid namespace. /// /// This function can be used to create an unbounded lifetime by e.g., storing the returned - /// PidNamespace in a global variable which would be a bug. So the recommended way to get the + /// [`PidNamespace`] in a global variable which would be a bug. So the recommended way to get the /// current task's/thread's pid namespace is to use the [`current_pid_ns`] macro because it is /// safe. ///