Skip to content

Commit

Permalink
Add missing --profile-export-file help description and cli docs descr…
Browse files Browse the repository at this point in the history
…iption (#374)
  • Loading branch information
matthewkotila committed Aug 8, 2023
1 parent b4b93f4 commit 5b2bed1
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/c++/perf_analyzer/command_line_parser.cc
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ CLParser::Usage(const std::string& msg)
std::cerr << std::endl;
std::cerr << "IV. OTHER OPTIONS: " << std::endl;
std::cerr << "\t-f <filename for storing report in csv format>" << std::endl;
std::cerr << "\t--profile-export-file <path>" << std::endl;
std::cerr << "\t-H <HTTP header>" << std::endl;
std::cerr << "\t--streaming" << std::endl;
std::cerr << "\t--grpc-compression-algorithm <compression_algorithm>"
Expand Down Expand Up @@ -608,6 +609,13 @@ CLParser::Usage(const std::string& msg)
"this option. By default, the result is not recorded in a file.",
9)
<< std::endl;
std::cerr << std::setw(9) << std::left << " --profile-export-file: "
<< FormatMessage(
"Specifies the path that the profile export will be "
"generated at. By default, the profile export will not be "
"generated.",
9)
<< std::endl;
std::cerr
<< std::setw(9) << std::left << " -H: "
<< FormatMessage(
Expand Down
7 changes: 7 additions & 0 deletions src/c++/perf_analyzer/docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -529,6 +529,13 @@ Specifies the path that the latency report file will be generated at.

When `-f` is not specified, a latency report will not be generated.

#### `--profile-export-file <path>`

Specifies the path that the profile export will be generated at.

When `--profile-export-file` is not specified, a profile export will not be
generated.

#### `--verbose-csv`

Enables additional information being output to the CSV file generated by Perf
Expand Down

0 comments on commit 5b2bed1

Please sign in to comment.