From: djfkvcing117@gmail.com
To: linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org
Cc: Onur <work@onurozkan.dev>, gregkh <gregkh@linuxfoundation.org>,
lossin@kernel.org, gary@garyguo.net,
Tong Li <djfkvcing117@gmail.com>
Subject: [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs
Date: Wed, 17 Sep 2025 11:38:33 +0800 [thread overview]
Message-ID: <20250917033838.8171-1-djfkvcing117@gmail.com> (raw)
From: Tong Li <djfkvcing117@gmail.com>
In rust/kernel/fs/file.rs, replace plain-text `EBADF` in the doc comment for BadFdError with an intra-doc link [`EBADF`].
This improves the generated documentation (so the `EBADF` constant is linked), and helps tools such as rust-analyzer to resolve such references from the docs.
Suggested-by: Onur Özkan <work@onurozkan.dev>
Link: https://github.com/Rust-for-Linux/linux/issues/1186
Signed-off-by: Tong Li <djfkvcing117@gmail.com>
---
rust/kernel/fs/file.rs | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/rust/kernel/fs/file.rs b/rust/kernel/fs/file.rs
index 67a3654f0fd3..f3153f4c8560 100644
--- a/rust/kernel/fs/file.rs
+++ b/rust/kernel/fs/file.rs
@@ -448,9 +448,9 @@ fn drop(&mut self) {
}
}
-/// Represents the `EBADF` error code.
+/// Represents the [`EBADF`] error code.
///
-/// Used for methods that can only fail with `EBADF`.
+/// Used for methods that can only fail with [`EBADF`].
#[derive(Copy, Clone, Eq, PartialEq)]
pub struct BadFdError;
--
2.34.1
next reply other threads:[~2025-09-17 3:38 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-17 3:38 djfkvcing117 [this message]
2025-09-17 12:42 ` [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs Onur Özkan
-- strict thread matches above, loose matches on Subject: below --
2025-09-16 17:13 Tong
2025-09-16 18:30 ` Greg KH
2025-09-16 15:07 Tong
2025-09-16 15:17 ` Greg KH
[not found] <CAMfjjQ18NYsQh7CVzRs=+sYwve4T5y-vf=zMNLyxQvgYE4+mMA@mail.gmail.com>
2025-09-16 14:37 ` Greg KH
2025-09-16 14:40 ` Onur
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=20250917033838.8171-1-djfkvcing117@gmail.com \
--to=djfkvcing117@gmail.com \
--cc=gary@garyguo.net \
--cc=gregkh@linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lossin@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=work@onurozkan.dev \
/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).