From 352b52a0c9f24ec82b2573a78cd65c0c19b6d29f Mon Sep 17 00:00:00 2001 From: Federico Ceratto Date: Sun, 10 Feb 2019 19:52:13 +0000 Subject: [PATCH] Add note on channel usage with spawn (#10627) [ci skip] --- lib/system/channels.nim | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/lib/system/channels.nim b/lib/system/channels.nim index 14d3a30055..057ea28436 100644 --- a/lib/system/channels.nim +++ b/lib/system/channels.nim @@ -7,12 +7,17 @@ # distribution, for details about the copyright. # -## Channel support for threads. **Note**: This is part of the system module. -## Do not import it directly. To activate thread support you need to compile -## with the ``--threads:on`` command line switch. +## Channel support for threads. +## +## **Note**: This is part of the system module. Do not import it directly. +## To activate thread support compile with the ``--threads:on`` command line switch. +## +## **Note:** Channels are designed for the ``Thread`` type. They are unstable when +## used with ``spawn`` ## ## **Note:** The current implementation of message passing does ## not work with cyclic data structures. +## ## **Note:** Channels cannot be passed between threads. Use globals or pass ## them by `ptr`.