Skip to content

Commit d68a29a

Browse files
Webb321brauner
authored andcommitted
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 <[email protected]> Link: Rust-for-Linux/linux#1186 Signed-off-by: Tong Li <[email protected]> Reviewed-by: Onur Özkan <[email protected]> Signed-off-by: Christian Brauner <[email protected]>
1 parent deafd21 commit d68a29a

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

rust/kernel/fs/file.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -448,9 +448,9 @@ impl Drop for FileDescriptorReservation {
448448
}
449449
}
450450

451-
/// Represents the `EBADF` error code.
451+
/// Represents the [`EBADF`] error code.
452452
///
453-
/// Used for methods that can only fail with `EBADF`.
453+
/// Used for methods that can only fail with [`EBADF`].
454454
#[derive(Copy, Clone, Eq, PartialEq)]
455455
pub struct BadFdError;
456456

0 commit comments

Comments
 (0)