Skip to content

Commit e42c2f7

Browse files
Merge pull request #1329 from jasonrandrews/review
Review wperf install guide
2 parents 694675a + 6dc3355 commit e42c2f7

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

content/install-guides/wperf.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
### Title the install tools article with the name of the tool to be installed
33
### Include vendor name where appropriate
4-
title: Perf for Windows on Arm (WindowsPerf)
4+
title: WindowsPerf (wperf)
55

66
### Optional additional search terms (one per line) to assist in finding the article
77
additional_search_terms:
@@ -30,7 +30,7 @@ multitool_install_part: false # Set to true if a sub-page of a multi-page arti
3030
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
3131
---
3232

33-
WindowsPerf is (Linux perf inspired) Windows on Arm performance profiling tool. Profiling is based on ARM64 PMU and its hardware counters. WindowsPerf supports the counting model for obtaining aggregate counts of occurrences of special events, and sampling model for determining the frequencies of event occurrences produced by program locations at the function, basic block, and/or instruction levels. WindowsPerf is an open-source project hosted on [GitHub](https://github.com/arm-developer-tools/windowsperf).
33+
WindowsPerf is a Linux Perf inspired Windows on Arm performance profiling tool. Profiling is based on ARM64 PMU and its hardware counters. WindowsPerf supports the counting model for obtaining aggregate counts of occurrences of special events, and sampling model for determining the frequencies of event occurrences produced by program locations at the function, basic block, and/or instruction levels. WindowsPerf is an open-source project hosted on [GitHub](https://github.com/arm-developer-tools/windowsperf).
3434

3535
WindowsPerf consists of a kernel-mode driver and a user-space command-line tool. The WindowsPerf command line tool can be seamlessly integrated with both the [WindowsPerf Visual Studio Extension](#vs2022) and the [WindowsPerf VS Code Extension](#vscode). These extensions, which can be downloaded from the Visual Studio Marketplace, enhance the functionality of WindowsPerf by providing a more user-friendly interface and additional features for performance analysis and debugging. This integration allows developers to efficiently analyze and optimize their applications directly within their preferred development environment.
3636

@@ -70,7 +70,7 @@ tar -xmf windowsperf-bin-3.8.0.zip
7070

7171
## Install wperf driver
7272

73-
You can install the kernel driver using supplied [wperf-devgen](#devgen_install) installer.
73+
You can install the kernel driver using supplied `wperf-devgen` installer.
7474

7575
The [wperf-devgen](https://github.com/arm-developer-tools/windowsperf/blob/main/wperf-devgen/README.md) tool has been designated as the preferred installer and uninstaller for the WindowsPerf Kernel Driver in the latest release. This tool offers a simple process for managing the installation and removal of the driver.
7676

@@ -80,27 +80,29 @@ You must install the driver as `Administrator`.
8080

8181
Open a `Windows Command Prompt` terminal with `Run as administrator` enabled.
8282

83-
Navigate to the `windowsperf-bin-<version>` directory.
83+
Make sure you are in the `windowsperf-bin-<version>` directory.
84+
8485
```command
8586
cd windowsperf-bin-3.8.0
8687
```
8788

8889
### Install with wperf-devgen {#devgen_install}
8990

9091
Navigate to the `wperf-driver` folder and run the installer:
92+
9193
```command
9294
cd wperf-driver
9395
wperf-devgen install
9496
```
95-
You will see output similar to:
96-
```output
97+
98+
The output is similar to:
99+
100+
```output
97101
Executing command: install.
98102
Install requested.
99-
Waiting for device creation...
100-
Device installed successfully.
101-
Trying to install driver...
102-
Success installing driver.
103+
Device installed successfully
103104
```
105+
104106
## Verify install
105107

106108
You can check everything is working by running the `wperf` executable.
@@ -110,19 +112,21 @@ Once the above driver is installed, you can use `wperf` without `Administrator`
110112
{{% /notice %}}
111113

112114
For example:
115+
113116
```command
114-
cd ..
117+
cd ..\wperf
115118
wperf --version
116119
```
117-
You should see output similar to:
120+
121+
You see output similar to:
122+
118123
```output
119124
Component Version GitVer FeatureString
120125
========= ======= ====== =============
121126
wperf 3.8.0 6d15ddfc +etw-app
122127
wperf-driver 3.8.0 6d15ddfc +etw-drv
123128
124129
```
125-
126130
## Uninstall wperf driver
127131

128132
You can uninstall (aka "remove") the kernel driver using supplied [wperf-devgen](#devgen_uninstall) uninstaller.
@@ -134,16 +138,18 @@ You must uninstall the driver as `Administrator`.
134138
### Uninstall with wperf-devgen {#devgen_uninstall}
135139

136140
```command
141+
cd windowsperf-bin-3.8.0\wperf-driver
137142
wperf-devgen uninstall
138143
```
139-
You should see output similar to:
144+
145+
The output is similar to:
146+
140147
```console
141148
Executing command: uninstall.
142149
Uninstall requested.
143-
Waiting for device creation...
144-
Device uninstalled successfully.
145-
Trying to remove driver <path>\wperf-driver.inf.
146-
Driver removed successfully.
150+
Root\WPERFDRIVER
151+
Device found
152+
Device uninstalled sucessfully
147153
```
148154

149155
## Install WindowsPerf Virtual Studio Extension (optional) {#vs2022}

0 commit comments

Comments
 (0)