Fix comments in example tools

Reviewed By: wangbj

Differential Revision: D33411658

fbshipit-source-id: 595356f8501bfb9cb2b67b4c084154e1cdca07c8
This commit is contained in:
Jason White 2022-01-04 18:13:19 -08:00 committed by Facebook GitHub Bot
parent 15d2f61411
commit 39d5c0b427
2 changed files with 8 additions and 6 deletions

View file

@ -6,6 +6,10 @@
* This source code is licensed under the BSD-style license found in the * This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. * 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::{ use reverie::{
syscalls::{Addr, MemoryAccess, Syscall}, syscalls::{Addr, MemoryAccess, Syscall},
Error, GlobalTool, Guest, Tid, Tool, Error, GlobalTool, Guest, Tid, Tool,
@ -25,8 +29,6 @@ use std::{
use structopt::StructOpt; use structopt::StructOpt;
use tracing::{debug, info, trace}; 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? /// How many system calls (in each thread) define an epoch?
const EPOCH: u64 = 10; const EPOCH: u64 = 10;

View file

@ -7,8 +7,7 @@
* LICENSE file in the root directory of this source tree. * LICENSE file in the root directory of this source tree.
*/ */
//! This instrumentation tool intercepts events but does nothing with them, //! This instrumentation tool does nothing except acting as a gdbserver.
//! except acting as a gdbserver.
use reverie::{Error, Subscription, Tool}; use reverie::{Error, Subscription, Tool};
use reverie_util::CommonToolArguments; use reverie_util::CommonToolArguments;
@ -23,8 +22,9 @@ impl Tool for DebugTool {
} }
} }
/// A tool to introduce inject "chaos" into a running process. A pathological /// A tool that acts as a GDB server. The process will start in a stopped state,
/// kernel is simulated by forcing reads to only return one byte a time. /// waiting for a GDB client to connect. Once the connection is complete,
/// execution of the guest process will continue.
#[derive(Debug, StructOpt)] #[derive(Debug, StructOpt)]
struct Args { struct Args {
#[structopt(flatten)] #[structopt(flatten)]