T0b1/wasmtime
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: improve VTune documentation (#3907)

Browse Source 
This change removes the Linux-specific wording of the VTune
documentation as well as fixing a link.
This commit is contained in:
Andrew Brown
2022-03-09 13:51:20 -08:00
committed by GitHub
parent 4d404c90b4
commit 6b4e84f2e3
1 changed files with 3 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/examples-profiling-vtune.md
View File

@@ -1,4 +1,4 @@
# Using `VTune` on Linux
# Using `VTune`
[VTune][help] is a popular performance profiling tool that targets both 32-bit
and 64-bit x86 architectures. The tool collects profiling data during runtime
@@ -6,9 +6,7 @@ and then, either through the command line or GUI, provides a variety of options
for viewing and analyzing that data. VTune Profiler is available in both
commerical and free options. The free, downloadable version is available
[here][download] and is backed by a community forum for support. This version is
appropriate for detailed analysis of your Wasm program. Note that for JIT
support, Wasmtime only supports VTune profiling on Linux platforms but other
platforms are expected to be enabled in the future.
appropriate for detailed analysis of your Wasm program.
VTune support in Wasmtime is provided through the JIT profiling APIs from the
[`ittapi`] library. This library provides code generators (or the runtimes that
@@ -24,7 +22,7 @@ For more information on VTune and the analysis tools it provides see its
[help]: https://software.intel.com/en-us/vtune-help
[download]: https://software.intel.com/en-us/vtune/choose-download#standalone
[documentations]: https://software.intel.com/en-us/vtune-help
[documentation]: https://software.intel.com/en-us/vtune-help
[`ittapi`]: https://github.com/intel/ittapi
[`ittapi-rs`]: https://crates.io/crates/ittapi-rs