Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing --profile-export-file help description and cli docs description #374

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading