Skip to content

Commit 8e9db65

Browse files
LoopedBard3LoopedBard3
authored
Update some doc references from net8.0 to net9.0 (#4275)
Update some doc references from net8.0 to net9.0 and fix some linting errors.
1 parent c61d929 commit 8e9db65

7 files changed

+135
-128
lines changed

‎docs/basic-scenarios.md

+15-14
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ For **Self-Contained Empty Console App Size On Disk** scenario, run precommand t
3434

3535
```cmd
3636
cd emptyconsoletemplate
37-
python3 pre.py publish -f net8.0 -c Release -r win-x64
37+
python3 pre.py publish -f net9.0 -c Release -r win-x64
3838
```
3939

40-
`-f net8.0` sets the new template project targeting `net8.0` framework; `-c Release` configures the publish to be in release; `-r win-x64` takes an [RID](https://docs.microsoft.com/en-us/dotnet/core/rid-catalog)(Runtime Identifier) and specifies which runtime it supports.
40+
`-f net9.0` sets the new template project targeting `net9.0` framework; `-c Release` configures the publish to be in release; `-r win-x64` takes an [RID](https://docs.microsoft.com/en-us/dotnet/core/rid-catalog)(Runtime Identifier) and specifies which runtime it supports.
4141

4242
**Note that by specifying RID option `-r <RID>`, it defaults to publish the app into a [SCD](https://docs.microsoft.com/en-us/dotnet/core/deploying/#publish-self-contained)(Self-contained Deployment) app; without it, a [FDD](https://docs.microsoft.com/en-us/dotnet/core/deploying/#publish-framework-dependent)(Framework Dependent Deployment) app will be published.**
4343

@@ -85,27 +85,28 @@ Same instruction of [Scenario Tests Guide - Step 4](./scenarios-workflow.md#step
8585
- net6.0
8686
- net7.0
8787
- net8.0
88+
- net9.0
8889
- \<-r RID> values:
8990
- ""(WITHOUT `-r <RID>` --> FDD app)
9091
- `"-r <RID>"` (WITH `-r` --> SCD app, [list of RID](https://docs.microsoft.com/en-us/dotnet/core/rid-catalog))
9192

9293
| Scenario | Asset Directory | Precommand | Testcommand | Postcommand | Supported Framework | Supported Platform |
9394
|-----------------------------------------------|-------------------------|-----------------------------------------------|-----------------|-------------|--------------------------------------------------|--------------------|
94-
| Static Console Template Publish Startup | staticconsoletemplate | pre.py publish -f TFM -c Release | test.py startup | post.py | netcoreapp3.1;net6.0;net7.0;net8.0 | Windows |
95-
| Static Console Template Publish SizeOnDisk | staticconsoletemplate | pre.py publish -f TFM -c Release /<-r RID> | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0 | Windows;Linux |
96-
| Static Console Template Build SizeOnDisk | staticconsoletemplate | pre.py build -f TFM -c Release | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0 | Windows;Linux |
97-
| Static VB Console Template Publish Startup | staticvbconsoletemplate | pre.py publish -f TFM -c Release | test.py startup | post.py | netcoreapp3.1;net6.0;net7.0;net8.0 | Windows |
98-
| Static VB Console Template Publish SizeOnDisk | staticvbconsoletemplate | pre.py publish -f TFM -c Release /<-r RID> | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0 | Windows;Linux |
99-
| Static VB Console Template Build SizeOnDisk | staticvbconsoletemplate | pre.py build -f TFM -c Release | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0 | Windows;Linux |
95+
| Static Console Template Publish Startup | staticconsoletemplate | pre.py publish -f TFM -c Release | test.py startup | post.py | netcoreapp3.1;net6.0;net7.0;net8.0;net9.0 | Windows |
96+
| Static Console Template Publish SizeOnDisk | staticconsoletemplate | pre.py publish -f TFM -c Release /<-r RID> | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0;net9.0 | Windows;Linux |
97+
| Static Console Template Build SizeOnDisk | staticconsoletemplate | pre.py build -f TFM -c Release | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0;net9.0 | Windows;Linux |
98+
| Static VB Console Template Publish Startup | staticvbconsoletemplate | pre.py publish -f TFM -c Release | test.py startup | post.py | netcoreapp3.1;net6.0;net7.0;net8.0;net9.0 | Windows |
99+
| Static VB Console Template Publish SizeOnDisk | staticvbconsoletemplate | pre.py publish -f TFM -c Release /<-r RID> | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0;net9.0 | Windows;Linux |
100+
| Static VB Console Template Build SizeOnDisk | staticvbconsoletemplate | pre.py build -f TFM -c Release | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0;net9.0 | Windows;Linux |
100101
| Static Winforms Template Publish Startup | staticwinformstemplate | pre.py publish -f TFM -c Release | test.py startup | post.py | netcoreapp3.1 | Windows |
101102
| Static Winforms Template Publish SizeOnDisk | staticwinformstemplate | pre.py publish -f TFM -c Release /<-r RID> | test.py sod | post.py | netcoreapp3.1 | Windows;Linux |
102103
| Static Winforms Template Build SizeOnDisk | staticwinformstemplate | pre.py build -f TFM -c Release | test.py sod | post.py | netcoreapp3.1 | Windows;Linux |
103-
| New Console Template Publish Startup | emptyconsoletemplate | pre.py publish -f TFM -c Release | test.py startup | post.py | netcoreapp3.1;net6.0;net7.0;net8.0 | Windows |
104-
| New Console Template Publish SizeOnDisk | emptyconsoletemplate | pre.py publish -f TFM -c Release /<-r RID> | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0 | Windows;Linux |
105-
| New Console Template Build SizeOnDisk | emptyconsoletemplate | pre.py build -f TFM -c Release | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0 | Windows;Linux |
106-
| New VB Console Template Publish Startup | emptyvbconsoletemplate | pre.py publish -f TFM -c Release | test.py startup | post.py | netcoreapp3.1;net6.0;net7.0;net8.0 | Windows |
107-
| New VB Console Template Publish SizeOnDisk | emptyvbconsoletemplate | pre.py publish -f TFM -c Release /<-r RID> | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0 | Windows;Linux |
108-
| New VB Console Template Build SizeOnDisk | emptyvbconsoletemplate | pre.py build -f TFM -c Release | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0 | Windows;Linux |
104+
| New Console Template Publish Startup | emptyconsoletemplate | pre.py publish -f TFM -c Release | test.py startup | post.py | netcoreapp3.1;net6.0;net7.0;net8.0;net9.0 | Windows |
105+
| New Console Template Publish SizeOnDisk | emptyconsoletemplate | pre.py publish -f TFM -c Release /<-r RID> | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0;net9.0 | Windows;Linux |
106+
| New Console Template Build SizeOnDisk | emptyconsoletemplate | pre.py build -f TFM -c Release | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0;net9.0 | Windows;Linux |
107+
| New VB Console Template Publish Startup | emptyvbconsoletemplate | pre.py publish -f TFM -c Release | test.py startup | post.py | netcoreapp3.1;net6.0;net7.0;net8.0;net9.0 | Windows |
108+
| New VB Console Template Publish SizeOnDisk | emptyvbconsoletemplate | pre.py publish -f TFM -c Release /<-r RID> | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0;net9.0 | Windows;Linux |
109+
| New VB Console Template Build SizeOnDisk | emptyvbconsoletemplate | pre.py build -f TFM -c Release | test.py sod | post.py | netcoreapp3.1;net6.0;net7.0;net8.0;net9.0 | Windows;Linux |
109110

110111
## Relevant Links
111112

‎docs/benchmarkdotnet.md

+41-39
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,31 @@ BenchmarkDotNet is the benchmarking tool that allows to run benchmarks for .NET,
44

55
## Table of Contents
66

7-
- [Main Concepts](#main-concepts)
8-
- [Prerequisites](#prerequisites)
9-
- [Building the benchmarks](#building-the-benchmarks)
10-
- [Using .NET Cli](#using-net-cli)
11-
- [Using Python script](#using-python-script)
12-
- [Running the Benchmarks](#running-the-benchmarks)
13-
- [Interactive Mode](#interactive-mode)
14-
- [Command Line](#command-line)
15-
- [Filtering the Benchmarks](#filtering-the-benchmarks)
16-
- [Listing the Benchmarks](#listing-the-benchmarks)
17-
- [Reading the Results](#reading-the-results)
18-
- [Reading the Histogram](#reading-the-histogram)
19-
- [Reading Memory Statistics](#reading-memory-statistics)
20-
- [Profiling](#profiling)
21-
- [Disassembly](#disassembly)
22-
- [Multiple Runtimes](#multiple-runtimes)
23-
- [Regressions](#regressions)
24-
- [Private Runtime Builds](#private-runtime-builds)
25-
- [Running In Process](#running-in-process)
26-
- [CoreRun](#corerun)
27-
- [dotnet cli](#dotnet-cli)
28-
- [Private CLR Build](#private-clr-build)
29-
- [Private CoreRT Build](#private-corert-build)
7+
- [BenchmarkDotNet](#benchmarkdotnet)
8+
- [Table of Contents](#table-of-contents)
9+
- [Main Concepts](#main-concepts)
10+
- [Prerequisites](#prerequisites)
11+
- [Building the benchmarks](#building-the-benchmarks)
12+
- [Using .NET Cli](#using-net-cli)
13+
- [Using Python script](#using-python-script)
14+
- [Running the Benchmarks](#running-the-benchmarks)
15+
- [Interactive Mode](#interactive-mode)
16+
- [Command Line](#command-line)
17+
- [Filtering the Benchmarks](#filtering-the-benchmarks)
18+
- [Listing the Benchmarks](#listing-the-benchmarks)
19+
- [Reading the Results](#reading-the-results)
20+
- [Reading the Histogram](#reading-the-histogram)
21+
- [Reading Memory Statistics](#reading-memory-statistics)
22+
- [Profiling](#profiling)
23+
- [Disassembly](#disassembly)
24+
- [Multiple Runtimes](#multiple-runtimes)
25+
- [Regressions](#regressions)
26+
- [Private Runtime Builds](#private-runtime-builds)
27+
- [Running In Process](#running-in-process)
28+
- [CoreRun](#corerun)
29+
- [dotnet cli](#dotnet-cli)
30+
- [Private CLR Build](#private-clr-build)
31+
- [Private CoreRT Build](#private-corert-build)
3032

3133
## Main Concepts
3234

@@ -70,8 +72,8 @@ dotnet build -c Release
7072
If you don't want to install all of them and just run the benchmarks for selected runtime(s), you need to manually edit the [MicroBenchmarks.csproj](../src/benchmarks/micro/MicroBenchmarks.csproj) file.
7173

7274
```diff
73-
-<TargetFrameworks>netcoreapp3.1;net6.0;net7.0;net8.0</TargetFrameworks>
74-
+<TargetFrameworks>net8.0</TargetFrameworks>
75+
-<TargetFrameworks>netcoreapp3.1;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
76+
+<TargetFrameworks>net9.0</TargetFrameworks>
7577
```
7678

7779
The alternative is to set `PERFLAB_TARGET_FRAMEWORKS` environment variable to selected Target Framework Moniker.
@@ -81,7 +83,7 @@ The alternative is to set `PERFLAB_TARGET_FRAMEWORKS` environment variable to se
8183
If you don't want to install `dotnet cli` manually, we have a Python 3 script which can do that for you. All you need to do is to provide the frameworks:
8284

8385
```cmd
84-
py .\scripts\benchmarks_ci.py --frameworks net8.0
86+
py .\scripts\benchmarks_ci.py --frameworks net9.0
8587
```
8688

8789
## Running the Benchmarks
@@ -91,7 +93,7 @@ py .\scripts\benchmarks_ci.py --frameworks net8.0
9193
To run the benchmarks in interactive mode you have to execute `dotnet run -c Release -f $targetFrameworkMoniker` in the folder with benchmarks project.
9294

9395
```cmd
94-
C:\Projects\performance\src\benchmarks\micro> dotnet run -c Release -f net8.0
96+
C:\Projects\performance\src\benchmarks\micro> dotnet run -c Release -f net9.0
9597
Available Benchmarks:
9698
#0 Burgers
9799
#1 ByteMark
@@ -122,37 +124,37 @@ The glob patterns are applied to full benchmark name: namespace.typeName.methodN
122124
- Run all the benchmarks from BenchmarksGame namespace:
123125

124126
```cmd
125-
dotnet run -c Release -f net8.0 --filter BenchmarksGame*
127+
dotnet run -c Release -f net9.0 --filter BenchmarksGame*
126128
```
127129

128130
- Run all the benchmarks with type name Richards:
129131

130132
```cmd
131-
dotnet run -c Release -f net8.0 --filter *.Richards.*
133+
dotnet run -c Release -f net9.0 --filter *.Richards.*
132134
```
133135

134136
- Run all the benchmarks with method name ToStream:
135137

136138
```cmd
137-
dotnet run -c Release -f net8.0 --filter *.ToStream
139+
dotnet run -c Release -f net9.0 --filter *.ToStream
138140
```
139141

140142
- Run ALL benchmarks:
141143

142144
```cmd
143-
dotnet run -c Release -f net8.0 --filter *
145+
dotnet run -c Release -f net9.0 --filter *
144146
```
145147

146148
- You can provide many filters (logical disjunction):
147149

148150
```cmd
149-
dotnet run -c Release -f net8.0 --filter System.Collections*.Dictionary* *.Perf_Dictionary.*
151+
dotnet run -c Release -f net9.0 --filter System.Collections*.Dictionary* *.Perf_Dictionary.*
150152
```
151153

152154
- To print a **joined summary** for all of the benchmarks (by default printed per type), use `--join`:
153155

154156
```cmd
155-
dotnet run -c Release -f net8.0 --filter BenchmarksGame* --join
157+
dotnet run -c Release -f net9.0 --filter BenchmarksGame* --join
156158
```
157159

158160
Please remember that on **Unix** systems `*` is resolved to all files in current directory, so you need to escape it `'*'`.
@@ -164,7 +166,7 @@ To print the list of all available benchmarks you need to pass `--list [tree/fla
164166
Example: Show the tree of all the benchmarks from System.Threading namespace that can be run for .NET 7.0:
165167

166168
```cmd
167-
dotnet run -c Release -f net8.0 --list tree --filter System.Threading*
169+
dotnet run -c Release -f net9.0 --list tree --filter System.Threading*
168170
```
169171

170172
```log
@@ -259,7 +261,7 @@ If you want to disassemble the benchmarked code, you need to use the [Disassembl
259261

260262
You can do that by passing `--disassm` to the app or by using `[DisassemblyDiagnoser(printAsm: true, printSource: true)]` attribute or by adding it to your config with `config.With(DisassemblyDiagnoser.Create(new DisassemblyDiagnoserConfig(printAsm: true, recursiveDepth: 1))`.
261263

262-
Example: `dotnet run -c Release -f net8.0 -- --filter System.Memory.Span<Int32>.Reverse -d`
264+
Example: `dotnet run -c Release -f net9.0 -- --filter System.Memory.Span<Int32>.Reverse -d`
263265

264266
```assembly
265267
; System.Runtime.InteropServices.MemoryMarshal.GetReference[[System.Byte, System.Private.CoreLib]](System.Span`1<Byte>)
@@ -285,7 +287,7 @@ M00_L00:
285287

286288
The `--runtimes` or just `-r` allows you to run the benchmarks for **multiple Runtimes**.
287289

288-
Available options are: Mono, wasmnet70, CoreRT, net462, net47, net471, net472, netcoreapp3.1, net6.0, net7.0, and net8.0.
290+
Available options are: Mono, wasmnet70, CoreRT, net462, net47, net471, net472, netcoreapp3.1, net6.0, net7.0, net8.0, and net9.0.
289291

290292
Example: run the benchmarks for .NET 7.0 and 8.0:
291293

@@ -329,7 +331,7 @@ Please use this option only when you are sure that the benchmarks you want to ru
329331
It's possible to benchmark private builds of [dotnet/runtime](https://github.com/dotnet/runtime) using CoreRun.
330332

331333
```cmd
332-
dotnet run -c Release -f net8.0 --coreRun $thePath
334+
dotnet run -c Release -f net9.0 --coreRun $thePath
333335
```
334336

335337
**Note:** You can provide more than 1 path to CoreRun. In such case, the first path will be the baseline and all the benchmarks are going to be executed for all CoreRuns you have specified.
@@ -352,7 +354,7 @@ public void PrintInfo()
352354
You can also use any dotnet cli to build and run the benchmarks.
353355

354356
```cmd
355-
dotnet run -c Release -f net8.0 --cli "C:\Projects\performance\.dotnet\dotnet.exe"
357+
dotnet run -c Release -f net9.0 --cli "C:\Projects\performance\.dotnet\dotnet.exe"
356358
```
357359

358360
This is very useful when you want to compare different builds of .NET.
@@ -374,5 +376,5 @@ More info can be found [here](https://github.com/dotnet/BenchmarkDotNet/issues/7
374376
To run benchmarks with private CoreRT build you need to provide the `IlcPath`. Example:
375377

376378
```cmd
377-
dotnet run -c Release -f net8.0 -- --ilcPath C:\Projects\corert\bin\Windows_NT.x64.Release
379+
dotnet run -c Release -f net9.0 -- --ilcPath C:\Projects\corert\bin\Windows_NT.x64.Release
378380
```

0 commit comments

Comments
 (0)