Add caveats section to Toplevel::catch_signals

Finomnis · May 16, 2022 · 5211d22 · 5211d22
1 parent c57a783
commit 5211d22
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/src/toplevel.rs b/src/toplevel.rs
@@ -121,9 +121,15 @@ impl<ErrType: ErrTypeTraits> Toplevel<ErrType> {
     /// - On Windows:
     ///     - Ctrl+C (SIGINT)
     ///
-    /// - On Linux:
+    /// - On Unix:
     ///     - SIGINT and SIGTERM
     ///
+    /// # Caveats
+    ///
+    /// This function internally uses [tokio::signal] with all of its caveats.
+    ///
+    /// Especially the caveats from [tokio::signal::unix::Signal] are important for Unix targets.
+    ///
     pub fn catch_signals(self) -> Self {
         let shutdown_token = self.subsys_handle.global_shutdown_token().clone();