[PATCH] pwm: fix broken intra-doc link

[PATCH] pwm: fix broken intra-doc link

[Miguel Ojeda]

`rustdoc` reports a broken intra-doc link:

    error: unresolved link to `Devres::register`
       --> rust/kernel/pwm.rs:722:11
        |
    722 | /// via [`Devres::register`]. This ties the lifetime of the PWM chip registration
        |           ^^^^^^^^^^^^^^^^ no item named `Devres` in scope
        |
        = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
        = help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]`

Thus fix it.

Fixes: a3d5a2b8da94 ("rust: pwm: Add complete abstraction layer")
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
If you usually rebase your tree, please feel free to do so instead. Thanks!

 rust/kernel/pwm.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rust/kernel/pwm.rs b/rust/kernel/pwm.rs
index 79fbb13cd47f..84000192209d 100644
--- a/rust/kernel/pwm.rs
+++ b/rust/kernel/pwm.rs
@@ -714,7 +714,7 @@ unsafe impl<T: PwmOps + Sync> Sync for Chip<T> {}
 /// A resource guard that ensures `pwmchip_remove` is called on drop.
 ///
 /// This struct is intended to be managed by the `devres` framework by transferring its ownership
-/// via [`Devres::register`]. This ties the lifetime of the PWM chip registration
+/// via [`devres::register`]. This ties the lifetime of the PWM chip registration
 /// to the lifetime of the underlying device.
 pub struct Registration<T: PwmOps> {
     chip: ARef<Chip<T>>,

base-commit: 04a698c800c25149f9aa379250e78f737adeb3f1
--
2.51.2

Re: [PATCH] pwm: fix broken intra-doc link

[Uwe Kleine-König]

[-- Attachment #1: Type: text/plain, Size: 957 bytes --]

Hello Miguel,

On Wed, Oct 29, 2025 at 07:19:40PM +0100, Miguel Ojeda wrote:
> `rustdoc` reports a broken intra-doc link:
> 
>     error: unresolved link to `Devres::register`
>        --> rust/kernel/pwm.rs:722:11
>         |
>     722 | /// via [`Devres::register`]. This ties the lifetime of the PWM chip registration
>         |           ^^^^^^^^^^^^^^^^ no item named `Devres` in scope
>         |
>         = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
>         = help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]`
> 
> Thus fix it.
> 
> Fixes: a3d5a2b8da94 ("rust: pwm: Add complete abstraction layer")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Applied to
https://git.kernel.org/pub/scm/linux/kernel/git/ukleinek/linux.git pwm/for-next
.

I don't consider my tree stable, so if you still want to send review
tags, I'll add them.

Best regards and thanks,
Uwe

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]