Skip to content

Commit

Permalink
[docs] Update docs renaming gas-profiler to tracing
Browse files Browse the repository at this point in the history
  • Loading branch information
tzakian committed Oct 29, 2024
1 parent 2e900f8 commit cae3212
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/content/references/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ Sui provides a command line interface (CLI) tool to interact with the Sui networ
To get the latest version of the CLI, you can run the following command from a terminal or console. Be sure to replace `<BRANCH-NAME>` with `main`, `devnet`, `testnet`, or `mainnet` to get the desired version. For more information on the branches available, see [Sui Environment Setup](./contribute/sui-environment.mdx).

```shell
cargo install --locked --git https://github.com/MystenLabs/sui.git --branch <BRANCH-NAME> --features gas-profiler sui
cargo install --locked --git https://github.com/MystenLabs/sui.git --branch <BRANCH-NAME> --features tracing sui
```

:::info

The `--features gas-profiler` flag is necessary only if you want to run gas profiles for transactions.
The `--features tracing` flag is necessary only if you want to run gas profiles for transactions.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/content/references/cli/client.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -473,10 +473,10 @@ and produce a gas profile. Similar to the `replay` command, this command fetches
Full node specified in the client environment that are needed to execute the transaction. During the local execution of the transaction,
this command records all the Move function invocations and the gas cost breakdown for each invocation.

To enable the profiler, you must either install or build the Sui Client binary locally with the `--features gas-profiler` flag.
To enable the profiler, you must either install or build the Sui Client binary locally with the `--features tracing` flag.

```shell
cargo install --locked --git https://github.com/MystenLabs/sui.git --branch <BRANCH-NAME> --features gas-profiler sui
cargo install --locked --git https://github.com/MystenLabs/sui.git --branch <BRANCH-NAME> --features tracing sui
```

The command outputs a profile to the current working directory in the format `gas_profile_{tx_digest}_{unix_timestamp}.json`.
Expand Down

0 comments on commit cae3212

Please sign in to comment.