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

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

[djfkvcing117]

From: Tong Li <djfkvcing117@gmail.com>

In rust/kernel/fs/file.rs, replace `EBADF` with [`EBADF`].

This helps rust-analyzer to resolve such references.

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

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

[Onur Özkan]

On Thu, 18 Sep 2025 00:50:59 +0800
djfkvcing117@gmail.com wrote:

> From: Tong Li <djfkvcing117@gmail.com>
> 
> In rust/kernel/fs/file.rs, replace `EBADF` with [`EBADF`].
> 
> This helps rust-analyzer to resolve such references.
> 
> 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;
>  

Reviewed-by: Onur Özkan <work@onurozkan.dev>

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

[Miguel Ojeda]

On Wed, Sep 17, 2025 at 6:51 PM <djfkvcing117@gmail.com> wrote:
>
> From: Tong Li <djfkvcing117@gmail.com>
>
> In rust/kernel/fs/file.rs, replace `EBADF` with [`EBADF`].
>
> This helps rust-analyzer to resolve such references.

I would instead say:

    rust: file: add intra-doc link for `EBADF`

or similar, since that is what those are -- they are rendered by
`rustdoc` (and of course possibly used by other tooling).

The change itself looks fine to me.

However, it isn't sent to the right maintainers (VFS) -- please use
`scripts/get_maintainer.pl` to get them :)

Thanks!

Cheers,
Miguel