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: <CAMfjjQ1Gtjg4iG8L6Xdm1HP6FmoVgDHC6QhtMEGbA6_y-_6SXA@mail.gmail.com>
Date: Wed, 17 Sep 2025 01:13:38 +0800
From: Tong <djfkvcing117@...il.com>
To: linux-kernel@...r.kernel.org, rust-for-linux@...r.kernel.org
Cc: onur-ozkan <work@...rozkan.dev>
Subject: [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs

>From af7f05e99ed67f57c83e51ca3a1b3010e3e87762 Mon Sep 17 00:00:00 2001
From: tong <djfkvcing117@...il.com>
Date: Wed, 17 Sep 2025 00:25:44 +0800
Subject: [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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 <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