Skip to content

Commit 2042e66

Browse files
authored
Merge branch 'main' into main
2 parents 41fc4b6 + 8491e41 commit 2042e66

File tree

64 files changed

+5372
-109
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+5372
-109
lines changed

assets/contributors.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,4 @@ Alaaeddine Chakroun,Day Devs,Alaaeddine-Chakroun,alaaeddine-chakroun,,https://da
4646
Koki Mitsunami,Arm,,,,
4747
Chen Zhang,Zilliz,,,,
4848
Tianyu Li,Arm,,,,
49-
Georgios Mermigkis,VectorCamp,gMerm,georgios-mermigkis,,https://vectorcamp.gr/
49+
Georgios Mermigkis,VectorCamp,gMerm,georgios-mermigkis,,https://vectorcamp.gr/

content/install-guides/ambaviz.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ A detailed overview of functionality is described in [Introduction to AMBA Viz](
3737

3838
AMBA Viz is a component of [Arm Hardware Success Kits](https://www.arm.com/products/development-tools/success-kits).
3939

40-
It is available to download at the [Arm Product Download Hub](https://developer.arm.com/downloads/view/HWSKT-KS-0002).
40+
It is available to download at the [Arm Product Download Hub](https://developer.arm.com/downloads/).
4141

42-
You can download AMBA Viz as an individual standalone component, or you can download the complete Success Kits.
42+
You can download AMBA Viz as an individual component, or you can download complete Success Kits.
4343

4444
For more information on the Download Hub, refer to the [Arm Product Download Hub install guide](/install-guides/pdh/).
4545

content/install-guides/armclang.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,13 @@ Arm Compiler for Embedded FuSa must also be [downloaded separately](#download).
4444

4545
Individual compiler packages for all supported host platforms can be downloaded from the [Arm Product Download Hub](#pdh) or the [Arm Tools Artifactory](#artifactory).
4646

47-
Individual compiler packages for all supported host platforms can be downloaded from the [Arm Product Download Hub](https://developer.arm.com/downloads) or the [Arm Tools Artifactory](https://www.keil.arm.com/artifacts/).
48-
4947
### Product Download Hub {#pdh}
5048

51-
All compiler packages can be downloaded from the [Arm Product Download Hub](https://developer.arm.com/downloads) (requires login):
49+
All compiler packages can be downloaded from the [Arm Product Download Hub](https://developer.arm.com/downloads) (requires login).
5250

53-
- [Arm Compiler for Embedded](https://developer.arm.com/downloads/view/ACOMPE)
54-
- [Arm Compiler for Embedded FuSa](https://developer.arm.com/downloads/view/ACOMP616)
51+
Download links to all available versions are given in the [Arm Compiler downloads index](https://developer.arm.com/documentation/ka005198).
5552

56-
These can either be used standalone or [integrated](#armds) into your Arm Development Studio installation.
53+
All compiler versions can be used standalone or [integrated](#armds) into your Arm Development Studio installation.
5754

5855
See also: [What should I do if I want to download a legacy release of Arm Compiler?](https://developer.arm.com/documentation/ka005184)
5956

@@ -121,7 +118,9 @@ export AC6_TOOLCHAIN_6_22_0=/home/$USER/ArmCompilerforEmbedded6.22/bin
121118

122119
## Set up the product license
123120

124-
Arm Compiler for Embedded and Arm Compiler for Embedded FuSa are license managed. License setup instructions are available in the [Arm Licensing install guide](/install-guides/license/).
121+
`Arm Compiler for Embedded` and `Arm Compiler for Embedded FuSa` are license managed.
122+
123+
License setup instructions are available in the [Arm Licensing install guide](/install-guides/license/).
125124

126125
## Verify installation
127126

content/install-guides/license/_index.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,9 @@ multitool_install_part: false # Set to true if a sub-page of a multi-page arti
1616
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
1717
---
1818

19-
Most Arm commercial tools are license managed. Arm is migrating to user-based licensing (UBL) which greatly simplifies license configuration. It is available for [Arm Success Kits](/install-guides/successkits/) as well as [Arm Development Studio](/install-guides/armds).
19+
Most Arm commercial tools are license managed. Arm is migrating to user-based licensing (UBL) which greatly simplifies license configuration.
2020

21-
Success kits are available as `Hardware Success Kits` (`HSK`) or `Software Success Kits` (`SSK`). See the table below for tooling provided. SSK is a subset of HSK.
22-
23-
With UBL, you have unlimited access to all components in the success kit you have enabled. The license is cached locally for up to 7 days, enabling remote or traveling users to access tools without connecting to their license server.
21+
A user-based license is cached locally for up to 7 days, enabling remote or traveling users to access tools without connecting to their license server.
2422

2523
Starting any UBL enabled tool when the server is available will renew the license for 7 more days. This renewal attempt is performed once per 24 hours.
2624

@@ -52,10 +50,4 @@ Legacy product versions do not support UBL licensing and use FlexLM [floating li
5250

5351
## User-based Licensing Video Tutorials
5452

55-
In addition to the set up and install instructions below, a collection of video tutorials are available on the Arm Developer website:
56-
57-
* [Accessing the Arm License Portal](https://developer.arm.com/Additional%20Resources/Video%20Tutorials/User-based%20Licensing%20-%20Accessing%20the%20Arm%20License%20Portal)
58-
* [Cloud-based Licenses and Activation Codes](https://developer.arm.com/Additional%20Resources/Video%20Tutorials/User-based%20Licensing%20-%20Cloud-based%20Licenses%20and%20Activation%20Codes)
59-
* [Local License Server Setup](https://developer.arm.com/Additional%20Resources/Video%20Tutorials/User-based%20Licensing%20-%20Local%20License%20Server%20Setup)
60-
* [End-user Setup](https://developer.arm.com/Additional%20Resources/Video%20Tutorials/User-based%20Licensing%20-%20End%20User%20Setup)
61-
* [Removal of Licenses and Decommissioning Server](https://developer.arm.com/Additional%20Resources/Video%20Tutorials/User-based%20Licensing%20-%20License%20Removal%20and%20Decommissioning%20Server)
53+
In addition to the set up and install instructions below, a collection of video tutorials are available on [Arm Developer](https://developer.arm.com//Tools%20and%20Software/User-based%20Licensing).

content/install-guides/license/ubl_license_enduser.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,17 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install ar
1515

1616
A [Local License Server (LLS)](/install-guides/license/ubl_license_admin/) must first be set up by your license administration team.
1717

18-
{{% notice Notice%}}
19-
A Software Success Kit is a subset of a Hardware Success Kit.
20-
21-
You should confirm which type of license is appropriate for your needs.
22-
{{% /notice %}}
23-
2418
## Activate license on end user machine
2519

26-
The UBL license can be activated on the end user machine in different ways. Select the most appropriate for your needs.
20+
The user-based license can be activated on the end user machine in different ways. Select the most appropriate for your needs.
2721

2822
* [Activate via environment variable](#envvar)
2923
* [Activate within tools IDE](#ide)
3024
* [Activate manually](#manual)
3125

3226
## Activate via environment variable {#envvar}
3327

34-
Create `ARMLM_ONDEMAND_ACTIVATION` environment variable referencing the Success Kit product code and your internal UBL license server. Contact your internal license administrators for information on your internal server.
28+
Create `ARMLM_ONDEMAND_ACTIVATION` environment variable referencing the product code and your internal license server. Contact your internal license administrators for information on your internal server.
3529

3630
### HSK
3731
```console
@@ -42,7 +36,7 @@ export ARMLM_ONDEMAND_ACTIVATION=HWSKT-STD0@https://internal.ubl.server
4236
export ARMLM_ONDEMAND_ACTIVATION=SWSKT-STD0@https://internal.ubl.server
4337
```
4438

45-
A license will be automatically checked out whenever a UBL enabled tool is run, for example:
39+
A license will be automatically checked out whenever a user-based licensing enabled tool is run, for example:
4640
```command
4741
armclang --version
4842
```
@@ -58,17 +52,12 @@ Select `Activate with` > `License Server`, and enter the appropriate license ser
5852

5953
## Activate manually {#manual}
6054

61-
Open a command prompt, and navigate to the bin directory of any UBL enabled product.
55+
Open a command prompt, and navigate to the bin directory of any user-based licensing enabled product.
6256

63-
Activate an appropriate success kit license with `armlm`:
64-
### HSK
57+
Activate your user-based license with `armlm`:
6558
```console
6659
armlm activate --server https://internal.ubl.server --product HWSKT-STD0
6760
```
68-
### SSK
69-
```
70-
armlm activate --server https://internal.ubl.server --product SWSKT-STD0
71-
```
7261

7362
## Confirm license check-out {#confirm}
7463

@@ -84,7 +73,7 @@ You should see an output similar to:
8473
Hardware Success Kit
8574
Product code: HWSKT-STD0
8675
Order Id: xxxxxxxx
87-
License valid until: 2023-12-31
76+
License valid until: 2025-12-31
8877
Local cache expires in: 6 days and 23 hours
8978
License server: https://internal.ubl.server
9079
```
@@ -93,7 +82,7 @@ Hardware Success Kit
9382

9483
Your license is cached on your local machine, and is valid for 7 days.
9584

96-
There will be an automatic attempt to refresh this timer on the first usage of a UBL enabled tool in a day. If that fails (for example, if tools are run whilst not connected to your network) the tools can still be used provided there is still time on the locally cached license.
85+
There will be an automatic attempt to refresh this license once per day. If that fails (for example, if tools are run whilst not connected to your network) the tools can still be used provided there is still time on the locally cached license.
9786

9887
To manually refresh the license, you can deactivate and reactivate your license (when connected to your network). For example:
9988
```command

content/install-guides/socrates.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install ar
3535

3636
Socrates is a component of [Arm Hardware Success Kits](https://www.arm.com/products/development-tools/success-kits).
3737

38-
It is available to download via the [Arm Product Download Hub](https://developer.arm.com/downloads/view/HWSKT-KS-0002).
38+
It is available to download via the [Arm Product Download Hub](https://developer.arm.com/downloads/).
3939

40-
You can download Socrates as an individual standalone component, or you can download the complete success kits.
40+
You can download Socrates as an individual component, or you can download the complete success kits.
4141

4242
For more information on the Download Hub, refer to the [Arm Product Download Hub install guide](/install-guides/pdh/).
4343

content/install-guides/successkits.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,12 @@ multi_install: false # Set to true if first page of multi-page articl
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-
Arm Development tools are packaged as [Arm Success Kits](https://www.arm.com/products/development-tools/success-kits). These come in two forms:
31+
Arm Development tools are packaged as [Arm Success Kits](https://www.arm.com/products/development-tools/success-kits).
3232

33-
- Software Success Kits (SSK)
34-
- Hardware Success Kits (HSK)
35-
36-
SSKs contain all of the software development tools provided by Arm.
37-
38-
HSKs include SSK as well as additional tools for IP configuration and evaluation.
39-
40-
Arm Success Kits are a component of [Arm Flexible Access](https://www.arm.com/en/products/flexible-access).
33+
Arm Success Kits are a component of:
34+
* [Arm Total Access](https://www.arm.com/products/licensing/arm-total-access)
35+
* [Arm Flexible Access](https://www.arm.com/en/products/flexible-access)
36+
* [Arm Academic Access](https://www.arm.com/resources/research/enablement/academic-access)
4137

4238
## Downloading Success Kit components
4339

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

Lines changed: 31 additions & 28 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: Windows Performance Analyzer (WPA) Plugin
4+
title: Windows Performance Analyzer (WPA) plugin
55
minutes_to_complete: 15
66

77
official_docs: https://github.com/arm-developer-tools/windowsperf-wpa-plugin
@@ -29,37 +29,40 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
2929

3030
## What is the Windows Performance Analyzer plugin?
3131

32-
The Windows Performance Analyzer plugin connects Windows Perf to the Windows Performance Analyzer (WPA).
32+
The Windows Performance Analyzer (WPA) plugin connects [Windows Perf](/learning-paths/laptops-and-desktops/windowsperf/) to the Windows Performance Analyzer. Windows Perf is a lightweight performance profiling tool inspired by Linux Perf and designed for Windows on Arm.
3333

34-
[WindowsPerf](https://github.com/arm-developer-tools/windowsperf) is a lightweight performance profiling tool inspired by Linux Perf and designed for Windows on Arm.
34+
Windows Performance Analyzer is a useful tool that supports developers with diagnostics and performance tuning. It generates data tables and graphs of Event Tracing for Windows (ETW) events, which are recorded in one of three ways:
35+
- Windows Performance Recorder (WPR)
36+
- Xperf
37+
- or through an assessment that's run in the Assessment Platform.
38+
39+
WPA can open event trace log (ETL) files, which you can use for analysis.
3540

36-
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 opens event trace log (ETL) files for analysis.
37-
38-
The WPA plugin is built using the [Microsoft Performance Toolkit SDK](https://github.com/microsoft/microsoft-performance-toolkit-sdk), a collection of tools to create and extend performance analysis applications. The plugin parses json output from WidowsPerf so that it can be visualized in WPA.
41+
The WPA plugin is built using the [Microsoft Performance Toolkit SDK](https://github.com/microsoft/microsoft-performance-toolkit-sdk), a collection of tools to create and extend performance analysis applications. The plugin parses JSON output from Windows Perf so that it can be visualized in WPA.
3942

4043
## What are some of the features of the WPA plugin?
4144

42-
The WindowsPerf GUI extension is composed of several key features, each designed to streamline the user experience:
45+
The WindowsPerf GUI extension includes features, which are designed to streamline the user experience:
4346

44-
### What is the timeline view?
47+
### Timeline view
4548

46-
The timeline view visualizes the `wperf stat` timeline data plotted by event group.
49+
The timeline view visualizes the `wperf stat` timeline data plotted by event group:
4750

4851
![Timeline By Core Table](/install-guides/_images/wpa-timeline-by-core.png)
4952

50-
### What is the telemetry view?
53+
### Telemetry view
5154

52-
The telemetry view displays telemetry events grouped by unit.
55+
The telemetry view displays telemetry events grouped by unit:
5356

5457
![Telemetry Table](/install-guides/_images/wpa-telemetry-table.png)
5558

5659
## How do I install the WPA plugin?
5760

58-
Before using the WPA plugin, make sure you have installed WPA.
61+
Before installing the plugin, you need to make sure you have installed WPA:
5962

60-
### Windows Performance Analyzer
63+
### Install WPA
6164

62-
WPA is included in the Windows Assessment and Deployment Kit (Windows ADK) that can be downloaded from [Microsoft](https://go.microsoft.com/fwlink/?linkid=2243390).
65+
WPA is included in the Windows Assessment and Deployment Kit (Windows ADK), which you can download from [Microsoft](https://go.microsoft.com/fwlink/?linkid=2243390).
6366

6467
{{% notice Note %}}
6568
The WPA plugin requires WPA version `11.0.7.2` or higher.
@@ -69,46 +72,46 @@ Run the downloaded `adksetup.exe` program.
6972

7073
Specify the default installation location and accept the license agreement.
7174

72-
Make sure that "Windows Performance Toolkit" is checked under "Select the features you want to install".
75+
Make sure that **Windows Performance Toolkit** is checked under **Select the features you want to install**.
7376

7477
![WPA Installation](/install-guides/_images/wpa-installation.png)
7578

76-
Finally, click Install.
79+
Finally, click **Install**.
7780

78-
### Windows Performance Analyzer plugin
81+
### Install the WPA plugin
7982

80-
The plugin is a single `.dll` file.
83+
Now you're ready to install the plugin, which is a single `.dll` file.
8184

82-
Download a `.zip` file from the [GitHub releases page](https://github.com/arm-developer-tools/windowsperf-wpa-plugin/releases).
85+
Download the `.zip` file from the [Windows Perf WPA plugin GitHub releases page](https://github.com/arm-developer-tools/windowsperf-wpa-plugin/releases) on GitHub.
8386

84-
To download the latest version from the command prompt:
87+
Alternatively, you can download the latest version using command prompt:
8588

8689
```console
8790
mkdir wpa-plugin
8891
cd wpa-plugin
8992
curl -L -O https://github.com/arm-developer-tools/windowsperf-wpa-plugin/releases/download/1.0.2/wpa-plugin-1.0.2.zip
9093
```
9194

92-
Extract the `.dll` file from the downloaded `.zip` file.
95+
Now extract the `.dll` file from the downloaded `.zip` file.
9396

9497
```console
9598
tar -xmf wpa-plugin-1.0.2.zip
9699
```
97100

98-
You now have the file `WPAPlugin.dll` in your `wpa-plugin` directory.
101+
The file `WPAPlugin.dll` is now in your `wpa-plugin` directory.
99102

100103
There are three ways you can install the `WPAPlugin.dll` file:
101104

102-
###### 1. Copy the plugin dll to the CustomDataSources directory next to the WPA executable.
105+
#### 1. Copy the .dll file to the CustomDataSources directory next to the WPA executable.
103106

104107
The default location is:
105108
`C:\\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit\CustomDataSources`
106109

107-
###### 2. Set an environment variable
110+
#### 2. Set an environment variable.
108111

109-
Set the `WPA_ADDITIONAL_SEARCH_DIRECTORIES` environment variable to the location of the DLL file.
112+
Set the `WPA_ADDITIONAL_SEARCH_DIRECTORIES` environment variable to the location of the `.dll` file.
110113

111-
###### 3. Start WPA from the command line and pass the plugin directory location using a flag.
114+
#### 3. Start WPA from the command line and pass the plugin directory location using a flag.
112115

113116
Use the `-addsearchdir` flag for `wpa`:
114117

@@ -118,13 +121,13 @@ wpa -addsearchdir "%USERPROFILE%\plugins"
118121
119122
## How can I verify the WPA plugin is installed?
120123

121-
To verify the plugin is loaded, launch WPA and the plugin should appear under `Help > About Windows Performance Analyzer`
124+
To verify the plugin is loaded, launch WPA and the plugin should appear under **Help > About Windows Performance Analyzer**.
122125

123126
![WPA installation confirmation](/install-guides/_images/about-wpa.png)
124127

125128
## How can I run the WPA plugin from the command line?
126129

127-
To open a json file directly from the command line, you can use the `-i` flag to specify the file path to open.
130+
To open a JSON file directly from the command line, you can use the `-i` flag to specify the file path to open.
128131

129132
For example: to open `timeline_long.json` in your downloads directory, run the command:
130133

content/learning-paths/cross-platform/gitlab/1-gitlab-runner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ A GitLab Runner works with GitLab CI/CD to run jobs in a pipeline. It acts as an
1616
3. Multi-architecture support: GitLab runners support multiple architectures including - `x86/amd64` and `arm64`
1717

1818
## What is Google Axion?
19-
Axion is Google’s first Arm-based server processor, built using the Armv9 Neoverse V2 CPU. The VM instances are part of the `C4A` family of compute instances. To learn more about Google Axion refer to this [page](cloud.google.com/products/axion).
19+
Axion is Google’s first Arm-based server processor, built using the Armv9 Neoverse V2 CPU. The VM instances are part of the `C4A` family of compute instances. To learn more about Google Axion refer to this [page](http://cloud.google.com/products/axion/).
2020

2121
## Install GitLab runner on a Google Axion VM
2222

0 commit comments

Comments
 (0)