From abe3e8628ea1fc643e3e61aee4d149a3c01f055e Mon Sep 17 00:00:00 2001 From: Brook Heisler Date: Wed, 6 Jul 2022 16:17:51 -0600 Subject: [PATCH 1/8] Update changelog, fix typo in CONTRIBUTING. --- CHANGELOG.md | 1 + CONTRIBUTING.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 70d806c7..5307c780 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] ### Changed - MSRV bumped to 1.49 +- Symbol for microseconds changed from ASCII 'us' to unicode 'µs' ## [0.3.5] - 2021-07-26 ### Fixed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ec11e5cf..59ae0262 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,7 +60,7 @@ Some things that will increase the chance that your pull request is accepted: * PRs with breaking changes are made against the unreleased branch. e.g. branch version-0.4 * PRs without breaking changes are made against the master branch. -If your not sure which branch to use just start with master, as this can be changed during review. +If you're not sure which branch to use just start with master, as this can be changed during review. When it is time to release the unreleased branch, a PR is made from the unreleased branch to master. e.g. https://github.com/bheisler/criterion.rs/pull/496 From 38fee32c72fcdcd3f23b778c770bc62001efca10 Mon Sep 17 00:00:00 2001 From: Brook Heisler Date: Wed, 6 Jul 2022 16:27:38 -0600 Subject: [PATCH 2/8] Update dependencies. --- Cargo.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index c8532ee9..6b1f5220 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -25,11 +25,11 @@ serde_json = "1.0" serde_derive = "1.0" serde_cbor = "0.11" atty = "~0.2.6" -clap = { version = "2.33", default-features = false } +clap = { version = "2.34", default-features = false } csv = "1.1" walkdir = "2.3" tinytemplate = "1.1" -cast = "0.2" +cast = "0.3" num-traits = { version = "0.2", default-features = false } oorandom = "11.1" rayon = "1.3" From f9ccd05caad4d068679074c3bc33c3f712ff2343 Mon Sep 17 00:00:00 2001 From: Brook Heisler Date: Wed, 6 Jul 2022 16:33:46 -0600 Subject: [PATCH 3/8] Update version number and changelog. --- CHANGELOG.md | 7 ++++++- Cargo.toml | 2 +- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5307c780..aa7dc195 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,9 +5,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). ## [Unreleased] + +## [0.3.6] - 2022-07-06 ### Changed - MSRV bumped to 1.49 - Symbol for microseconds changed from ASCII 'us' to unicode 'µs' +- Documentation fixes +- Clippy fixes ## [0.3.5] - 2021-07-26 ### Fixed @@ -400,7 +404,7 @@ more details - Initial release on Crates.io. -[Unreleased]: https://github.com/bheisler/criterion.rs/compare/0.3.4...HEAD +[Unreleased]: https://github.com/bheisler/criterion.rs/compare/0.3.6...HEAD [0.1.1]: https://github.com/bheisler/criterion.rs/compare/0.1.0...0.1.1 [0.1.2]: https://github.com/bheisler/criterion.rs/compare/0.1.1...0.1.2 [0.2.0]: https://github.com/bheisler/criterion.rs/compare/0.1.2...0.2.0 @@ -421,3 +425,4 @@ more details [0.3.3]: https://github.com/bheisler/criterion.rs/compare/0.3.2...0.3.3 [0.3.4]: https://github.com/bheisler/criterion.rs/compare/0.3.3...0.3.4 [0.3.5]: https://github.com/bheisler/criterion.rs/compare/0.3.4...0.3.5 +[0.3.5]: https://github.com/bheisler/criterion.rs/compare/0.3.5...0.3.6 diff --git a/Cargo.toml b/Cargo.toml index 6b1f5220..fd0739dd 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,7 +4,7 @@ authors = [ "Brook Heisler ", ] name = "criterion" -version = "0.3.5" +version = "0.3.6" edition = "2018" description = "Statistics-driven micro-benchmarking library" From 045dbfaa36ccd34e5158859ed72a1ff6f726c01e Mon Sep 17 00:00:00 2001 From: Brook Heisler Date: Wed, 6 Jul 2022 17:35:24 -0600 Subject: [PATCH 4/8] Bump MSRV; upstream dependencies now require 1.56.1 --- .github/workflows/ci.yaml | 2 +- README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 17f20637..ce137571 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -16,7 +16,7 @@ jobs: rust: - stable - beta - - 1.49.0 # MSRV + - 1.56.1 # MSRV steps: - uses: actions/checkout@v2 diff --git a/README.md b/README.md index 2f5262e1..a243e983 100644 --- a/README.md +++ b/README.md @@ -117,9 +117,9 @@ For more details, see the [CONTRIBUTING.md file](https://github.com/bheisler/cri ### Compatibility Policy Criterion.rs supports the last three stable minor releases of Rust. At time of -writing, this means Rust 1.50 or later. Older versions may work, but are not guaranteed. +writing, this means Rust 1.59 or later. Older versions may work, but are not guaranteed. -Currently, the oldest version of Rust believed to work is 1.49. Future versions of Criterion.rs may +Currently, the oldest version of Rust believed to work is 1.56.1. Future versions of Criterion.rs may break support for such old versions, and this will not be considered a breaking change. If you require Criterion.rs to work on old versions of Rust, you will need to stick to a specific patch version of Criterion.rs. From 06be43cda0169f5b9c91eb0298545c253ba8830f Mon Sep 17 00:00:00 2001 From: Brook Heisler Date: Thu, 14 Jul 2022 16:50:13 -0600 Subject: [PATCH 5/8] Bump criterion-plot dependency versions. --- plot/Cargo.toml | 6 +++--- plot/src/lib.rs | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/plot/Cargo.toml b/plot/Cargo.toml index 76e0064d..e04eb0e9 100644 --- a/plot/Cargo.toml +++ b/plot/Cargo.toml @@ -12,13 +12,13 @@ categories = ["visualization"] license = "MIT/Apache-2.0" [dependencies] -cast = "0.2" +cast = "0.3" itertools = "0.10" [dev-dependencies] itertools-num = "0.1" -num-complex = { version = "0.2", default-features = false, features = ["std"] } -rand = "0.4" +num-complex = { version = "0.4", default-features = false, features = ["std"] } +rand = "0.8" [badges] travis-ci = { repository = "bheisler/criterion.rs" } diff --git a/plot/src/lib.rs b/plot/src/lib.rs index 864c4531..be511058 100644 --- a/plot/src/lib.rs +++ b/plot/src/lib.rs @@ -79,7 +79,7 @@ //! use std::f64::consts::PI; //! //! use itertools_num::linspace; -//! use rand::{Rng, XorShiftRng}; +//! use rand::Rng; //! use criterion_plot::prelude::*; //! //! fn sinc(mut x: f64) -> f64 { @@ -97,7 +97,7 @@ //! let ref xs_ = linspace::(-4., 4., 101).collect::>(); //! //! // Fake some data -//! let ref mut rng: XorShiftRng = rand::thread_rng().gen(); +//! let ref mut rng = rand::thread_rng(); //! let xs = linspace::(-4., 4., 13).skip(1).take(11); //! let ys = xs.map(|x| sinc(x) + 0.05 * rng.gen::() - 0.025).collect::>(); //! let y_low = ys.iter().map(|&y| y - 0.025 - 0.075 * rng.gen::()).collect::>(); From ce8259e69fb44e2331e70af621e3719dbc84e601 Mon Sep 17 00:00:00 2001 From: Brook Heisler Date: Thu, 14 Jul 2022 16:54:45 -0600 Subject: [PATCH 6/8] Bump criterion-plot version number. --- Cargo.toml | 2 +- plot/Cargo.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index fd0739dd..ab0da2c4 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -18,7 +18,7 @@ exclude = ["book/*"] [dependencies] lazy_static = "1.4" -criterion-plot = { path = "plot", version = "0.4.4" } +criterion-plot = { path = "plot", version = "0.4.5" } itertools = "0.10" serde = "1.0" serde_json = "1.0" diff --git a/plot/Cargo.toml b/plot/Cargo.toml index e04eb0e9..d7e78e0a 100644 --- a/plot/Cargo.toml +++ b/plot/Cargo.toml @@ -1,7 +1,7 @@ [package] authors = ["Jorge Aparicio ", "Brook Heisler "] name = "criterion-plot" -version = "0.4.4" +version = "0.4.5" edition = "2018" description = "Criterion's plotting library" From dfd7b6532b0aa76e1aee80ae061e7e1b7a12c561 Mon Sep 17 00:00:00 2001 From: Brook Heisler Date: Thu, 14 Jul 2022 18:01:27 -0600 Subject: [PATCH 7/8] Add duplicated benchmark ID to assertion message. --- src/benchmark_group.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/benchmark_group.rs b/src/benchmark_group.rs index 9ed88ef1..9cf3f9ae 100644 --- a/src/benchmark_group.rs +++ b/src/benchmark_group.rs @@ -290,7 +290,8 @@ impl<'a, M: Measurement> BenchmarkGroup<'a, M> { assert!( !self.all_ids.contains(&id), - "Benchmark IDs must be unique within a group." + "Benchmark IDs must be unique within a group. Encountered duplicated benchmark ID {}", + &id ); id.ensure_directory_name_unique(&self.criterion.all_directories); From 8d0224e9f1704deae2b4206fff2b8b6bf8f7c9c0 Mon Sep 17 00:00:00 2001 From: Cryptex <64497526+Cryptex-github@users.noreply.github.com> Date: Mon, 15 Aug 2022 17:31:53 -0700 Subject: [PATCH 8/8] Fix html report path --- book/src/user_guide/html_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/src/user_guide/html_report.md b/book/src/user_guide/html_report.md index 095e0250..052a60a8 100644 --- a/book/src/user_guide/html_report.md +++ b/book/src/user_guide/html_report.md @@ -1,7 +1,7 @@ # HTML Report Criterion.rs can generate an HTML report displaying the results of the benchmark under -`target/criterion/report/index.html`. By default, the plots are generated using +`target/criterion/reports/index.html`. By default, the plots are generated using [gnuplot](http://www.gnuplot.info/) if it is available, or the [plotters](https://github.com/38/plotters) crate if it is not. The example below was generated using the gnuplot backend, but the charts generated by plotters are similar.