Skip to content

Commit db4baaa

Browse files
github-actions[bot]steveisokjkotas
authored
[release/8.0-staging] Update dotnet-pgo.md (#103926)
* Update dotnet-pgo.md Updates the instructions on how to install and use dotnet-pgo. * Update docs/design/features/dotnet-pgo.md --------- Co-authored-by: Steve Pfister <[email protected]> Co-authored-by: Jan Kotas <[email protected]>
1 parent ad90ca5 commit db4baaa

File tree

1 file changed

+3
-11
lines changed

1 file changed

+3
-11
lines changed

docs/design/features/dotnet-pgo.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,13 @@
11
# dotnet-pgo Spec
22
Utilize trace data for improving application performance
33

4-
NOTE: This documentation page contains information on some features that are still work-in-progress.
5-
64
## Intro
75

86
The dotnet-pgo tool is a cross-platform CLI global tool that enables conversion of traces of .NET Core applications collected via dotnet-trace, ETW, perfview, perfcollect, LTTNG to be used to improve the performance of an application or library.
97

108
## Installing dotnet-pgo
119

12-
The first step is to install the dotnet-pgo CLI global tool.
13-
14-
```cmd
15-
$ dotnet tool install --global dotnet-pgo
16-
You can invoke the tool using the following command: dotnet-pgo
17-
Tool 'dotnet-pgo' (version '6.0.47001') was successfully installed.
18-
```
10+
The only way to use dotnet-pgo is to build it in the runtime repo. To learn how to build the runtime, consult the [how to build](https://github.com/dotnet/runtime/tree/main/docs/workflow/building/coreclr) docs for Windows, macOS, or Linux.
1911

2012
## Using dotnet-pgo to optimize an application
2113

@@ -37,14 +29,14 @@ set DOTNET_TC_QuickJitForLoops=1
3729
set DOTNET_TC_CallCountThreshold=10000
3830
set DOTNET_ReadyToRun=0
3931
40-
dotnet-trace collect --providers Microsoft-Windows-DotNETRuntime:0x1E000080018:4 -- bin\Release\net6.0\pgotest.exe
32+
dotnet-trace collect --providers Microsoft-Windows-DotNETRuntime:0x1E000080018:4 -- bin\Release\net{version-number-goes-here}.0\pgotest.exe
4133
4234
set DOTNET_TieredPGO=
4335
set DOTNET_TC_QuickJitForLoops=
4436
set DOTNET_TC_CallCountThreshold=
4537
set DOTNET_ReadyToRun=
4638
47-
dotnet-pgo create-mibc --trace trace.nettrace --output trace.mibc
39+
${YOUR-REPO-ROOT}\artifacts\bin\coreclr\{OS}.{ARCHITECTURE}.{CONFIGURATION}\dotnet-pgo create-mibc --trace trace.nettrace --output trace.mibc
4840
4941
dotnet publish --runtime win-x64 -p:PublishReadyToRun=true -p:ReadyToRunOptimizationData=trace.mibc
5042
```

0 commit comments

Comments
 (0)