From: Greg KH <gregkh@linuxfoundation.org>
To: Tong <djfkvcing117@gmail.com>
Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
onur-ozkan <work@onurozkan.dev>,
ojeda@kernel.org, alex.gaynor@gmail.com,
david.m.ertman@intel.com, ira.weiny@intel.com, leon@kernel.org,
boqun.feng@gmail.com, gary@garyguo.net, bjorn3_gh@protonmail.com,
lossin@kernel.org, a.hindborg@kernel.org, aliceryhl@google.com,
tmgross@umich.edu, dakr@kernel.org
Subject: Re: [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs
Date: Tue, 16 Sep 2025 16:37:05 +0200 [thread overview]
Message-ID: <2025091648-scallop-projector-c470@gregkh> (raw)
In-Reply-To: <CAMfjjQ18NYsQh7CVzRs=+sYwve4T5y-vf=zMNLyxQvgYE4+mMA@mail.gmail.com>
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@example.com>
Note, we need a "real name" here :)
thanks,
greg k-h
next parent reply other threads:[~2025-09-16 14:37 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <CAMfjjQ18NYsQh7CVzRs=+sYwve4T5y-vf=zMNLyxQvgYE4+mMA@mail.gmail.com>
2025-09-16 14:37 ` Greg KH [this message]
2025-09-16 14:40 ` [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs Onur
2025-09-16 15:07 Tong
2025-09-16 15:17 ` Greg KH
-- strict thread matches above, loose matches on Subject: below --
2025-09-16 17:13 Tong
2025-09-16 18:30 ` Greg KH
2025-09-17 3:38 djfkvcing117
2025-09-17 12:42 ` Onur Özkan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2025091648-scallop-projector-c470@gregkh \
--to=gregkh@linuxfoundation.org \
--cc=a.hindborg@kernel.org \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=dakr@kernel.org \
--cc=david.m.ertman@intel.com \
--cc=djfkvcing117@gmail.com \
--cc=gary@garyguo.net \
--cc=ira.weiny@intel.com \
--cc=leon@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lossin@kernel.org \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=tmgross@umich.edu \
--cc=work@onurozkan.dev \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).