docs

Author: nia-e

src/shims/trace/messages.rs

@@ -1,4 +1,15 @@
 //! Houses the types that are directly sent across the IPC channels.
+//!
+//! The overall structure of a traced FFI call, from the child process's POV, is
+//! as follows:
+//! ```
+//! message_tx.send(TraceRequest::StartFFI);
+//! confirm_rx.recv();
+//! raise(SIGSTOP);
+//! /* do ffi call */
+//! raise(SIGUSR1);
+//! let events = event_rx.recv();
+//! ```
 
 /// An IPC request sent by the child process to the parent.
 ///