[PATCH] rust/drm: Fix Registration::{new,new_foreign_owned}() docs

[PATCH] rust/drm: Fix Registration::{new,new_foreign_owned}() docs

[Lyude Paul]

Looks like we've actually had a malformed rustdoc reference in the rustdocs
for Registration::new_foreign_owned() for a while that, when fixed, still
couldn't resolve properly because it refers to a private item.

This is probably leftover from when Registration::new() was public, so drop
the documentation from that function and fixup the documentation for
Registration::new_foreign_owned().

Signed-off-by: Lyude Paul <lyude@redhat.com>
---
 rust/kernel/drm/driver.rs | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/rust/kernel/drm/driver.rs b/rust/kernel/drm/driver.rs
index f30ee4c6245cd..e09f977b5b519 100644
--- a/rust/kernel/drm/driver.rs
+++ b/rust/kernel/drm/driver.rs
@@ -121,7 +121,6 @@ pub trait Driver {
 pub struct Registration<T: Driver>(ARef<drm::Device<T>>);
 
 impl<T: Driver> Registration<T> {
-    /// Creates a new [`Registration`] and registers it.
     fn new(drm: &drm::Device<T>, flags: usize) -> Result<Self> {
         // SAFETY: `drm.as_raw()` is valid by the invariants of `drm::Device`.
         to_result(unsafe { bindings::drm_dev_register(drm.as_raw(), flags) })?;
@@ -129,8 +128,9 @@ fn new(drm: &drm::Device<T>, flags: usize) -> Result<Self> {
         Ok(Self(drm.into()))
     }
 
-    /// Same as [`Registration::new`}, but transfers ownership of the [`Registration`] to
-    /// [`devres::register`].
+    /// Registers a new [`Device`](drm::Device) with userspace.
+    ///
+    /// Ownership of the [`Registration`] object is passed to [`devres::register`].
     pub fn new_foreign_owned(
         drm: &drm::Device<T>,
         dev: &device::Device<device::Bound>,

base-commit: 6ea52b6d8f33ae627f4dcf43b12b6e713a8b9331
-- 
2.52.0

Re: [PATCH] rust/drm: Fix Registration::{new,new_foreign_owned}() docs

[Danilo Krummrich]

On Thu Jan 22, 2026 at 11:10 PM CET, Lyude Paul wrote:
> Looks like we've actually had a malformed rustdoc reference in the rustdocs
> for Registration::new_foreign_owned() for a while that, when fixed, still
> couldn't resolve properly because it refers to a private item.
>
> This is probably leftover from when Registration::new() was public, so drop
> the documentation from that function and fixup the documentation for
> Registration::new_foreign_owned().
>
> Signed-off-by: Lyude Paul <lyude@redhat.com>

I'd add a Fixes: tag for this, since it's user facing documentation.

Acked-by: Danilo Krummrich <dakr@kernel.org>