From: Miguel Ojeda <ojeda@kernel.org>
To: Miguel Ojeda <ojeda@kernel.org>, Alex Gaynor <alex.gaynor@gmail.com>
Cc: "Boqun Feng" <boqun.feng@gmail.com>,
"Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <benno.lossin@proton.me>,
"Andreas Hindborg" <a.hindborg@kernel.org>,
"Alice Ryhl" <aliceryhl@google.com>,
"Trevor Gross" <tmgross@umich.edu>,
"Danilo Krummrich" <dakr@kernel.org>,
rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
patches@lists.linux.dev, "Christian Brauner" <brauner@kernel.org>
Subject: [PATCH 09/10] rust: task: add missing Markdown code spans and intra-doc links
Date: Mon, 24 Mar 2025 22:03:56 +0100 [thread overview]
Message-ID: <20250324210359.1199574-10-ojeda@kernel.org> (raw)
In-Reply-To: <20250324210359.1199574-1-ojeda@kernel.org>
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")
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
rust/kernel/task.rs | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/rust/kernel/task.rs b/rust/kernel/task.rs
index 49012e711942..ca1209b997c4 100644
--- a/rust/kernel/task.rs
+++ b/rust/kernel/task.rs
@@ -156,10 +156,10 @@ fn deref(&self) -> &Self::Target {
}
}
- /// 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.
///
--
2.49.0
next prev parent reply other threads:[~2025-03-24 21:04 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-24 21:03 [PATCH 00/10] rust: clean and enable Clippy `doc_markdown` lint Miguel Ojeda
2025-03-24 21:03 ` [PATCH 01/10] drm/panic: add missing space Miguel Ojeda
2025-03-25 9:02 ` Jocelyn Falempe
2025-03-24 21:03 ` [PATCH 02/10] drm/panic: add missing Markdown code span Miguel Ojeda
2025-03-25 9:05 ` Jocelyn Falempe
2025-03-25 19:04 ` Miguel Ojeda
2025-03-27 15:22 ` Jocelyn Falempe
2025-03-24 21:03 ` [PATCH 03/10] rust: alloc: add missing Markdown code spans Miguel Ojeda
2025-03-24 21:03 ` [PATCH 04/10] rust: alloc: add missing Markdown code span Miguel Ojeda
2025-03-24 21:03 ` [PATCH 05/10] rust: dma: " Miguel Ojeda
2025-03-24 21:03 ` [PATCH 06/10] rust: of: " Miguel Ojeda
2025-03-24 21:03 ` [PATCH 07/10] rust: pci: fix docs related to missing Markdown code spans Miguel Ojeda
2025-03-24 22:53 ` Benno Lossin
2025-03-24 23:01 ` Miguel Ojeda
2025-03-24 21:03 ` [PATCH 08/10] rust: platform: " Miguel Ojeda
2025-03-24 21:03 ` Miguel Ojeda [this message]
2025-03-24 21:03 ` [RFC PATCH 10/10] rust: kbuild: enable `doc_markdown` Clippy lint Miguel Ojeda
2025-03-24 22:59 ` [PATCH 00/10] rust: clean and enable Clippy `doc_markdown` lint Benno Lossin
2025-03-24 23:09 ` Miguel Ojeda
2025-03-25 0:17 ` Benno Lossin
2025-05-21 14:01 ` Miguel Ojeda
2025-05-21 15:09 ` Greg Kroah-Hartman
2025-05-24 14:18 ` Danilo Krummrich
2025-05-25 21:20 ` Miguel Ojeda
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250324210359.1199574-10-ojeda@kernel.org \
--to=ojeda@kernel.org \
--cc=a.hindborg@kernel.org \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=benno.lossin@proton.me \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=brauner@kernel.org \
--cc=dakr@kernel.org \
--cc=gary@garyguo.net \
--cc=linux-kernel@vger.kernel.org \
--cc=patches@lists.linux.dev \
--cc=rust-for-linux@vger.kernel.org \
--cc=tmgross@umich.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).