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 CLI documentation page #271

Merged
merged 5 commits into from
Mar 22, 2023
Merged

Add CLI documentation page #271

merged 5 commits into from
Mar 22, 2023

Conversation

matthewkotila
Copy link
Contributor

@matthewkotila matthewkotila commented Mar 17, 2023

Mainly just copy-and-paste of the CLI help message for each option. I fix some types and change some wording. I can eventually forward these changes to the help message.

src/c++/perf_analyzer/docs/cli.md Outdated Show resolved Hide resolved
src/c++/perf_analyzer/docs/cli.md Outdated Show resolved Hide resolved
@matthewkotila matthewkotila requested a review from tgerdesnv March 21, 2023 00:16
@matthewkotila matthewkotila marked this pull request as ready for review March 21, 2023 00:16
Copy link
Member

@Tabrizian Tabrizian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor comment, otherwise looks good.

src/c++/perf_analyzer/docs/cli.md Show resolved Hide resolved
src/c++/perf_analyzer/docs/cli.md Show resolved Hide resolved
src/c++/perf_analyzer/docs/cli.md Outdated Show resolved Hide resolved
@matthewkotila matthewkotila merged commit 7447d05 into pa-docs Mar 22, 2023
@matthewkotila matthewkotila deleted the matthewkotila-cli branch March 22, 2023 20:46
matthewkotila added a commit that referenced this pull request Apr 12, 2023
* Add CLI documentation page

* Addressed comments

* Addressed comments

* Clean up

* Clean up
matthewkotila added a commit that referenced this pull request Apr 13, 2023
* Add CLI documentation page

* Addressed comments

* Addressed comments

* Clean up

* Clean up
matthewkotila added a commit that referenced this pull request Apr 18, 2023
* Add CLI documentation page

* Addressed comments

* Addressed comments

* Clean up

* Clean up
matthewkotila added a commit that referenced this pull request Apr 20, 2023
* Add quick start documentation page (#261)

* Add quick start documentation page

* Addressed comments

* Addressed comments

* Fixed typo

* Addressed comments

* Add installation documentation page (#266)

* Add installation documentation page

* Add quick start to docs readme

* Add CLI documentation page (#271)

* Add CLI documentation page

* Addressed comments

* Addressed comments

* Clean up

* Clean up

* Rewrite top-level readme (#273)

* Rewrite top-level readme

* Addressed comments

* Add input data, measurements, benchmarking documentation (#274)

* Add data guide documentation

* Add measurement doc

* Add benchmarking doc

* Add more to measurements and metrics doc and new link in readme

* Fix some comments and add more to metrics

* Move data_guide to input_data

* Adjusted header size

* Update all links

* Add back communication protocol docs, fix links, add bls composing models option (#287)

* Fix various things in docs (#288)

* Fix various things in docs

* Addressed comments

* Proof-read all docs (#290)

* Proof-read all docs

* Addressed comments

* Fix docs

---------

Co-authored-by: Matthew Kotila <matthew.r.kotila@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants