Skip to content

Commit

Permalink
[move][tracing] Document flag for generating traces from `sui move te…
Browse files Browse the repository at this point in the history
…st` (#19326)

## Description 

Add documentation for the `trace-execution` flag for `sui move test`,
and also made the `-Xdebug` flag for the disassembler hidden.

## Test plan 

recompiled and manually checked. 

---

## Release notes

Check each box that your changes affect. If none of the boxes relate to
your changes, release notes aren't required.

For each box you select, include information after the relevant heading
that describes the impact of your changes that a user might notice and
any actions they must take to implement updates.

- [ ] Protocol: 
- [ ] Nodes (Validators and Full nodes): 
- [ ] Indexer: 
- [ ] JSON-RPC: 
- [ ] GraphQL: 
- [ ] CLI: 
- [ ] Rust SDK:
- [ ] REST API:
  • Loading branch information
tzakian committed Sep 12, 2024
1 parent 1cbef4f commit 8ffc2a6
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion crates/sui-move/src/disassemble.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ pub struct Disassemble {
module_path: PathBuf,

/// Whether to display the disassembly in raw Debug format
#[clap(long = "Xdebug")]
#[clap(long = "Xdebug", hide = true)]
debug: bool,

#[clap(short = 'i', long = "interactive")]
Expand Down
3 changes: 2 additions & 1 deletion external-crates/move/crates/move-cli/src/base/test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@ pub struct Test {
#[clap(name = "rand-num-iters", long = "rand-num-iters")]
pub rand_num_iters: Option<u64>,

// Enable tracing for tests
/// Enable tracing for tests. A separate trace file will be created for each test. If `PATH` is
/// provided, the trace will be written to the `PATH` directory.
#[clap(long = "trace-execution", value_name = "PATH")]
pub trace_execution: Option<Option<String>>,
}
Expand Down

0 comments on commit 8ffc2a6

Please sign in to comment.