From 391147c950679d7f466f6e3cd70df46758ea1a11 Mon Sep 17 00:00:00 2001
From: "Dongjia \"toka\" Zhang" <tokazerkje@outlook.com>
Date: Thu, 21 Nov 2024 15:52:12 +0100
Subject: [PATCH] Batched timeout doc (#2716)

* timeout doc

* clp

* FMT
---
 libafl/src/executors/hooks/timer.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/libafl/src/executors/hooks/timer.rs b/libafl/src/executors/hooks/timer.rs
index 9d2492f9ba..97a6289f26 100644
--- a/libafl/src/executors/hooks/timer.rs
+++ b/libafl/src/executors/hooks/timer.rs
@@ -242,6 +242,11 @@ impl TimerStruct {
     #[cfg(target_os = "linux")]
     #[must_use]
     /// Constructor but use batch mode
+    /// Timeout mechanism with imprecise timing.
+    ///
+    /// The timeout will trigger after t seconds and at most within 2*t seconds.
+    /// This means the actual timeout may occur anywhere in the range [t, 2*t],
+    /// providing a flexible but bounded execution time limit.
     pub fn batch_mode(exec_tmout: Duration) -> Self {
         let mut me = Self::new(exec_tmout);
         me.batch_mode = true;