From 9afba77c595aad7aa87bcaf33938c79d51842808 Mon Sep 17 00:00:00 2001
From: Antoine Tenart <atenart@redhat.com>
Date: Wed, 14 Aug 2024 15:20:54 +0200
Subject: [PATCH] events: document the task event

Suggested-by: Adrian Moreno <amorenoz@redhat.com>
Signed-off-by: Antoine Tenart <atenart@redhat.com>
---
 retis-events/src/common.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/retis-events/src/common.rs b/retis-events/src/common.rs
index c2dcca6e7..58e92b680 100644
--- 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>,
 }