Skip to content

docs: Add docs for breaking changes of disassembler native dependencies #2836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Add docs for breaking changes of disassembler native dependencies #2836

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/articles/features/disassembler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

@timcassell timcassell Oct 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> 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
> <BenchmarkDotNetTargetPlatform>all</BenchmarkDotNetTargetPlatform>
Copy link
Collaborator

@timcassell timcassell Oct 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it support specifying an exact platform? If not, it would be a good future improvement.

[Edit] Just checked, looks like it does, either by RuntimeIdentifier or BenchmarkDotNetTargetPlatform. It would be good to document it.

> ```

### Requirements

Disassembly Diagnoser requires following settings in your `.csproj` file:
Expand Down
Loading