diff --git a/README.md b/README.md index d51eaab7f0..e92c4fa013 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ It's no harder than writing unit tests! Under the hood, it performs a lot of [magic](#Automation) that guarantees [reliable and precise](#Reliability) results thanks to the [perfolizer](https://github.com/AndreyAkinshin/perfolizer) statistical engine. BenchmarkDotNet protects you from popular benchmarking mistakes and warns you if something is wrong with your benchmark design or obtained measurements. The results are presented in a [user-friendly](#Friendliness) form that highlights all the important facts about your experiment. -The library is adopted by [13400+ projects](#who-uses-benchmarkdotnet) including .NET Runtime and supported by the [.NET Foundation](https://dotnetfoundation.org). +The library is adopted by [13800+ projects](#who-uses-benchmarkdotnet) including .NET Runtime and supported by the [.NET Foundation](https://dotnetfoundation.org). It's [easy](#Simplicity) to start writing benchmarks, check out an example (copy-pastable version is [here](https://benchmarkdotnet.org/articles/guides/getting-started.html)): @@ -231,7 +231,7 @@ If you don't customize the summary view, ## Who uses BenchmarkDotNet? Everyone! -BenchmarkDotNet is already adopted by more than [13400+](https://github.com/dotnet/BenchmarkDotNet/network/dependents?package_id=UGFja2FnZS0xNTY3MzExMzE%3D) projects including +BenchmarkDotNet is already adopted by more than [13800+](https://github.com/dotnet/BenchmarkDotNet/network/dependents?package_id=UGFja2FnZS0xNTY3MzExMzE%3D) projects including [dotnet/performance](https://github.com/dotnet/performance) (reference benchmarks for all .NET Runtimes), [dotnet/runtime](https://github.com/dotnet/runtime/issues?utf8=%E2%9C%93&q=BenchmarkDotNet) (.NET runtime and libraries), [Roslyn](https://github.com/dotnet/roslyn/search?q=BenchmarkDotNet&type=Issues&utf8=✓) (C# and Visual Basic compiler), @@ -266,9 +266,9 @@ BenchmarkDotNet is already adopted by more than [13400+](https://github.com/dotn [TensorFlow.NET](https://github.com/SciSharp/TensorFlow.NET/tree/master/src/TensorFlowNet.Benchmarks), [Apache Thrift](https://github.com/apache/thrift/tree/master/lib/netstd/Benchmarks/Thrift.Benchmarks). On GitHub, you can find - 10700+ [issues](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=created&type=Issues&utf8=✓), - 4700+ [commits](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=committer-date&type=Commits&utf8=✓), and - 1,500,000+ [files](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=indexed&type=Code&utf8=✓) + 11400+ [issues](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=created&type=Issues&utf8=✓), + 4900+ [commits](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=committer-date&type=Commits&utf8=✓), and + 1,550,000+ [files](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=indexed&type=Code&utf8=✓) that involve BenchmarkDotNet. ## Learn more about benchmarking diff --git a/docs/_changelog/details/v0.13.4.md b/docs/_changelog/details/v0.13.4.md new file mode 100644 index 0000000000..b26a46c0cd --- /dev/null +++ b/docs/_changelog/details/v0.13.4.md @@ -0,0 +1,37 @@ +## Milestone details + +In the [v0.13.4](https://github.com/dotnet/BenchmarkDotNet/issues?q=milestone:v0.13.4) scope, +1 issues were resolved and 4 pull requests were merged. +This release includes 7 commits by 5 contributors. + +## Resolved issues (1) + +* [#2237](https://github.com/dotnet/BenchmarkDotNet/issues/2237) Version 0.13.3 breaks LINQPad (and any non-Console application) + +## Merged pull requests (4) + +* [#2206](https://github.com/dotnet/BenchmarkDotNet/pull/2206) Add single quote when use pattern with filters (by [@erlangxk](https://github.com/erlangxk)) +* [#2218](https://github.com/dotnet/BenchmarkDotNet/pull/2218) Improve getting started guide (by [@reflectronic](https://github.com/reflectronic)) +* [#2238](https://github.com/dotnet/BenchmarkDotNet/pull/2238) Fix IOException when Console window unavailable (#2237) (by [@albahari](https://github.com/albahari)) +* [#2243](https://github.com/dotnet/BenchmarkDotNet/pull/2243) JitStatsDiagnoser (by [@adamsitnik](https://github.com/adamsitnik)) + +## Commits (7) + +* [dc7734](https://github.com/dotnet/BenchmarkDotNet/commit/dc7734d3eba06880428c0e16d287c9ca837a9d40) Postrelease v0.13.3 update (by [@AndreyAkinshin](https://github.com/AndreyAkinshin)) +* [e04e2d](https://github.com/dotnet/BenchmarkDotNet/commit/e04e2d7d0cc4fefb954f8a8bd90b8f82100802f9) Fix IOException when Console window unavailable (#2237) (#2238) (by [@albahari](https://github.com/albahari)) +* [7694d0](https://github.com/dotnet/BenchmarkDotNet/commit/7694d0e79b7446373f893ff532b801a519f1b700) Update copyright year (by [@AndreyAkinshin](https://github.com/AndreyAkinshin)) +* [5e8a31](https://github.com/dotnet/BenchmarkDotNet/commit/5e8a318d2243701d0141d74a6c89307149486156) Revert comments in DocFxChangelogDownloadTask (by [@AndreyAkinshin](https://github.com/AndreyAkinshin)) +* [ea0eb2](https://github.com/dotnet/BenchmarkDotNet/commit/ea0eb2fe403cab9c1daa0e5aa6e42ab038100418) Add single quote when use pattern with filters (#2206) (by [@erlangxk](https://github.com/erlangxk)) +* [0cf185](https://github.com/dotnet/BenchmarkDotNet/commit/0cf185020583a5c5c987d064d09426edc4399a5b) Improve getting started guide (#2218) (by [@reflectronic](https://github.com/reflectronic)) +* [12bf22](https://github.com/dotnet/BenchmarkDotNet/commit/12bf220e11fddc8e65b066eb1f300b63bfde7e9b) JitStatsDiagnoser (#2243) (by [@adamsitnik](https://github.com/adamsitnik)) + +## Contributors (5) + +* Adam Sitnik ([@adamsitnik](https://github.com/adamsitnik)) +* albahari ([@albahari](https://github.com/albahari)) +* Andrey Akinshin ([@AndreyAkinshin](https://github.com/AndreyAkinshin)) +* erlangxk ([@erlangxk](https://github.com/erlangxk)) +* John Tur ([@reflectronic](https://github.com/reflectronic)) + +Thank you very much! + diff --git a/docs/_changelog/footer/v0.13.4.md b/docs/_changelog/footer/v0.13.4.md new file mode 100644 index 0000000000..c98547637c --- /dev/null +++ b/docs/_changelog/footer/v0.13.4.md @@ -0,0 +1,10 @@ +_Date: TBA_ + +_Milestone: [v0.13.4](https://github.com/dotnet/BenchmarkDotNet/issues?q=milestone%3Av0.13.4)_ +([List of commits](https://github.com/dotnet/BenchmarkDotNet/compare/v0.13.3...v0.13.4)) + +_NuGet Packages:_ +* https://www.nuget.org/packages/BenchmarkDotNet/0.13.4 +* https://www.nuget.org/packages/BenchmarkDotNet.Diagnostics.Windows/0.13.4 +* https://www.nuget.org/packages/BenchmarkDotNet.Annotations/0.13.4 +* https://www.nuget.org/packages/BenchmarkDotNet.Templates/0.13.4 \ No newline at end of file diff --git a/docs/_changelog/full.md b/docs/_changelog/full.md index d4d82c9b62..06f7b67eeb 100644 --- a/docs/_changelog/full.md +++ b/docs/_changelog/full.md @@ -4,6 +4,7 @@ uid: changelog.full # Full ChangeLog +[!include[v0.13.4](v0.13.4.md)] [!include[v0.13.3](v0.13.3.md)] [!include[v0.13.2](v0.13.2.md)] [!include[v0.13.1](v0.13.1.md)] diff --git a/docs/_changelog/header/v0.13.4.md b/docs/_changelog/header/v0.13.4.md new file mode 100644 index 0000000000..3ae8407ee4 --- /dev/null +++ b/docs/_changelog/header/v0.13.4.md @@ -0,0 +1,26 @@ +## Highlights + +* Fixed LINQPad support + [#2237](https://github.com/dotnet/BenchmarkDotNet/issues/2237) + [#2238](https://github.com/dotnet/BenchmarkDotNet/pull/2238) +* New `JitStatsDiagnoser` + [#2243](https://github.com/dotnet/BenchmarkDotNet/pull/2243) +* Minor documentation improvements + [#2206](https://github.com/dotnet/BenchmarkDotNet/pull/2206) + [#2218](https://github.com/dotnet/BenchmarkDotNet/pull/2218) + +## JitStatsDiagnoser + +This new diagnoser introduced in ([#2243](https://github.com/dotnet/BenchmarkDotNet/pull/2243)) allows getting advanced JIT statistics. + +Sample usage: + +```cmd +dotnet run -c Release -f net7.0 --filter *IntroBasic.Sleep --profiler jit +``` + +Result: + +| Method | Mean | Error | StdDev | Methods JITted | Methods Tiered | JIT allocated memory | +|------- |---------:|---------:|---------:|---------------:|---------------:|---------------------:| +| Sleep | 15.53 ms | 0.034 ms | 0.032 ms | 1,102 | 15 | 221,736 B | \ No newline at end of file diff --git a/docs/_changelog/index.md b/docs/_changelog/index.md index e52aaae667..9495dc9da6 100644 --- a/docs/_changelog/index.md +++ b/docs/_changelog/index.md @@ -4,6 +4,7 @@ uid: changelog # ChangeLog +* @changelog.v0.13.4 * @changelog.v0.13.3 * @changelog.v0.13.2 * @changelog.v0.13.1 diff --git a/docs/changelog/toc.yml b/docs/changelog/toc.yml index 63fee7283a..58da12e376 100644 --- a/docs/changelog/toc.yml +++ b/docs/changelog/toc.yml @@ -1,3 +1,5 @@ +- name: v0.13.4 + href: v0.13.4.md - name: v0.13.3 href: v0.13.3.md - name: v0.13.2 diff --git a/docs/index.md b/docs/index.md index 5ec76f0c41..b4c77ae984 100644 --- a/docs/index.md +++ b/docs/index.md @@ -33,7 +33,7 @@ It's no harder than writing unit tests! Under the hood, it performs a lot of [magic](#Automation) that guarantees [reliable and precise](#Reliability) results thanks to the [perfolizer](https://github.com/AndreyAkinshin/perfolizer) statistical engine. BenchmarkDotNet protects you from popular benchmarking mistakes and warns you if something is wrong with your benchmark design or obtained measurements. The results are presented in a [user-friendly](#Friendliness) form that highlights all the important facts about your experiment. -The library is adopted by [13400+ projects](#who-uses-benchmarkdotnet) including .NET Runtime and supported by the [.NET Foundation](https://dotnetfoundation.org). +The library is adopted by [13800+ projects](#who-uses-benchmarkdotnet) including .NET Runtime and supported by the [.NET Foundation](https://dotnetfoundation.org). It's [easy](#Simplicity) to start writing benchmarks, check out an example (copy-pastable version is [here](https://benchmarkdotnet.org/articles/guides/getting-started.html)): @@ -235,7 +235,7 @@ If you don't customize the summary view, ## Who uses BenchmarkDotNet? Everyone! -BenchmarkDotNet is already adopted by more than [13400+](https://github.com/dotnet/BenchmarkDotNet/network/dependents?package_id=UGFja2FnZS0xNTY3MzExMzE%3D) projects including +BenchmarkDotNet is already adopted by more than [13800+](https://github.com/dotnet/BenchmarkDotNet/network/dependents?package_id=UGFja2FnZS0xNTY3MzExMzE%3D) projects including [dotnet/performance](https://github.com/dotnet/performance) (reference benchmarks for all .NET Runtimes), [dotnet/runtime](https://github.com/dotnet/runtime/issues?utf8=%E2%9C%93&q=BenchmarkDotNet) (.NET runtime and libraries), [Roslyn](https://github.com/dotnet/roslyn/search?q=BenchmarkDotNet&type=Issues&utf8=✓) (C# and Visual Basic compiler), @@ -270,9 +270,9 @@ BenchmarkDotNet is already adopted by more than [13400+](https://github.com/dotn [TensorFlow.NET](https://github.com/SciSharp/TensorFlow.NET/tree/master/src/TensorFlowNet.Benchmarks), [Apache Thrift](https://github.com/apache/thrift/tree/master/lib/netstd/Benchmarks/Thrift.Benchmarks). On GitHub, you can find - 10700+ [issues](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=created&type=Issues&utf8=✓), - 4700+ [commits](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=committer-date&type=Commits&utf8=✓), and - 1,500,000+ [files](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=indexed&type=Code&utf8=✓) + 11400+ [issues](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=created&type=Issues&utf8=✓), + 4900+ [commits](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=committer-date&type=Commits&utf8=✓), and + 1,550,000+ [files](https://github.com/search?o=desc&q=BenchmarkDotNet+-repo:dotnet%2FBenchmarkDotNet&s=indexed&type=Code&utf8=✓) that involve BenchmarkDotNet. ## Learn more about benchmarking