events: document the task event

Suggested-by: Adrian Moreno <[email protected]> Signed-off-by: Antoine Tenart <[email protected]>
retis-org · Sep 25, 2024 · 9afba77 · 9afba77
1 parent d117ac5
commit 9afba77
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/retis-events/src/common.rs b/retis-events/src/common.rs
@@ -20,6 +20,7 @@ impl EventFmt for StartupEvent {
     }
 }
 
+/// Information about a given task.
 #[event_type]
 #[derive(Default)]
 pub struct TaskEvent {
@@ -38,6 +39,7 @@ pub struct CommonEvent {
     pub timestamp: u64,
     /// SMP processor id.
     pub smp_id: Option<u32>,
+    /// Information about the task linked to the event.
     pub task: Option<TaskEvent>,
 }