diff --git a/.release-notes/ponybench-rename.md b/.release-notes/ponybench-rename.md new file mode 100644 index 0000000000..9346d35d9c --- /dev/null +++ b/.release-notes/ponybench-rename.md @@ -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" +``` diff --git a/examples/pony_bench/.gitignore b/examples/pony_bench/.gitignore new file mode 100644 index 0000000000..2470921aa5 --- /dev/null +++ b/examples/pony_bench/.gitignore @@ -0,0 +1 @@ +pony_bench diff --git a/examples/ponybench/README.md b/examples/pony_bench/README.md similarity index 86% rename from examples/ponybench/README.md rename to examples/pony_bench/README.md index 652686670b..38be36a983 100644 --- a/examples/ponybench/README.md +++ b/examples/pony_bench/README.md @@ -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 @@ -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. @@ -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. diff --git a/examples/ponybench/main.pony b/examples/pony_bench/main.pony similarity index 98% rename from examples/ponybench/main.pony rename to examples/pony_bench/main.pony index a504bf6105..da2bb0eaef 100644 --- a/examples/ponybench/main.pony +++ b/examples/pony_bench/main.pony @@ -1,4 +1,4 @@ -use "ponybench" +use "pony_bench" use "time" actor Main is BenchmarkList diff --git a/examples/ponybench/.gitignore b/examples/ponybench/.gitignore deleted file mode 100644 index 3596530487..0000000000 --- a/examples/ponybench/.gitignore +++ /dev/null @@ -1 +0,0 @@ -ponybench diff --git a/packages/buffered/benchmarks/main.pony b/packages/buffered/benchmarks/main.pony index a94738aafd..17b9cc044e 100644 --- a/packages/buffered/benchmarks/main.pony +++ b/packages/buffered/benchmarks/main.pony @@ -1,5 +1,5 @@ use ".." -use "ponybench" +use "pony_bench" use "collections" actor Main is BenchmarkList diff --git a/packages/collections/persistent/benchmarks/main.pony b/packages/collections/persistent/benchmarks/main.pony index 485bbfd7df..d32644b336 100644 --- a/packages/collections/persistent/benchmarks/main.pony +++ b/packages/collections/persistent/benchmarks/main.pony @@ -1,6 +1,6 @@ use ".." use mut = "collections" -use "ponybench" +use "pony_bench" type K is String type V is U64 diff --git a/packages/ponybench/_aggregator.pony b/packages/pony_bench/_aggregator.pony similarity index 100% rename from packages/ponybench/_aggregator.pony rename to packages/pony_bench/_aggregator.pony diff --git a/packages/ponybench/_output_manager.pony b/packages/pony_bench/_output_manager.pony similarity index 100% rename from packages/ponybench/_output_manager.pony rename to packages/pony_bench/_output_manager.pony diff --git a/packages/ponybench/_results.pony b/packages/pony_bench/_results.pony similarity index 100% rename from packages/ponybench/_results.pony rename to packages/pony_bench/_results.pony diff --git a/packages/ponybench/_runner.pony b/packages/pony_bench/_runner.pony similarity index 100% rename from packages/ponybench/_runner.pony rename to packages/pony_bench/_runner.pony diff --git a/packages/ponybench/benchmark.pony b/packages/pony_bench/benchmark.pony similarity index 100% rename from packages/ponybench/benchmark.pony rename to packages/pony_bench/benchmark.pony diff --git a/packages/ponybench/ponybench.pony b/packages/pony_bench/pony_bench.pony similarity index 100% rename from packages/ponybench/ponybench.pony rename to packages/pony_bench/pony_bench.pony diff --git a/packages/random/benchmarks/main.pony b/packages/random/benchmarks/main.pony index 5487194d84..516601cc26 100644 --- a/packages/random/benchmarks/main.pony +++ b/packages/random/benchmarks/main.pony @@ -1,5 +1,5 @@ use ".." -use "ponybench" +use "pony_bench" actor Main is BenchmarkList new create(env: Env) => diff --git a/packages/stdlib/_test.pony b/packages/stdlib/_test.pony index 0cb34841fc..61905a5870 100644 --- a/packages/stdlib/_test.pony +++ b/packages/stdlib/_test.pony @@ -33,7 +33,7 @@ use json = "json" use logger = "logger" use math = "math" use net = "net" -use ponybench = "ponybench" +use pony_bench = "pony_bench" use process = "process" use promises = "promises" use random = "random"