[PATCH v2] rust: update error.rs documentation

Onur Özkan posted 1 patch 2 months, 1 week ago
There is a newer version of this series
rust/kernel/error.rs | 2 ++
1 file changed, 2 insertions(+)
[PATCH v2] rust: update error.rs documentation
Posted by Onur Özkan 2 months, 1 week ago
Adds missing header links.

Signed-off-by: Onur Özkan <work@onurozkan.dev>
---
 rust/kernel/error.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/rust/kernel/error.rs b/rust/kernel/error.rs
index 3dee3139fcd4..dd3e4224218d 100644
--- a/rust/kernel/error.rs
+++ b/rust/kernel/error.rs
@@ -2,6 +2,8 @@

 //! Kernel errors.
 //!
+//! C header: [`arch/mips/include/uapi/asm/errno.h`](srctree/arch/mips/include/uapi/asm/errno.h)
+//! C header: [`include/linux/errno.h`](srctree/include/linux/errno.h)
 //! C header: [`include/uapi/asm-generic/errno-base.h`](srctree/include/uapi/asm-generic/errno-base.h)

 use crate::{
--
2.50.0

Re: [PATCH v2] rust: update error.rs documentation
Posted by Daniel Almeida 2 months, 1 week ago
Hi Onur,

> On 30 Jul 2025, at 09:04, Onur Özkan <work@onurozkan.dev> wrote:
> 
> Adds missing header links.
> 
> Signed-off-by: Onur Özkan <work@onurozkan.dev>

This is a v2 but there is no changelog.

Could you let us know what changed in future iterations, if any?

> ---
> rust/kernel/error.rs | 2 ++
> 1 file changed, 2 insertions(+)
> 
> diff --git a/rust/kernel/error.rs b/rust/kernel/error.rs
> index 3dee3139fcd4..dd3e4224218d 100644
> --- a/rust/kernel/error.rs
> +++ b/rust/kernel/error.rs
> @@ -2,6 +2,8 @@
> 
> //! Kernel errors.
> //!
> +//! C header: [`arch/mips/include/uapi/asm/errno.h`](srctree/arch/mips/include/uapi/asm/errno.h)

Why is this mips file being referenced here? :)

> +//! C header: [`include/linux/errno.h`](srctree/include/linux/errno.h)
> //! C header: [`include/uapi/asm-generic/errno-base.h`](srctree/include/uapi/asm-generic/errno-base.h)
> 
> use crate::{
> --
> 2.50.0
> 
> 

— Daniel
Re: [PATCH v2] rust: update error.rs documentation
Posted by Onur Özkan 2 months ago
On Wed, 30 Jul 2025 10:56:35 -0300
Daniel Almeida <daniel.almeida@collabora.com> wrote:

> Hi Onur,
> 
> > On 30 Jul 2025, at 09:04, Onur Özkan <work@onurozkan.dev> wrote:
> > 
> > Adds missing header links.
> > 
> > Signed-off-by: Onur Özkan <work@onurozkan.dev>
> 
> This is a v2 but there is no changelog.
> 
> Could you let us know what changed in future iterations, if any?


I thought it wasn't necessary for short/simple patches, my bad.
I will make sure to do it for all patches from now on.
 
> > ---
> > rust/kernel/error.rs | 2 ++
> > 1 file changed, 2 insertions(+)
> > 
> > diff --git a/rust/kernel/error.rs b/rust/kernel/error.rs
> > index 3dee3139fcd4..dd3e4224218d 100644
> > --- a/rust/kernel/error.rs
> > +++ b/rust/kernel/error.rs
> > @@ -2,6 +2,8 @@
> > 
> > //! Kernel errors.
> > //!
> > +//! C header:
> > [`arch/mips/include/uapi/asm/errno.h`](srctree/arch/mips/include/uapi/asm/errno.h)
> 
> Why is this mips file being referenced here? :)

I was looking for where EOVERFLOW is defined, it turns out it's
defined in multiple places (didn't know that yesterday). The one that
bindgen resolves to is from `srctree/include/uapi/asm-generic/errno.h`
header, I will send a v3 with the changelog at the end of the day.

Regards,
Onur