From c249e4cbef69778173a5aaf0368936c80b2288ae Mon Sep 17 00:00:00 2001 From: filzrev <103790468+filzrev@users.noreply.github.com> Date: Fri, 10 Oct 2025 20:28:45 +0900 Subject: [PATCH 1/4] docs: add docs for breaking changes of disassembler native dependencies --- docs/articles/features/disassembler.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/articles/features/disassembler.md b/docs/articles/features/disassembler.md index c33527d0d7..85374ce2a4 100644 --- a/docs/articles/features/disassembler.md +++ b/docs/articles/features/disassembler.md @@ -17,6 +17,18 @@ The configuration options available from code level are: * `exportCombinedDisassemblyReport`: Exports all benchmarks to a single HTML report. Makes it easy to compare different runtimes or methods (each becomes a column in HTML table). * `exportDiff`: Exports a diff of the assembly code to the Github markdown format. False by default. +The configuration options available for MSBuild properties: + +* `BenchmarkDotNetTargetPlatform`: Specify `all` to include all native dependencies of disassembler. + +> [!NOTE] +> By default, BenchmarkDotNet excludes disassembler's native dependencies that aren't used on current target platform. +> Use the following settings when running the benchmark binary on multiple platforms. +> +> ```xml +> all +> ``` + ### Requirements Disassembly Diagnoser requires following settings in your `.csproj` file: From f819ff3a900362945ff50c5ba1f32214d91edf7e Mon Sep 17 00:00:00 2001 From: filzrev <103790468+filzrev@users.noreply.github.com> Date: Fri, 31 Oct 2025 14:09:34 +0900 Subject: [PATCH 2/4] Update docs/articles/features/disassembler.md Co-authored-by: Tim Cassell --- docs/articles/features/disassembler.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/articles/features/disassembler.md b/docs/articles/features/disassembler.md index 85374ce2a4..585f6bcacb 100644 --- a/docs/articles/features/disassembler.md +++ b/docs/articles/features/disassembler.md @@ -23,7 +23,7 @@ The configuration options available for MSBuild properties: > [!NOTE] > By default, BenchmarkDotNet excludes disassembler's native dependencies that aren't used on current target platform. -> Use the following settings when running the benchmark binary on multiple platforms. +> Use the following settings when running the benchmark binary on a different platform than it was built on, or multiple platforms. > > ```xml > all From aa0a5397887d6781867719458152f7a12c8ad6d7 Mon Sep 17 00:00:00 2001 From: filzrev <103790468+filzrev@users.noreply.github.com> Date: Fri, 31 Oct 2025 14:14:15 +0900 Subject: [PATCH 3/4] docs: move note section content --- docs/articles/features/disassembler.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/docs/articles/features/disassembler.md b/docs/articles/features/disassembler.md index 585f6bcacb..34f7b89cc5 100644 --- a/docs/articles/features/disassembler.md +++ b/docs/articles/features/disassembler.md @@ -17,18 +17,6 @@ The configuration options available from code level are: * `exportCombinedDisassemblyReport`: Exports all benchmarks to a single HTML report. Makes it easy to compare different runtimes or methods (each becomes a column in HTML table). * `exportDiff`: Exports a diff of the assembly code to the Github markdown format. False by default. -The configuration options available for MSBuild properties: - -* `BenchmarkDotNetTargetPlatform`: Specify `all` to include all native dependencies of disassembler. - -> [!NOTE] -> By default, BenchmarkDotNet excludes disassembler's native dependencies that aren't used on current target platform. -> Use the following settings when running the benchmark binary on a different platform than it was built on, or multiple platforms. -> -> ```xml -> all -> ``` - ### Requirements Disassembly Diagnoser requires following settings in your `.csproj` file: @@ -45,6 +33,14 @@ To get the source code we need to locate and read the `.pdb` files. This is why we need `DebugType` and `DebugSymbols` settings. To compare different platforms the project which defines benchmarks has to target `AnyCPU`. +> [!NOTE] +> By default, BenchmarkDotNet excludes disassembler's native dependencies that aren't used on current target platform. +> Use the following settings when running the benchmark binary on a different platform than it was built on, or multiple platforms. +> +> ```xml +> all +> ``` + ### Disassembly Diagnoser for Mono on Windows If you want to get a disassembly listing for Mono on Windows, you need `as` and `x86_64-w64-mingw32-objdump.exe` tools. From 8a91664e27a9759e430e977c356e8f144b429d68 Mon Sep 17 00:00:00 2001 From: Tim Cassell Date: Fri, 31 Oct 2025 07:57:57 -0400 Subject: [PATCH 4/4] Update docs/articles/features/disassembler.md --- docs/articles/features/disassembler.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/articles/features/disassembler.md b/docs/articles/features/disassembler.md index 34f7b89cc5..811abd5ffa 100644 --- a/docs/articles/features/disassembler.md +++ b/docs/articles/features/disassembler.md @@ -41,6 +41,8 @@ To compare different platforms the project which defines benchmarks has to targe > all > ``` +Or specify `` for the platform that it will be run on. + ### Disassembly Diagnoser for Mono on Windows If you want to get a disassembly listing for Mono on Windows, you need `as` and `x86_64-w64-mingw32-objdump.exe` tools.