Skip to contentSkip to conversation

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

PATCH Applied Lyude Paul 3 participants 3 messages Nov 7, 2025 – Nov 10, 2025

Subsystems (3)
lore
Share & tools
lore

Lyude Paul

author
#0 lore raw

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

Invariants should be prefixed with a # to turn it into a header.

There are no functional changes in this patch.

---
 rust/kernel/drm/gem/mod.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
rust/kernel/drm/gem/mod.rs +1 -1
index eb5f3feac8907..a7f682e95c018 100644
@@ -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

Signature · 1 line
2.51.1
#1 lore raw
Quoted 6 lines · Lyude Paul

Invariants should be prefixed with a # to turn it into a header.

There are no functional changes in this patch.

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

Fixes c284d3e42338 ("rust: drm: gem: Add GEM object abstraction")

Cheers,
Miguel