linux-kernel - [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250917033838.8171-1-djfkvcing117@gmail.com>
Date: Wed, 17 Sep 2025 11:38:33 +0800
From: djfkvcing117@...il.com
To: linux-kernel@...r.kernel.org,
	rust-for-linux@...r.kernel.org
Cc: Onur <work@...rozkan.dev>,
	gregkh <gregkh@...uxfoundation.org>,
	lossin@...nel.org,
	gary@...yguo.net,
	Tong Li <djfkvcing117@...il.com>
Subject: [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs

From: Tong Li <djfkvcing117@...il.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@...rozkan.dev>
Link: https://github.com/Rust-for-Linux/linux/issues/1186
Signed-off-by: Tong Li <djfkvcing117@...il.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