diff options
| author | Tong Li <djfkvcing117@gmail.com> | 2025-09-30 19:02:58 +0800 |
|---|---|---|
| committer | Christian Brauner <brauner@kernel.org> | 2025-10-07 12:48:33 +0200 |
| commit | d68a29a6a229f8b4f3b19dbcd0bb02881316d642 (patch) | |
| tree | f040cc71a2433af850745f911c140482cad8891a /rust | |
| parent | deafd21efdd106f9744e2339e0c70c0f4ba565c3 (diff) | |
rust: file: add intra-doc link for 'EBADF'
The `BadFdError` doc comment mentions the `EBADF` constant but does
not currently provide a navigation target for readers of the
generated docs. Turning the references into intra-doc links matches
the rest of the module and makes the documentation easier to
explore.
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>
Reviewed-by: Onur Özkan <work@onurozkan.dev>
Signed-off-by: Christian Brauner <brauner@kernel.org>
Diffstat (limited to 'rust')
| -rw-r--r-- | rust/kernel/fs/file.rs | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/rust/kernel/fs/file.rs b/rust/kernel/fs/file.rs index cf06e73a6da0..cd6987850332 100644 --- a/rust/kernel/fs/file.rs +++ b/rust/kernel/fs/file.rs @@ -448,9 +448,9 @@ impl Drop for FileDescriptorReservation { } } -/// 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; |