Skip to content

Commit 5b30b3d

Browse files
committed
Fix command names
1 parent 8f3a342 commit 5b30b3d

File tree

2 files changed

+12
-32
lines changed

2 files changed

+12
-32
lines changed

README.md

Lines changed: 11 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Then call `phpbenchkit`, it will add vhosts and run Docker benchmatk kit contain
3030
# Add vhosts if needed, run Docker container and call bin/console to show available commands
3131
phpbenchkit
3232

33-
# Restart Docker container
33+
# Restart Docker container
3434
phpbenchkit --restart
3535

3636
# Stop Docker container
@@ -68,41 +68,21 @@ To make your benchmark work you will need some files into `.phpbenchmarks` direc
6868
* `responseBody/`: benchmark url body will be compared to files in this directory to validate it's content.
6969
* `composer/composer.lock.phpX.Y`: created by `phpbenchkit composer:update` to install dependencies by PHP version.
7070

71-
All this files can be created and configured with `phpbenchkit` commands:
71+
All this files can be created and configured with `configure` commands.
7272

73-
```
74-
composer
75-
composer:update Execute composer update for all enabled PHP versions and create .phpbenchmarks/composer/composer.lock.phpX.Y
76-
configure
77-
configure:all Call all configure commands and composer:update
78-
configure:configuration-class Create .phpbenchmarks/Configuration.php and configure it
79-
configure:configuration-class:source-code-urls Create .phpbenchmarks/Configuration.php and configure getSourceCodeUrls()
80-
configure:directory Create .phpbenchmarks directory and subdirectories
81-
configure:initBenchmark Create .phpbenchmarks/initBenchmark.sh
82-
configure:readme Create README.md
83-
configure:response-body Create .phpbenchmarks/responseBody files
84-
configure:vhost Create .phpbenchmarks/vhost.conf
85-
```
73+
See list of configure commands with `phpbenchkit configure:`.
8674

87-
You can call `configure:all` to create all of them or use the one your need.
75+
You can call `phpbenchkit configure:benchmark` to create all of them or use the one your need.
8876

8977
```bash
90-
phpbench composer:update
78+
phpbenchkit composer:update
9179
# you can specify a version of php
92-
phpbench composer:update 7.1
80+
phpbenchkit composer:update 7.1
9381
```
9482

95-
You can validate each part of your configuration with `phpbench` commands:
96-
```
97-
validate:all Call all validate commands
98-
validate:composer:json Validate dependencies in composer.json
99-
validate:composer:lock Validate dependencies in .phpbenchmarks/composer/composer.lock.phpX.Y
100-
validate:configuration:class Validate .phpbenchmarks/Configuration.php
101-
validate:configuration:class:sourceCodeUrls Validate .phpbenchmarks/Configuration.php::getSourceCodeUrls()
102-
validate:configuration:initBenchmark Validate .phpbenchmarks/initBenchmark.sh
103-
validate:configuration:responseBody Validate .phpbenchmarks/responseBody files
104-
validate:configuration:vhost Validate .phpbenchmarks/vhost.conf
105-
```
83+
You can validate each part of your configuration with `validate`.
84+
85+
See list of validation commands with with `phpbenchkit validate:`.
10686

10787
## #4 Add required feaures for benchmarks
10888

@@ -125,11 +105,11 @@ To change PHP version (CLI and FPM):
125105
phpbenchkit
126106
```
127107

128-
When you think it's ok, use `phpbench benchmark:validate` to validate it.
108+
When you think it's ok, use `phpbenchkit validate:benchmark` to validate it.
129109

130110
## #6 Submit your code
131111

132-
When `phpbench benchmark:validate` say it's good, push your code,
112+
When `phpbenchkit validate:benchmark` say it's good, push your code,
133113
then you can tell us to launch benchmarks with [contact form](http://www.phpbenchmarks.com/en/contact?subject=launch-benchmark).
134114

135115
Thank you!

src/Command/DefaultCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
101101
$this->outputBlock(
102102
[
103103
'Benchmark need to be configured before doing anything.',
104-
'Call "phpbenchkit configure:all" to configure it.'
104+
'Call "phpbenchkit configure:benchmark" to configure it.'
105105
],
106106
$backgroundColor,
107107
$output

0 commit comments

Comments
 (0)