@@ -899,6 +899,13 @@ reconnectPort them = do
899-- Debugging/Tracing --
899-- Debugging/Tracing --
900--------------------------------------------------------------------------------
900--------------------------------------------------------------------------------
902+-- | Send a message to the internal (system) trace facility. If tracing is
903+-- enabled, this will create a custom trace event in the event log. Specifically,
904+-- the environment variable @DISTRIBUTED_PROCESS_TRACE_FILE@ is set to a valid
905+-- path, then trace output will be written to that file. Otherwise, if the GHC
906+-- eventlog is enabled (i.e., you've compiled with @-eventlog@ set) and the
907+-- relevant @+RTS@ options given, then the message will be sent to the event log.
908+-- If neither facility is in use then trace messages will be silently dropped.
902trace :: String -> Process ()
909trace :: String -> Process ()
903trace s = do
910trace s = do
904 node <- processNode <$> ask
911 node <- processNode <$> ask