From: "Alexandre Courbot" <acourbot@nvidia.com>
To: "Miguel Ojeda" <ojeda@kernel.org>, "Alex Gaynor" <alex.gaynor@gmail.com>
Cc: "Boqun Feng" <boqun.feng@gmail.com>,
"Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <lossin@kernel.org>,
"Andreas Hindborg" <a.hindborg@kernel.org>,
"Alice Ryhl" <aliceryhl@google.com>,
"Trevor Gross" <tmgross@umich.edu>,
"Danilo Krummrich" <dakr@kernel.org>,
rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
patches@lists.linux.dev
Subject: Re: [PATCH 1/3] rust: error: improve `Error::from_errno` documentation
Date: Sat, 30 Aug 2025 21:17:57 +0900 [thread overview]
Message-ID: <DCFR8DTO39D2.1RMIDS2RUJ3H9@nvidia.com> (raw)
In-Reply-To: <20250829192243.678079-2-ojeda@kernel.org>
On Sat Aug 30, 2025 at 4:22 AM JST, Miguel Ojeda wrote:
> This constructor is public since commit 5ed147473458 ("rust: error:
> make conversion functions public"), and we will refer to it from the
> documentation of `to_result` in a later commit.
>
> Thus improve its documentation, including adding examples.
>
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
This reads very smoothly!
Reviewed-by: Alexandre Courbot <acourbot@nvidia.com>
> ---
> rust/kernel/error.rs | 19 +++++++++++++++++--
> 1 file changed, 17 insertions(+), 2 deletions(-)
>
> diff --git a/rust/kernel/error.rs b/rust/kernel/error.rs
> index a41de293dcd1..c415c3d3a3b6 100644
> --- a/rust/kernel/error.rs
> +++ b/rust/kernel/error.rs
> @@ -101,8 +101,23 @@ macro_rules! declare_err {
> impl Error {
> /// Creates an [`Error`] from a kernel error code.
> ///
> - /// It is a bug to pass an out-of-range `errno`. `EINVAL` would
> - /// be returned in such a case.
> + /// `errno` must be within error code range (i.e. `>= -MAX_ERRNO && < 0`).
> + ///
> + /// It is a bug to pass an out-of-range `errno`. [`code::EINVAL`] is returned in such a case.
> + ///
> + /// # Examples
> + ///
> + /// ```
> + /// assert_eq!(Error::from_errno(-1), EPERM);
> + /// assert_eq!(Error::from_errno(-2), ENOENT);
Small nit: this leaves a tiny chance of misunderstanding that this
function actually expects literal negative integers. How about using
e.g. `bindings::EPERM` instead of `-1`?
next prev parent reply other threads:[~2025-08-30 12:18 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-29 19:22 [PATCH 0/3] Error improvements Miguel Ojeda
2025-08-29 19:22 ` [PATCH 1/3] rust: error: improve `Error::from_errno` documentation Miguel Ojeda
2025-08-30 12:17 ` Alexandre Courbot [this message]
2025-08-30 13:00 ` Miguel Ojeda
2025-08-30 13:31 ` Alexandre Courbot
2025-09-01 9:11 ` Benno Lossin
2025-08-29 19:22 ` [PATCH 2/3] rust: error: improve `to_result` documentation Miguel Ojeda
2025-08-30 12:18 ` Alexandre Courbot
2025-09-01 9:10 ` Benno Lossin
2025-08-29 19:22 ` [PATCH 3/3] rust: error: replace `WARN_ON_ONCE` comment with `debug_assert!` Miguel Ojeda
2025-08-29 19:43 ` Miguel Ojeda
2025-08-30 6:28 ` Greg KH
2025-08-30 11:07 ` Miguel Ojeda
2025-09-03 9:45 ` Greg KH
2025-09-03 10:03 ` Miguel Ojeda
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=DCFR8DTO39D2.1RMIDS2RUJ3H9@nvidia.com \
--to=acourbot@nvidia.com \
--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=gary@garyguo.net \
--cc=linux-kernel@vger.kernel.org \
--cc=lossin@kernel.org \
--cc=ojeda@kernel.org \
--cc=patches@lists.linux.dev \
--cc=rust-for-linux@vger.kernel.org \
--cc=tmgross@umich.edu \
/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).