Skip to content

Commit 8541b93

Browse files
authored
Merge pull request #1348 from NickSample/wperf-vs-extension
WPerf_VS_extension_IG_KB to review
2 parents 7fa71a5 + 7e31708 commit 8541b93

File tree

1 file changed

+22
-28
lines changed

1 file changed

+22
-28
lines changed

content/install-guides/windows-perf-vs-extension.md

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -28,38 +28,33 @@ multi_install: FALSE # Set to true if first page of multi-page article, else fal
2828
multitool_install_part: false # Set to true if a sub-page of a multi-page article, else false
2929
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
3030
---
31+
[WindowsPerf](/install-guides/wperf/) is a lightweight performance profiling tool inspired by Linux Perf, and specifically tailored for Windows on Arm. It leverages the AArch64 Performance Monitoring Unit (PMU) and its hardware counters to offer precise profiling capabilities.
3132

32-
## Introduction
33+
Recognizing the complexities of command-line interaction, the WindowsPerf GUI is a Visual Studio 2022 extension created to provide a more intuitive, integrated experience within the Integrated Development Environment (IDE). This tool enables developers to interact with WindowsPerf, adjust settings, and visualize performance data seamlessly in Visual Studio.
3334

34-
WindowsPerf is a lightweight performance profiling tool inspired by Linux Perf, and specifically tailored for Windows on Arm. It leverages the ARM64 PMU (Performance Monitor Unit) and its hardware counters to offer precise profiling capabilities.
35-
36-
Recognizing the complexities of command-line interaction, the WindowsPerf GUI is a Visual Studio 2022 extension created to provide a more intuitive, integrated experience within the integrated development environment (IDE). This tool enables developers to interact with WindowsPerf, adjust settings, and visualize performance data seamlessly in Visual Studio.
37-
38-
## A Glimpse of the available features
35+
## Overview of key features
3936

4037
The WindowsPerf GUI extension is composed of several key features, each designed to streamline the user experience:
4138

42-
- **WindowsPerf Configuration**: Connect directly to `wperf.exe` for a seamless integration. Configuration is accessible via `Tools -> Options -> Windows Perf -> WindowsPerf Path`.
43-
- **Host Data**: Understand your environment with `Tools -> WindowsPerf Host Data`, offering insights into tests run by WindowsPerf.
44-
- **Output Logging**: All commands executed through the GUI are logged, ensuring transparency and aiding in performance analysis.
45-
- **Sampling UI**: Customize your sampling experience by selecting events, setting frequency and duration, choosing programs for sampling, and comprehensively analyzing results.
39+
- **WindowsPerf Configuration**: Connect directly to `wperf.exe` for a seamless integration. Configuration is accessible by selecting **Tools > Options > Windows Perf > WindowsPerf Path**.
40+
- **Host Data**: Understand your environment by selecting **Tools** then **WindowsPerf Host Data**. This offers insights into tests run by WindowsPerf.
41+
- **Output Logging**: All commands executed through the GUI are logged, ensuring transparency and supporting performance analysis.
42+
- **Sampling UI**: Customize your sampling experience by selecting events, setting frequency and duration, choosing programs for sampling, and comprehensively analyzing results. See screenshot below.
4643

4744
![Sampling preview #center](../_images/wperf-vs-extension-sampling-preview.png "Sampling settings UI Overview")
4845

4946

50-
- **Counting Settings UI**: Build a `wperf stat` command from scratch using the configuration interface, then view the output in the IDE or open it with Windows Performance Analyzer (WPA)
51-
52-
53-
![Counting preview #center](../_images/wperf-vs-extension-counting-preview.png "_Counting settings UI Overview_")
47+
- **Counting Settings UI**: Build a `wperf stat` command from scratch using the configuration interface, then view the output in the IDE or open it with Windows Performance Analyzer (WPA). See screenshot below.
5448

5549

56-
## Getting Started
50+
![Counting preview #center](../_images/wperf-vs-extension-counting-preview.png "Counting settings UI Overview")
5751

58-
### Prerequisites
52+
## Before you begin
5953

60-
- **Visual Studio 2022**: Ensure you have Visual Studio 2022 installed on your Windows on Arm device.
61-
- **WindowsPerf**: Download and install WindowsPerf by following the [WindowsPerf install guide](/install-guides/wperf/).
62-
- **LLVM** (Recommended): You can install the LLVM toolchain by following the [LLVM toolchain for Windows on Arm install guide](/install-guides/llvm-woa).
54+
Before installing WindowsPerf Visual Studio Extension, check the following:
55+
1. Ensure Visual Studio 2022 is installed on your Windows on Arm device.
56+
2. Download and install WindowsPerf by following the [WindowsPerf install guide](/install-guides/wperf/).
57+
3. (Recommended) You can install the LLVM toolchain by following the [LLVM toolchain for Windows on Arm install guide](/install-guides/llvm-woa).
6358

6459
{{% notice llvm-objdump %}}
6560
The disassembly feature needs to have `llvm-objdump` available at `%PATH%` to work properly.
@@ -69,11 +64,10 @@ The disassembly feature needs to have `llvm-objdump` available at `%PATH%` to wo
6964

7065
To install the WindowsPerf Visual Studio Extension from Visual Studio:
7166

72-
1. Open Visual Studio 2022
73-
2. Go to the `Extensions` menu
74-
3. Select **Manage Extensions**
75-
4. Click on the search bar ( or tap `Ctrl` + `L` ) and type `WindowsPerf`
76-
5. Click on the install button and restart Visual Studio
67+
1. Open Visual Studio 2022.
68+
2. Go to the **Extensions** menu and select **Manage Extensions**.
69+
4. Click on the search bar (Ctrl+L) and type `WindowsPerf`.
70+
5. Click on the **Install** button and restart Visual Studio.
7771

7872
![WindowsPerf install page #center](../_images/wperf-vs-extension-install-page.png)
7973

@@ -83,7 +77,7 @@ You can also install the WindowsPerf Visual Studio Extension from GitHub.
8377

8478
Download the installation file directly from the [GitHub release page](https://github.com/arm-developer-tools/windowsperf-vs-extension/releases).
8579

86-
Unzip the downloaded file and double click on the `WindowsPerfGUI.vsix` file
80+
Unzip the downloaded file and double click on the `WindowsPerfGUI.vsix` file.
8781

8882
{{% notice Note %}}
8983
Make sure that any previous version of the extension is uninstalled and that Visual Studio is closed before installing the extension.
@@ -97,10 +91,10 @@ Building the source is not required, but offered as an alternative installation
9791

9892
### WindowsPerf Setup
9993

100-
To get started, you must link the GUI with the executable file `wperf.exe` by navigating to `Tools -> Options -> WindowsPerf -> WindowsPerf Path`. This step is crucial for utilizing the GUI, and the extension will not work if you don't do it.
94+
To get started, you must link the GUI with the executable file `wperf.exe` by navigating to **Tools > Options > WindowsPerf > WindowsPerf Path**. This step is crucial for utilizing the GUI, and the extension will not work if you don't do it.
10195

10296
## Uninstall the WindowsPerfGUI extension
10397

104-
In Visual Studio go to `Extensions` -> `Manage Extensions` -> `Installed` -> `All` -> `WindowsPerfGUI` and select "Uninstall".
98+
In Visual Studio go to **Extensions > Manage Extensions > Installed > All > WindowsPerfGUI** and select **Uninstall**.
10599

106-
Please note that this will be scheduled by Visual Studio. You may need to close VS instance and follow uninstall wizard to remove the extension.
100+
As this will be scheduled by Visual Studio, you might need to close the VS instance and follow the uninstall wizard to remove the extension.

0 commit comments

Comments
 (0)