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: <2025091644-smog-stamina-5a3a@gregkh>
Date: Tue, 16 Sep 2025 17:17:28 +0200
From: Greg KH <gregkh@...uxfoundation.org>
To: Tong <djfkvcing117@...il.com>
Cc: rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.org,
	onur-ozkan <work@...rozkan.dev>, lossin@...nel.org,
	gary@...yguo.net, alex.gaynor@...il.com, david.m.ertman@...el.com,
	bjorn3_gh@...tonmail.com, ira.weiny@...el.com, leon@...nel.org,
	dakr@...nel.org, tmgross@...ch.edu, ojeda@...nel.org,
	boqun.feng@...il.com, a.hindborg@...nel.org, aliceryhl@...gle.com
Subject: Re: [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError`
 docs

On Tue, Sep 16, 2025 at 11:07:09PM +0800, Tong wrote:
> rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs
> 
> This patch changes the documentation for `BadFdError` in the `fs`
> module so that the error variant `EBADF` is referenced via an
> intra-doc link (i.e., [`EBADF`]) rather than plain text. This improves
> the generated documentation (so the `EBADF` constant is linked), and
> helps tools like rust-analyzer to resolve the reference from the docs.
> 
> Testing:
> - regenerated documentation, confirmed the link to `EBADF` shows up correctly,
> - ran doctests to ensure no broken links in docs,
> - built affected code with rustfmt / clippy to verify formatting and
> lint cleanliness.
> 
> Suggested-by: Onur Özkan <work@...rozkan.dev>
> Link: https://github.com/Rust-for-Linux/linux/issues/1186
> Signed-off-by: djfkvcing117@...il.com
> 
> ---
> 
> >From 87d6b4e61da0db96a018b86baa011b9c6635e665 Mon Sep 17 00:00:00 2001
> From: Webb321 <140618222+Webb321@...rs.noreply.github.com>
> Date: Tue, 16 Sep 2025 22:58:26 +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` references in
> the doc comment of `BadFdError` with intra-doc links [`EBADF`].
> This improves the generated documentation (so the `EBADF` constant is
> linked), and helps tools like rust-analyzer to resolve the reference
> from the docs.
> 
> Testing:
> - regenerated documentation, confirmed the link to `EBADF` shows up correctly,
> - ran doctests to ensure no broken links in docs,
> - built affected code with rustfmt / clippy to verify formatting and
> lint cleanliness.
> 
> Suggested-by: Onur Özkan <work@...rozkan.dev>
> Link: https://github.com/Rust-for-Linux/linux/issues/1186
> 
> Signed-off-by: djfkvcing117@...il.com
> ---
>  rust/kernel/fs/file.rs | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

You seem to have 2 changelog texts here, how did that happen?

Also, no blank line is needed before your signed-off-by line, AND it
should have your name and email address.

thanks,

greg k-h