diff --git a/reverie-examples/chunky_print.rs b/reverie-examples/chunky_print.rs index 48b7990..c5220e1 100644 --- a/reverie-examples/chunky_print.rs +++ b/reverie-examples/chunky_print.rs @@ -6,6 +6,10 @@ * This source code is licensed under the BSD-style license found in the * LICENSE file in the root directory of this source tree. */ + +//! This tool will chunk together printed output from each thread, over fixed +//! time intervals. + use reverie::{ syscalls::{Addr, MemoryAccess, Syscall}, Error, GlobalTool, Guest, Tid, Tool, @@ -25,8 +29,6 @@ use std::{ use structopt::StructOpt; use tracing::{debug, info, trace}; -/// This tool will chunk together printed output from each thread, over fixed time intervals. - /// How many system calls (in each thread) define an epoch? const EPOCH: u64 = 10; diff --git a/reverie-examples/debug.rs b/reverie-examples/debug.rs index 05455a5..d03d385 100644 --- a/reverie-examples/debug.rs +++ b/reverie-examples/debug.rs @@ -7,8 +7,7 @@ * LICENSE file in the root directory of this source tree. */ -//! This instrumentation tool intercepts events but does nothing with them, -//! except acting as a gdbserver. +//! This instrumentation tool does nothing except acting as a gdbserver. use reverie::{Error, Subscription, Tool}; use reverie_util::CommonToolArguments; @@ -23,8 +22,9 @@ impl Tool for DebugTool { } } -/// A tool to introduce inject "chaos" into a running process. A pathological -/// kernel is simulated by forcing reads to only return one byte a time. +/// A tool that acts as a GDB server. The process will start in a stopped state, +/// waiting for a GDB client to connect. Once the connection is complete, +/// execution of the guest process will continue. #[derive(Debug, StructOpt)] struct Args { #[structopt(flatten)]