Skip to content

Commit

Permalink
Rename ponybench to match standard naming conventions. (#4033)
Browse files Browse the repository at this point in the history
  • Loading branch information
SeanTAllen authored Feb 23, 2022
1 parent cd5d2b4 commit f87574b
Show file tree
Hide file tree
Showing 15 changed files with 28 additions and 13 deletions.
15 changes: 15 additions & 0 deletions .release-notes/ponybench-rename.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Rename `ponybench` package to match standard library naming conventions

We recently realized that when we renamed large portions of the standard library to conform with our naming standards, that we missed the `ponybench` package. To conform with the naming convention, the `ponybench` package as been renamed to `pony_bench`.

You'll need to update your test code from:

```pony
use "ponybench"
```

to

```pony
use "pony_bench"
```
1 change: 1 addition & 0 deletions examples/pony_bench/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pony_bench
14 changes: 7 additions & 7 deletions examples/ponybench/README.md → examples/pony_bench/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ponybench
# pony_bench

A program showing use of the `ponybench` package.
A program showing use of the `pony_bench` package.

## How to Compile

Expand All @@ -17,16 +17,16 @@ Generating
Functions
Descriptors
Optimising
Writing ./ponybench.o
Linking ./ponybench
Writing ./pony_bench.o
Linking ./pony_bench
```

## How to Run

Once `ponybench` has been compiled, in the same directory as this README file run `./ponybench`. You should see a benchmark report including: benchmark name, mean, median, deviation, and iterations.
Once `pony_bench` has been compiled, in the same directory as this README file run `./pony_bench`. You should see a benchmark report including: benchmark name, mean, median, deviation, and iterations.

```console
$ ./ponybench
$ ./pony_bench
Benchmark results will have their mean and median adjusted for overhead.
You may disable this with --noadjust.

Expand All @@ -43,7 +43,7 @@ _Timer (10000 ns) 6025 ns 6060 ns ±2.66%
Modify the program to add a benchmark using the math package's `Fibonacci` primitive.

```console
$ ./ponybench
$ ./pony_bench
Benchmark results will have their mean and median adjusted for overhead.
You may disable this with --noadjust.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use "ponybench"
use "pony_bench"
use "time"

actor Main is BenchmarkList
Expand Down
1 change: 0 additions & 1 deletion examples/ponybench/.gitignore

This file was deleted.

2 changes: 1 addition & 1 deletion packages/buffered/benchmarks/main.pony
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use ".."
use "ponybench"
use "pony_bench"
use "collections"

actor Main is BenchmarkList
Expand Down
2 changes: 1 addition & 1 deletion packages/collections/persistent/benchmarks/main.pony
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use ".."
use mut = "collections"
use "ponybench"
use "pony_bench"

type K is String
type V is U64
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion packages/random/benchmarks/main.pony
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use ".."
use "ponybench"
use "pony_bench"

actor Main is BenchmarkList
new create(env: Env) =>
Expand Down
2 changes: 1 addition & 1 deletion packages/stdlib/_test.pony
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ use itertools = "itertools"
use json = "json"
use math = "math"
use net = "net"
use ponybench = "ponybench"
use pony_bench = "pony_bench"
use process = "process"
use promises = "promises"
use random = "random"
Expand Down

0 comments on commit f87574b

Please sign in to comment.