linux-kernel - Re: [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-prev] [day] [month] [year] [list]

Message-ID: <20250917154227.7ecb47dc@nimda.home>
Date: Wed, 17 Sep 2025 15:42:27 +0300
From: Onur Özkan <work@...rozkan.dev>
To: djfkvcing117@...il.com
Cc: linux-kernel@...r.kernel.org, rust-for-linux@...r.kernel.org, gregkh
 <gregkh@...uxfoundation.org>, lossin@...nel.org, gary@...yguo.net
Subject: Re: [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError`
 docs

On Wed, 17 Sep 2025 11:38:33 +0800
djfkvcing117@...il.com wrote:

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

Hi Tong,

The description doesn't follow the style guidelines (lines are too
long). Please run `./scripts/checkpatch.pl $path_to_patch_file` to
verify before submitting patches.

Also, make sure to version your patches with each revision (e.g., `git
format-patch $commit -vN`). There are already several patches with the
same titles on the mailing list.

Thanks,
Onur