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.

Sign up for GitHub

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

Jump to bottom

doc: copyedit benchmark/README.md #1970

Closed
wants to merge 1 commit into from
Closed

doc: copyedit benchmark/README.md #1970

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 11 additions & 5 deletions benchmark/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ These are most often available through your preferred package manager.

## 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
iojs benchmark/common.js buffers
Expand All @@ -24,7 +26,7 @@ iojs benchmark/common.js buffers
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
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
example, buffers/buffer-read.js has the following configuration:

Expand Down Expand Up @@ -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
iojs benchmark/buffers/buffer-read.js
Expand All @@ -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.
(Note: benchmarks require __many__ iterations to be statistically accurate.)
Expand Down