Skip to content

Commit 7f9c058

Browse files
docs: fix formatting
1 parent 594b8fc commit 7f9c058

File tree

1 file changed

+11
-23
lines changed

1 file changed

+11
-23
lines changed

content/install-guides/windows-perf-wpa-plugin.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,12 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
3333
It leverages the ARM64 PMU (Performance Monitor Unit) and its hardware counters to offer precise profiling capabilities.
3434
The **WindowsPerf WPA plugin** bridges the gap between the detailed output of **WindowsPerf** and the powerful capabilities of **Windows Performance Analyzer**.
3535

36-
The plugin is built on the [`microsoft-performance-toolkit-sdk`](https://github.com/microsoft/microsoft-performance-toolkit-sdk)
37-
and is shipped as a single `.dll` file.
36+
The plugin is built on the [`microsoft-performance-toolkit-sdk`](https://github.com/microsoft/microsoft-performance-toolkit-sdk) and is shipped as a single `.dll` file.
3837

3938

40-
**Windows Performance Analyzer (WPA)** is a tool that creates graphs and data tables of Event Tracing for Windows (ETW) events
41-
that are recorded by Windows Performance Recorder (WPR), Xperf, or an assessment that is run in the
42-
Assessment Platform. WPA can open any event trace log (ETL) file for analysis.
39+
**Windows Performance Analyzer (WPA)** is a tool that creates graphs and data tables of Event Tracing for Windows (ETW) events that are recorded by Windows Performance Recorder (WPR), Xperf, or an assessment that is run in the Assessment Platform. WPA can open any event trace log (ETL) file for analysis.
4340

44-
WPA's capabilities can be expanded upon using the `microsoft-performance-toolkit-sdk` by creating
45-
plugins which enables parsing any type of data (`.json` in this case).
41+
WPA's capabilities can be expanded upon using the `microsoft-performance-toolkit-sdk` by creating plugins which enables parsing any type of data (`.json` in this case).
4642

4743

4844
## A Glimpse of the available features
@@ -58,48 +54,40 @@ The WindowsPerf GUI extension is composed of several key features, each designed
5854
## Getting Started
5955
### Installation
6056

61-
WPA is included in the Windows Assessment and Deployment Kit (Windows ADK)
62-
that can be downloaded [here](https://go.microsoft.com/fwlink/?linkid=2243390).
57+
WPA is included in the Windows Assessment and Deployment Kit (Windows ADK) that can be downloaded [here](https://go.microsoft.com/fwlink/?linkid=2243390).
6358

6459
> The wperf WPA plugin requires a WPA version of `11.0.7.2` or higher.
6560
66-
Once downloaded, make sure that "Windows Performance Toolkit" checkbox is
67-
checked under "Select the features you want to install/change".
61+
Once downloaded, make sure that "Windows Performance Toolkit" checkbox is checked under "Select the features you want to install/change".
6862

6963
![WPA Installation](_images/wpa-installation.png)
7064

7165
The plugin can be downloaded from the [releases page](https://github.com/arm-developer-tools/windowsperf-wpa-plugin/releases).
7266

7367
To install the plugin you have the option between:
7468

75-
- Moving the plugin dll to the **CustomDataSources** directory next
76-
to the WPA executable (defaults to `C:\\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit\CustomDataSources`).
69+
- Moving the plugin dll to the **CustomDataSources** directory next to the WPA executable (defaults to `C:\\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit\CustomDataSources`).
7770
- Setting up the `WPA_ADDITIONAL_SEARCH_DIRECTORIES` env variable and moving the dll to that directory
78-
- Calling `wpa` from the command line and passing the plugin directory
79-
to the `-addsearchdir` flag (example : `wpa -addsearchdir "%USERPROFILE%\plugins"`).
71+
- Calling `wpa` from the command line and passing the plugin directory to the `-addsearchdir` flag (example : `wpa -addsearchdir "%USERPROFILE%\plugins"`).
8072

8173
<img
8274
src="_images/about-wpa.png"
8375
alt="About WPA"
8476
style="display: block; margin: 0 auto"
8577
/>
8678

87-
> To verify that the plugin is loaded successfully, launch WPA then the plugin
88-
should appear under Help > About Windows Performance Analyzer.
79+
> To verify that the plugin is loaded successfully, launch WPA then the plugin should appear under Help > About Windows Performance Analyzer.
8980
9081

9182
### Running from the command line
9283

9384
After installing WPA, it should be added automatically to the path environnment variable.
94-
If it's not the case, add the WPA directory (defaults to `C:\\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit`)
95-
to your environnment variable.
85+
If it's not the case, add the WPA directory (defaults to `C:\\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit`) to your environnment variable.
9686

9787

98-
To open a json file directly from the command line, you can use the `-i` flag to specify the
99-
file path to open.
88+
To open a json file directly from the command line, you can use the `-i` flag to specify the file path to open.
10089

101-
Example: to open a `timeline_long.json` that sits in the Downloads directory, run the following
102-
command in the command line:
90+
Example: to open a `timeline_long.json` that sits in the Downloads directory, run the following command in the command line:
10391

10492
`wpa -i \"%USERPROFILE%\\Downloads\\timeline_long.json\"`
10593

0 commit comments

Comments
 (0)