Skip to content

Commit ff96952

Browse files
danmoseleyCopilot
andcommitted
Fix pre-existing doc issues spotted by reviewer
- -aotcompilermode -> --aotcompilermode (missing dash) - Broken closing code fence (line 616) - --corerun -> --coreRun (consistent casing) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 7b2649f commit ff96952

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

docs/benchmarking-workflow-dotnet-runtime.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ dotnet restore $RunDir\performance\src\benchmarks\micro\MicroBenchmarks.csproj -
294294
dotnet build $RunDir\performance\src\benchmarks\micro\MicroBenchmarks.csproj --configuration Release --framework net11.0 --no-restore /p:NuGetPackageRoot=$RunDir\performance\artifacts\packages /p:UseSharedCompilation=false /p:BuildInParallel=false /m:1
295295
296296
# Run
297-
dotnet run --project $RunDir\performance\src\benchmarks\micro\MicroBenchmarks.csproj --configuration Release --framework net11.0 --no-restore --no-build -- --filter $TestToRun* --anyCategories Libraries Runtime "" --category-exclusion-filter NoAOT NoWASM --runtimes monoaotllvm --aotcompilerpath $RunDir\artifacts\bin\aot\sgen\mini\mono-sgen.exe --customruntimepack $RunDir\artifacts\bin\aot\pack -aotcompilermode llvm --logBuildOutput --generateBinLog "" --artifacts $RunDir\artifacts\BenchmarkDotNet.Artifacts --packages $RunDir\performance\artifacts\packages --buildTimeout 1200
297+
dotnet run --project $RunDir\performance\src\benchmarks\micro\MicroBenchmarks.csproj --configuration Release --framework net11.0 --no-restore --no-build -- --filter $TestToRun* --anyCategories Libraries Runtime "" --category-exclusion-filter NoAOT NoWASM --runtimes monoaotllvm --aotcompilerpath $RunDir\artifacts\bin\aot\sgen\mini\mono-sgen.exe --customruntimepack $RunDir\artifacts\bin\aot\pack --aotcompilermode llvm --logBuildOutput --generateBinLog "" --artifacts $RunDir\artifacts\BenchmarkDotNet.Artifacts --packages $RunDir\performance\artifacts\packages --buildTimeout 1200
298298
```
299299

300300
### dotnet runtime testing for MonoInterpreter
@@ -613,7 +613,8 @@ The first thing you need to do is send a PR with the new API to the [dotnet/runt
613613

614614
```cmd
615615
/home/adsitnik/projects/performance>python3 ./scripts/benchmarks_ci.py --filter $YourFilter -f net11.0
616-
```cmd
616+
```
617+
617618
This script will try to pull the latest .NET Core SDK from [dotnet/runtime](https://github.com/dotnet/runtime) nightly build, which should contain the new API that you just merged in your first PR, and use that to build MicroBenchmarks project and then run the benchmarks that satisfy the filter you provided.
618619

619620
After you have confirmed your benchmarks successfully run locally, then your PR should be ready for performance repo.

src/benchmarks/micro/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ If you contribute to [dotnet/runtime](https://github.com/dotnet/runtime) and wan
5252

5353
```cmd
5454
dotnet run -c Release -f net11.0 --filter $YourFilter \
55-
--corerun C:\git\runtime\artifacts\bin\testhost\net11.0-windows-Release-x64\shared\Microsoft.NETCore.App\11.0.0\CoreRun.exe
55+
--coreRun C:\git\runtime\artifacts\bin\testhost\net11.0-windows-Release-x64\shared\Microsoft.NETCore.App\11.0.0\CoreRun.exe
5656
```
5757

5858
To make sure that your changes don't introduce any regressions, you can provide paths to CoreRuns with and without your changes and use the Statistical Test feature to detect regressions/improvements ([read more](../../../docs/benchmarkdotnet.md#Regressions)):

0 commit comments

Comments
 (0)