From 5211d22a8faff4f1fd0c04e93aa5d15285ea4228 Mon Sep 17 00:00:00 2001
From: Finomnis <finomnis@gmail.com>
Date: Mon, 16 May 2022 21:11:33 +0200
Subject: [PATCH] Add caveats section to Toplevel::catch_signals

---
 src/toplevel.rs | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/toplevel.rs b/src/toplevel.rs
index 2c6d7bc..eb787a8 100644
--- 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();