1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: benchmark/README.md copyedit

Browse Source 
PR-URL: https://github.com/nodejs/io.js/pull/1970
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
This commit is contained in:
Rich Trott 2015-06-13 09:07:20 -07:00
parent 3777f41562
commit 5c2707c1b2
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
benchmark/README.md
View File

@ -13,9 +13,11 @@ These are most often available through your preferred package manager.
## How to run tests ## How to run tests
There are two ways to run benchmark tests: There are three ways to run benchmark tests:
1. Run all tests of a given type, for example, buffers ### Run all tests of a given type
For example, buffers:
```sh ```sh
iojs benchmark/common.js buffers iojs benchmark/common.js buffers
@ -24,7 +26,7 @@ iojs benchmark/common.js buffers
The above command will find all scripts under `buffers` directory and require The above command will find all scripts under `buffers` directory and require
each of them as a module. When a test script is required, it creates an instance each of them as a module. When a test script is required, it creates an instance
of `Benchmark` (a class defined in common.js). In the next tick, the `Benchmark` of `Benchmark` (a class defined in common.js). In the next tick, the `Benchmark`
constructor iterates through the configuration object property values and run constructor iterates through the configuration object property values and runs
the test function with each of the combined arguments in spawned processes. For the test function with each of the combined arguments in spawned processes. For
example, buffers/buffer-read.js has the following configuration: example, buffers/buffer-read.js has the following configuration:
@ -75,7 +77,11 @@ buffers/buffer-read.js noAssert=false buffer=fast type=UInt16BE millions=1: 244.
... ...
``` ```
2. Run an individual test, for example, buffer-slice.js The last number is the rate of operations. Higher is better.
### Run an individual test
For example, buffer-slice.js:
```sh ```sh
iojs benchmark/buffers/buffer-read.js iojs benchmark/buffers/buffer-read.js
@ -88,7 +94,7 @@ buffers/buffer-read.js noAssert=false buffer=fast type=UInt16BE millions=1: 245.
... ...
``` ```
3. Run tests with options ### Run tests with options
This example will run only the first type of url test, with one iteration. This example will run only the first type of url test, with one iteration.
(Note: benchmarks require __many__ iterations to be statistically accurate.) (Note: benchmarks require __many__ iterations to be statistically accurate.)