[PATCH] rust/drm/gem: Fix missing header in `Object` rustdoc

Lyude Paul posted 1 patch 3 months ago
rust/kernel/drm/gem/mod.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] rust/drm/gem: Fix missing header in `Object` rustdoc
Posted by Lyude Paul 3 months ago
Invariants should be prefixed with a # to turn it into a header.

There are no functional changes in this patch.

Signed-off-by: Lyude Paul <lyude@redhat.com>
---
 rust/kernel/drm/gem/mod.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rust/kernel/drm/gem/mod.rs b/rust/kernel/drm/gem/mod.rs
index eb5f3feac8907..a7f682e95c018 100644
--- a/rust/kernel/drm/gem/mod.rs
+++ b/rust/kernel/drm/gem/mod.rs
@@ -164,7 +164,7 @@ impl<T: IntoGEMObject> BaseObject for T {}
 
 /// A base GEM object.
 ///
-/// Invariants
+/// # Invariants
 ///
 /// - `self.obj` is a valid instance of a `struct drm_gem_object`.
 #[repr(C)]

base-commit: ade19c5060dfa39b84a9475a4a6b05e2a8a2b3ac
-- 
2.51.1
Re: [PATCH] rust/drm/gem: Fix missing header in `Object` rustdoc
Posted by Alice Ryhl 2 months, 4 weeks ago
On Fri, Nov 07, 2025 at 03:25:56PM -0500, Lyude Paul wrote:
> Invariants should be prefixed with a # to turn it into a header.
> 
> There are no functional changes in this patch.
> 
> Signed-off-by: Lyude Paul <lyude@redhat.com>

Applied to drm-rust-next. Thanks!
Re: [PATCH] rust/drm/gem: Fix missing header in `Object` rustdoc
Posted by Miguel Ojeda 3 months ago
On Fri, Nov 7, 2025 at 9:26 PM Lyude Paul <lyude@redhat.com> wrote:
>
> Invariants should be prefixed with a # to turn it into a header.
>
> There are no functional changes in this patch.
>
> Signed-off-by: Lyude Paul <lyude@redhat.com>

Thanks for taking care of the docs, very much appreciated :)

Cc: stable@vger.kernel.org
Fixes: c284d3e42338 ("rust: drm: gem: Add GEM object abstraction")

Cheers,
Miguel