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>] [day] [month] [year] [list]

Message-ID: <2025091648-scallop-projector-c470@gregkh>
Date: Tue, 16 Sep 2025 16:37:05 +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>, ojeda@...nel.org,
	alex.gaynor@...il.com, david.m.ertman@...el.com,
	ira.weiny@...el.com, leon@...nel.org, boqun.feng@...il.com,
	gary@...yguo.net, bjorn3_gh@...tonmail.com, lossin@...nel.org,
	a.hindborg@...nel.org, aliceryhl@...gle.com, tmgross@...ch.edu,
	dakr@...nel.org
Subject: Re: [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError`
 docs

On Tue, Sep 16, 2025 at 10:25:41PM +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: https://github.com/onur-ozkan
> Link: https://github.com/Rust-for-Linux/linux/issues/1186
> Signed-off-by: Your Name <your.email@...mple.com>

Note, we need a "real name" here :)

thanks,

greg k-h