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

Documentation example should not use opam run list #15

Open
gasche opened this issue Aug 22, 2015 · 3 comments
Open

Documentation example should not use opam run list #15

gasche opened this issue Aug 22, 2015 · 3 comments
Assignees

Comments

@gasche
Copy link

gasche commented Aug 22, 2015

The document uses consecutively

operf-micro list

and

operf-micro run list

I assumed that the latter was an ugly syntax to say "run all the benchmarks returned by the list command", not that they would build the benchmark for list-related functions.

You should clarify that ambiguity by choosing a different example of set of benchmarks in the second command.

@gasche
Copy link
Author

gasche commented Aug 22, 2015

P.S.: you should also document the command that run all built benchmarks.

@chambart
Copy link
Member

The syntax of the documentation is clearly not the right one. This should be read as

operf-micro run [list]

For instance if you want to run bdd an kb benchmarks, you would run

operf-micro run bdd kb

@gasche
Copy link
Author

gasche commented Aug 24, 2015

I think it would be clearest to give operf-micro run as one example of command, and then operf-micro run bdd kb as another example. (Rather than giving the general rule in this introduction.)

@chambart chambart self-assigned this Aug 24, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants