[PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs

[PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs

[djfkvcing117]

From: Tong Li <djfkvcing117@gmail.com>

In rust/kernel/fs/file.rs, replace plain-text `EBADF` in the doc comment for BadFdError with an intra-doc link [`EBADF`].

This improves the generated documentation (so the `EBADF` constant is linked), and helps tools such as rust-analyzer to resolve such references from the docs.

Suggested-by: Onur Özkan <work@onurozkan.dev>
Link: https://github.com/Rust-for-Linux/linux/issues/1186
Signed-off-by: Tong Li <djfkvcing117@gmail.com>
---
 rust/kernel/fs/file.rs | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/rust/kernel/fs/file.rs b/rust/kernel/fs/file.rs
index 67a3654f0fd3..f3153f4c8560 100644
--- a/rust/kernel/fs/file.rs
+++ b/rust/kernel/fs/file.rs
@@ -448,9 +448,9 @@ fn drop(&mut self) {
     }
 }
 
-/// Represents the `EBADF` error code.
+/// Represents the [`EBADF`] error code.
 ///
-/// Used for methods that can only fail with `EBADF`.
+/// Used for methods that can only fail with [`EBADF`].
 #[derive(Copy, Clone, Eq, PartialEq)]
 pub struct BadFdError;
 
-- 
2.34.1

Re: [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs

[Onur Özkan]

On Wed, 17 Sep 2025 11:38:33 +0800
djfkvcing117@gmail.com wrote:

> From: Tong Li <djfkvcing117@gmail.com>
> 
> In rust/kernel/fs/file.rs, replace plain-text `EBADF` in the doc
> comment for BadFdError with an intra-doc link [`EBADF`].
> 
> This improves the generated documentation (so the `EBADF` constant is
> linked), and helps tools such as rust-analyzer to resolve such
> references from the docs.
> 
> Suggested-by: Onur Özkan <work@onurozkan.dev>
> Link: https://github.com/Rust-for-Linux/linux/issues/1186
> Signed-off-by: Tong Li <djfkvcing117@gmail.com>
> ---
>  rust/kernel/fs/file.rs | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/rust/kernel/fs/file.rs b/rust/kernel/fs/file.rs
> index 67a3654f0fd3..f3153f4c8560 100644
> --- a/rust/kernel/fs/file.rs
> +++ b/rust/kernel/fs/file.rs
> @@ -448,9 +448,9 @@ fn drop(&mut self) {
>      }
>  }
>  
> -/// Represents the `EBADF` error code.
> +/// Represents the [`EBADF`] error code.
>  ///
> -/// Used for methods that can only fail with `EBADF`.
> +/// Used for methods that can only fail with [`EBADF`].
>  #[derive(Copy, Clone, Eq, PartialEq)]
>  pub struct BadFdError;
>  

Hi Tong,

The description doesn't follow the style guidelines (lines are too
long). Please run `./scripts/checkpatch.pl $path_to_patch_file` to
verify before submitting patches.

Also, make sure to version your patches with each revision (e.g., `git
format-patch $commit -vN`). There are already several patches with the
same titles on the mailing list.

Thanks,
Onur

[PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs

[Tong]

From af7f05e99ed67f57c83e51ca3a1b3010e3e87762 Mon Sep 17 00:00:00 2001
From: tong <djfkvcing117@gmail.com>
Date: Wed, 17 Sep 2025 00:25:44 +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` in the doc
comment for BadFdError with an intra-doc link [`EBADF`].

This improves the generated documentation (so the `EBADF` constant is
linked), and helps tools such as rust-analyzer to resolve such
references from the docs.

Suggested-by: Onur Özkan <work@onurozkan.dev>
Link: https://github.com/Rust-for-Linux/linux/issues/1186
Signed-off-by: tong <djfkvcing117@gmail.com>
---
 rust/kernel/fs/file.rs | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/rust/kernel/fs/file.rs b/rust/kernel/fs/file.rs
index 67a3654f0fd3..f3153f4c8560 100644
--- a/rust/kernel/fs/file.rs
+++ b/rust/kernel/fs/file.rs
@@ -448,9 +448,9 @@ fn drop(&mut self) {
     }
 }

-/// Represents the `EBADF` error code.
+/// Represents the [`EBADF`] error code.
 ///
-/// Used for methods that can only fail with `EBADF`.
+/// Used for methods that can only fail with [`EBADF`].
 #[derive(Copy, Clone, Eq, PartialEq)]
 pub struct BadFdError;

-- 
2.34.1

Re: [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs

[Greg KH]

On Wed, Sep 17, 2025 at 01:13:38AM +0800, Tong wrote:
> >From af7f05e99ed67f57c83e51ca3a1b3010e3e87762 Mon Sep 17 00:00:00 2001
> From: tong <djfkvcing117@gmail.com>
> Date: Wed, 17 Sep 2025 00:25:44 +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

Perhaps try using git send-email?  That way this will not show up in the
body of the message.

> In rust/kernel/fs/file.rs, replace plain-text `EBADF` in the doc
> comment for BadFdError with an intra-doc link [`EBADF`].
> 
> This improves the generated documentation (so the `EBADF` constant is
> linked), and helps tools such as rust-analyzer to resolve such
> references from the docs.
> 
> Suggested-by: Onur Özkan <work@onurozkan.dev>
> Link: https://github.com/Rust-for-Linux/linux/issues/1186
> Signed-off-by: tong <djfkvcing117@gmail.com>

We need a full name please.

thanks,

greg k-h

[PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs

[Tong]

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@onurozkan.dev>
Link: https://github.com/Rust-for-Linux/linux/issues/1186
Signed-off-by: djfkvcing117@gmail.com

---

From 87d6b4e61da0db96a018b86baa011b9c6635e665 Mon Sep 17 00:00:00 2001
From: Webb321 <140618222+Webb321@users.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@onurozkan.dev>
Link: https://github.com/Rust-for-Linux/linux/issues/1186

Signed-off-by: djfkvcing117@gmail.com
---
 rust/kernel/fs/file.rs | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/rust/kernel/fs/file.rs b/rust/kernel/fs/file.rs
index 67a3654f0fd370..f3153f4c8560bb 100644
--- a/rust/kernel/fs/file.rs
+++ b/rust/kernel/fs/file.rs
@@ -448,9 +448,9 @@ impl Drop for FileDescriptorReservation {
     }
 }

-/// Represents the `EBADF` error code.
+/// Represents the [`EBADF`] error code.
 ///
-/// Used for methods that can only fail with `EBADF`.
+/// Used for methods that can only fail with [`EBADF`].
 #[derive(Copy, Clone, Eq, PartialEq)]
 pub struct BadFdError;

Re: [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs

[Greg KH]

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@onurozkan.dev>
> Link: https://github.com/Rust-for-Linux/linux/issues/1186
> Signed-off-by: djfkvcing117@gmail.com
> 
> ---
> 
> >From 87d6b4e61da0db96a018b86baa011b9c6635e665 Mon Sep 17 00:00:00 2001
> From: Webb321 <140618222+Webb321@users.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@onurozkan.dev>
> Link: https://github.com/Rust-for-Linux/linux/issues/1186
> 
> Signed-off-by: djfkvcing117@gmail.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

Re: [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs

[Greg KH]

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

Re: [PATCH] rust/fs: use intra-doc link for `EBADF` in `BadFdError` docs

[Onur]

Hi Tong,

On Tue, 16 Sep 2025 22:25:41 +0800
Tong <djfkvcing117@gmail.com> 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>

This is wrong.

> 
> ---
> 
> From 676dd0d1d9276d5dd2a83469ac392732c0a1f34a Mon Sep 17 00:00:00 2001
> From: Webb321 <140618222+Webb321@users.noreply.github.com>
> Date: Tue, 16 Sep 2025 22:15:25 +0800
> Subject: [PATCH] rust/fs: use intra-doc link for `EBADF` in
> `BadFdError` docs
> 
> In `rust/kernel/fs/file.rs`, replace plain text `EBADF` references in
> the doc comment of `BadFdError` with intra-doc links [`EBADF`].
> 
> 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

Should be: Suggested-by: Onur Özkan <work@onurozkan.dev>

> Link: https://github.com/Rust-for-Linux/linux/issues/1186
> Signed-off-by: djfkvcing117@gmail.com
> ---
>  rust/kernel/fs/file.rs | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
>  diff --git a/rust/kernel/fs/file.rs b/rust/kernel/fs/file.rs
>  index 35fd5db35c4652..761a9074d65205 100644
>  --- a/rust/kernel/fs/file.rs
>  +++ b/rust/kernel/fs/file.rs
>  @@ -447,7 +447,7 @@ impl Drop for FileDescriptorReservation { } }
>   -/// Represents the `EBADF` error code.
>   +/// Represents the [`EBADF`] error code.
>   ///
>   /// Used for methods that can only fail with `EBADF`.

You missed fixing the second `EBADF` here.

>   #[derive(Copy, Clone, Eq, PartialEq)]


Thanks,
Onur