diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc index ae9048f1bd5..f8e70f7b616 100644 --- a/.markdownlint.jsonc +++ b/.markdownlint.jsonc @@ -1,12 +1,12 @@ { // MD001/heading-increment : Heading levels should only increment by one level at a time - "MD001": false, + "MD001": true, // MD004/ul-style : Unordered list style "MD004": false, // MD012/no-multiple-blanks : Multiple consecutive blank lines - "MD012": false, + "MD012": true, // MD013/line-length : Line length "MD013": false, @@ -18,26 +18,26 @@ "MD029": false, // MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines - "MD031": false, + "MD031": true, // MD033/no-inline-html : Inline HTML - "MD033": false, + "MD033": true, // MD034/no-bare-urls : Bare URL used "MD034": false, // MD036/no-emphasis-as-heading : Emphasis used instead of a heading - "MD036": false, + "MD036": true, // MD047/single-trailing-newline : Files should end with a single newline character - "MD047": false, + "MD047": true, // MD051/link-fragments : Link fragments should be valid - "MD051": false, + "MD051": true, // MD052/reference-links-images : Reference links and images should use a label that is defined - "MD052": false, + "MD052": true, // MD059/descriptive-link-text : Link text should be descriptive - "MD059": false + "MD059": true } diff --git a/.markdownlintignore b/.markdownlintignore new file mode 100644 index 00000000000..497d3787383 --- /dev/null +++ b/.markdownlintignore @@ -0,0 +1 @@ +eng/common/ diff --git a/docs/benchmarkdotnet.md b/docs/benchmarkdotnet.md index 2d2c018e98e..af09919e302 100644 --- a/docs/benchmarkdotnet.md +++ b/docs/benchmarkdotnet.md @@ -369,7 +369,7 @@ So if you made a change in CLR and want to measure the difference, you can run t dotnet run -c Release -f net48 -- --clrVersion $theVersion ``` -More info can be found [here](https://github.com/dotnet/BenchmarkDotNet/issues/706). +More info can be found in [BenchmarkDotNet issue #706](https://github.com/dotnet/BenchmarkDotNet/issues/706). ### Private CoreRT Build diff --git a/reports/net9to10/README.md b/reports/net9to10/README.md index 8acd2a8c45a..b74932f1ccd 100644 --- a/reports/net9to10/README.md +++ b/reports/net9to10/README.md @@ -52,4 +52,4 @@ The histograms below show the distribution of performance changes across differe ### WASM AOT x64 Linux (Viper) -![WASM AOT x64 Linux Histogram](./linux-wasmaot-viper_histogram.png) \ No newline at end of file +![WASM AOT x64 Linux Histogram](./linux-wasmaot-viper_histogram.png) diff --git a/reports/net9to10/linux-arm64-ampere_improvement_report.md b/reports/net9to10/linux-arm64-ampere_improvement_report.md index 0d60e7e5b19..55042f80d40 100644 --- a/reports/net9to10/linux-arm64-ampere_improvement_report.md +++ b/reports/net9to10/linux-arm64-ampere_improvement_report.md @@ -1,3 +1,5 @@ + + # Improvement Report - linux-arm64-ampere ## >50% Improvement (84 tests) @@ -2102,4 +2104,4 @@ | System.Threading.Channels.Tests.SpscUnboundedChannelPerfTests.ReadAsyncThenWriteAsync | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_arm64_ubuntu%2022.04/System.Threading.Channels.Tests.SpscUnboundedChannelPerfTests.ReadAsyncThenWriteAsync.html) | -5.66% | N/A | N/A | | System.Threading.Tests.Perf_EventWaitHandle.Set_Reset | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_arm64_ubuntu%2022.04/System.Threading.Tests.Perf_EventWaitHandle.Set_Reset.html) | -6.69% | 493.196338 | 460.219472 | | System.Threading.Tests.Perf_Thread.GetCurrentProcessorId | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_arm64_ubuntu%2022.04/System.Threading.Tests.Perf_Thread.GetCurrentProcessorId.html) | -6.66% | 6.463931 | 6.033501 | -| System.Xml.Tests.Perf_XmlConvert.TimeSpan_ToString | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_arm64_ubuntu%2022.04/System.Xml.Tests.Perf_XmlConvert.TimeSpan_ToString.html) | -6.65% | 114.510705 | 106.892926 | \ No newline at end of file +| System.Xml.Tests.Perf_XmlConvert.TimeSpan_ToString | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_arm64_ubuntu%2022.04/System.Xml.Tests.Perf_XmlConvert.TimeSpan_ToString.html) | -6.65% | 114.510705 | 106.892926 | diff --git a/reports/net9to10/linux-arm64-ampere_regression_report.md b/reports/net9to10/linux-arm64-ampere_regression_report.md index ba5fc3cbb53..e561c6e4101 100644 --- a/reports/net9to10/linux-arm64-ampere_regression_report.md +++ b/reports/net9to10/linux-arm64-ampere_regression_report.md @@ -1,3 +1,5 @@ + + # Regression Report - linux-arm64-ampere ## 1. 0fe82fbd8e - Reduce spin-waiting in the thread pool on Arm processors (#115402) @@ -817,4 +819,4 @@ |-----------|------|--------|--------|-------|--------------------| | System.Buffers.Text.Tests.Base64Tests.ConvertToBase64CharArray(NumberOfBytes: 1000) | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_arm64_ubuntu%2022.04/System.Buffers.Text.Tests.Base64Tests.ConvertToBase64CharArray%28NumberOfBytes%3A%201000%29.html) | +11.63% | 263.802434 | 295.922009 | [7](#7-2a2b7dc72b---jit-fix-profile-maintenance-in-optsetblockweights-funclet-creation-111736) | ---- \ No newline at end of file +--- diff --git a/reports/net9to10/linux-mono-tiger_improvement_report.md b/reports/net9to10/linux-mono-tiger_improvement_report.md index e5a6639c190..6710f7fba42 100644 --- a/reports/net9to10/linux-mono-tiger_improvement_report.md +++ b/reports/net9to10/linux-mono-tiger_improvement_report.md @@ -1,3 +1,5 @@ + + # Improvement Report - linux-mono-tiger ## >50% Improvement (24 tests) @@ -699,4 +701,4 @@ | System.Threading.Tests.Perf_Volatile.Read_double | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_LLVM=false_MonoAOT=false_MonoInterpreter=false_RunKind=micro_mono/System.Threading.Tests.Perf_Volatile.Read_double.html) | -5.81% | 0.214282 | 0.201826 | | System.Threading.Tests.Perf_Volatile.Write_double | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_LLVM=false_MonoAOT=false_MonoInterpreter=false_RunKind=micro_mono/System.Threading.Tests.Perf_Volatile.Write_double.html) | -6.47% | 0.273157 | 0.255479 | | System.Xml.Linq.Perf_XDocument.GetElement | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_LLVM=false_MonoAOT=false_MonoInterpreter=false_RunKind=micro_mono/System.Xml.Linq.Perf_XDocument.GetElement.html) | -5.30% | 110.612103 | 104.750359 | -| XmlDocumentTests.XmlNodeListTests.Perf_XmlNodeList.GetCount | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_LLVM=false_MonoAOT=false_MonoInterpreter=false_RunKind=micro_mono/XmlDocumentTests.XmlNodeListTests.Perf_XmlNodeList.GetCount.html) | -5.07% | 13.810264 | 13.110145 | \ No newline at end of file +| XmlDocumentTests.XmlNodeListTests.Perf_XmlNodeList.GetCount | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_LLVM=false_MonoAOT=false_MonoInterpreter=false_RunKind=micro_mono/XmlDocumentTests.XmlNodeListTests.Perf_XmlNodeList.GetCount.html) | -5.07% | 13.810264 | 13.110145 | diff --git a/reports/net9to10/linux-mono-tiger_regression_report.md b/reports/net9to10/linux-mono-tiger_regression_report.md index 7fdcdfab483..42472d79941 100644 --- a/reports/net9to10/linux-mono-tiger_regression_report.md +++ b/reports/net9to10/linux-mono-tiger_regression_report.md @@ -1,3 +1,5 @@ + + # Regression Report - linux-mono-tiger ## 1. da809372c5 - Use UnsafeAccessorType in System.Private.CoreLib and the BCL (#115583) diff --git a/reports/net9to10/linux-monoaot-ampere_improvement_report.md b/reports/net9to10/linux-monoaot-ampere_improvement_report.md index 0d34cbaed65..6460b9edc58 100644 --- a/reports/net9to10/linux-monoaot-ampere_improvement_report.md +++ b/reports/net9to10/linux-monoaot-ampere_improvement_report.md @@ -1,3 +1,5 @@ + + # Improvement Report - linux-monoaot-ampere ## >50% Improvement (13 tests) @@ -474,4 +476,4 @@ | System.Text.Tests.Perf_StringBuilder.Append_Char(length: 100000) | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_arm64_ubuntu%2022.04_LLVM=true_MonoAOT=true_MonoInterpreter=false_RunKind=micro_mono/System.Text.Tests.Perf_StringBuilder.Append_Char%28length%3A%20100000%29.html) | -5.77% | 532567.208177 | 501838.440620 | | System.Threading.Tests.Perf_CancellationToken.CancelAfter | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_arm64_ubuntu%2022.04_LLVM=true_MonoAOT=true_MonoInterpreter=false_RunKind=micro_mono/System.Threading.Tests.Perf_CancellationToken.CancelAfter.html) | -5.53% | 387.250048 | 365.816862 | | System.Threading.Tests.Perf_ThreadStatic.SetThreadStatic | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_arm64_ubuntu%2022.04_LLVM=true_MonoAOT=true_MonoInterpreter=false_RunKind=micro_mono/System.Threading.Tests.Perf_ThreadStatic.SetThreadStatic.html) | -5.85% | 8.429576 | 7.936178 | -| System.Xml.Linq.Perf_XElementList.Enumerator | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_arm64_ubuntu%2022.04_LLVM=true_MonoAOT=true_MonoInterpreter=false_RunKind=micro_mono/System.Xml.Linq.Perf_XElementList.Enumerator.html) | -5.20% | 483.458729 | 458.320795 | \ No newline at end of file +| System.Xml.Linq.Perf_XElementList.Enumerator | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_arm64_ubuntu%2022.04_LLVM=true_MonoAOT=true_MonoInterpreter=false_RunKind=micro_mono/System.Xml.Linq.Perf_XElementList.Enumerator.html) | -5.20% | 483.458729 | 458.320795 | diff --git a/reports/net9to10/linux-monoaot-ampere_regression_report.md b/reports/net9to10/linux-monoaot-ampere_regression_report.md index 7b2590e5d81..edbb6f87152 100644 --- a/reports/net9to10/linux-monoaot-ampere_regression_report.md +++ b/reports/net9to10/linux-monoaot-ampere_regression_report.md @@ -1,3 +1,5 @@ + + # Regression Report - linux-monoaot-ampere ## 1. 4020e05 - Clean up in Number.Formatting.cs (#110955) diff --git a/reports/net9to10/linux-wasm-tiger_improvement_report.md b/reports/net9to10/linux-wasm-tiger_improvement_report.md index 37f4028c6db..85565f0401c 100644 --- a/reports/net9to10/linux-wasm-tiger_improvement_report.md +++ b/reports/net9to10/linux-wasm-tiger_improvement_report.md @@ -1,3 +1,5 @@ + + # Improvement Report - linux-wasm-tiger ## >50% Improvement (305 tests) @@ -816,4 +818,4 @@ | System.Text.RegularExpressions.Tests.Perf_Regex_Common.Date_IsNotMatch(Options: None) | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_CompilationMode=wasm_RunKind=micro/System.Text.RegularExpressions.Tests.Perf_Regex_Common.Date_IsNotMatch%28Options%3A%20None%29.html) | -6.93% | 7499.793580 | 6980.236414 | | System.Text.Tests.Perf_Encoding.GetString(size: 512, encName: "utf-8") | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_CompilationMode=wasm_RunKind=micro/System.Text.Tests.Perf_Encoding.GetString%28size%3A%20512%2C%20encName%3A%20%22utf-8%22%29.html) | -7.35% | 952.017034 | 882.009213 | | System.Threading.Tests.Perf_CancellationToken.CreateRegisterDispose | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_CompilationMode=wasm_RunKind=micro/System.Threading.Tests.Perf_CancellationToken.CreateRegisterDispose.html) | -6.92% | 737.270950 | 686.280534 | -| System.Threading.Tests.Perf_Thread.GetCurrentProcessorId | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_CompilationMode=wasm_RunKind=micro/System.Threading.Tests.Perf_Thread.GetCurrentProcessorId.html) | -5.86% | 21.780073 | 20.503316 | \ No newline at end of file +| System.Threading.Tests.Perf_Thread.GetCurrentProcessorId | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_CompilationMode=wasm_RunKind=micro/System.Threading.Tests.Perf_Thread.GetCurrentProcessorId.html) | -5.86% | 21.780073 | 20.503316 | diff --git a/reports/net9to10/linux-wasm-tiger_regression_report.md b/reports/net9to10/linux-wasm-tiger_regression_report.md index 6fe94e4eebb..a1db67c586b 100644 --- a/reports/net9to10/linux-wasm-tiger_regression_report.md +++ b/reports/net9to10/linux-wasm-tiger_regression_report.md @@ -1,3 +1,5 @@ + + # Regression Report - linux-wasm-tiger ## 1. 4020e05efd - Clean up in Number.Formatting.cs (#110955) diff --git a/reports/net9to10/linux-wasmaot-viper_improvement_report.md b/reports/net9to10/linux-wasmaot-viper_improvement_report.md index f675a6301f7..6726f03b364 100644 --- a/reports/net9to10/linux-wasmaot-viper_improvement_report.md +++ b/reports/net9to10/linux-wasmaot-viper_improvement_report.md @@ -1,3 +1,5 @@ + + # Improvement Report - linux-wasmaot-viper ## >50% Improvement (101 tests) @@ -780,4 +782,4 @@ | System.Text.Json.Tests.Perf_Strings.WriteStringsUtf16(Formatted: True, SkipValidation: False, Escaped: OneEscaped) | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_AOT=true_CompilationMode=wasm_RunKind=micro/ViperUbuntu/System.Text.Json.Tests.Perf_Strings.WriteStringsUtf16%28Formatted%3A%20True%2C%20SkipValidation%3A%20False%2C%20Escaped%3A%20OneEscaped%29.html) | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_AOT=true_CompilationMode=wasm_RunKind=micro/System.Text.Json.Tests.Perf_Strings.WriteStringsUtf16%28Formatted%3A%20True%2C%20SkipValidation%3A%20False%2C%20Escaped%3A%20OneEscaped%29.html) | -5.19% | 20536257.788889 | 19470392.134722 | | System.Text.Json.Tests.Perf_Strings.WriteStringsUtf16(Formatted: True, SkipValidation: True, Escaped: OneEscaped) | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_AOT=true_CompilationMode=wasm_RunKind=micro/ViperUbuntu/System.Text.Json.Tests.Perf_Strings.WriteStringsUtf16%28Formatted%3A%20True%2C%20SkipValidation%3A%20True%2C%20Escaped%3A%20OneEscaped%29.html) | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_AOT=true_CompilationMode=wasm_RunKind=micro/System.Text.Json.Tests.Perf_Strings.WriteStringsUtf16%28Formatted%3A%20True%2C%20SkipValidation%3A%20True%2C%20Escaped%3A%20OneEscaped%29.html) | -5.82% | 20596073.634343 | 19397000.926389 | | System.Text.Perf_Ascii.EqualsIgnoreCase_ExactlyTheSame_Bytes(Size: 6) | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_AOT=true_CompilationMode=wasm_RunKind=micro/ViperUbuntu/System.Text.Perf_Ascii.EqualsIgnoreCase_ExactlyTheSame_Bytes%28Size%3A%206%29.html) | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_AOT=true_CompilationMode=wasm_RunKind=micro/System.Text.Perf_Ascii.EqualsIgnoreCase_ExactlyTheSame_Bytes%28Size%3A%206%29.html) | -5.41% | 16.547468 | 15.651589 | -| System.Text.Perf_Ascii.Equals_Bytes_Chars(Size: 6) | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_AOT=true_CompilationMode=wasm_RunKind=micro/ViperUbuntu/System.Text.Perf_Ascii.Equals_Bytes_Chars%28Size%3A%206%29.html) | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_AOT=true_CompilationMode=wasm_RunKind=micro/System.Text.Perf_Ascii.Equals_Bytes_Chars%28Size%3A%206%29.html) | -7.42% | 16.485580 | 15.261559 | \ No newline at end of file +| System.Text.Perf_Ascii.Equals_Bytes_Chars(Size: 6) | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_AOT=true_CompilationMode=wasm_RunKind=micro/ViperUbuntu/System.Text.Perf_Ascii.Equals_Bytes_Chars%28Size%3A%206%29.html) | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_ubuntu%2022.04_AOT=true_CompilationMode=wasm_RunKind=micro/System.Text.Perf_Ascii.Equals_Bytes_Chars%28Size%3A%206%29.html) | -7.42% | 16.485580 | 15.261559 | diff --git a/reports/net9to10/linux-wasmaot-viper_regression_report.md b/reports/net9to10/linux-wasmaot-viper_regression_report.md index f8d87fabf03..9003987fa33 100644 --- a/reports/net9to10/linux-wasmaot-viper_regression_report.md +++ b/reports/net9to10/linux-wasmaot-viper_regression_report.md @@ -1,3 +1,5 @@ + + # Regression Report - linux-wasmaot-viper ## >50% Regression (45 tests) diff --git a/reports/net9to10/linux-x64-tiger_improvement_report.md b/reports/net9to10/linux-x64-tiger_improvement_report.md index 0003882ea3e..1c8a290fa62 100644 --- a/reports/net9to10/linux-x64-tiger_improvement_report.md +++ b/reports/net9to10/linux-x64-tiger_improvement_report.md @@ -1,3 +1,5 @@ + + # Improvement Report - linux-x64-tiger ## >50% Improvement (109 tests) diff --git a/reports/net9to10/linux-x64-tiger_regression_report.md b/reports/net9to10/linux-x64-tiger_regression_report.md index 807b6e39e58..d781c6fabee 100644 --- a/reports/net9to10/linux-x64-tiger_regression_report.md +++ b/reports/net9to10/linux-x64-tiger_regression_report.md @@ -1,3 +1,5 @@ + + # Regression Report - linux-x64-tiger ## 1. 41be5e229b - JIT: Graph-based loop inversion (#116017) diff --git a/reports/net9to10/windows-x64-tiger_improvement_report.md b/reports/net9to10/windows-x64-tiger_improvement_report.md index bb219d16968..1644079f8d2 100644 --- a/reports/net9to10/windows-x64-tiger_improvement_report.md +++ b/reports/net9to10/windows-x64-tiger_improvement_report.md @@ -1,3 +1,5 @@ + + # Improvement Report - windows-x64-tiger ## >50% Improvement (86 tests) @@ -2385,4 +2387,4 @@ | System.Threading.Tests.Perf_CancellationToken.Cancel | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_Windows%2010.0.22621/System.Threading.Tests.Perf_CancellationToken.Cancel.html) | -5.64% | 100.023866 | 94.384335 | | System.Threading.Tests.Perf_CancellationToken.CreateTokenDispose | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_Windows%2010.0.22621/System.Threading.Tests.Perf_CancellationToken.CreateTokenDispose.html) | -7.25% | 9.671966 | 8.971044 | | System.Threading.Tests.Perf_Monitor.TryEnterExit | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_Windows%2010.0.22621/System.Threading.Tests.Perf_Monitor.TryEnterExit.html) | -5.57% | 22.151044 | 20.918220 | -| System.Xml.Linq.Perf_XDocument.Parse | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_Windows%2010.0.22621/System.Xml.Linq.Perf_XDocument.Parse.html) | -5.13% | N/A | N/A | \ No newline at end of file +| System.Xml.Linq.Perf_XDocument.Parse | [Link](https://pvscmdupload.z22.web.core.windows.net/reports/allTestHistory/refs/heads/main_x64_Windows%2010.0.22621/System.Xml.Linq.Perf_XDocument.Parse.html) | -5.13% | N/A | N/A | diff --git a/reports/net9to10/windows-x64-tiger_regression_report.md b/reports/net9to10/windows-x64-tiger_regression_report.md index bf0bccf2844..7f492807bba 100644 --- a/reports/net9to10/windows-x64-tiger_regression_report.md +++ b/reports/net9to10/windows-x64-tiger_regression_report.md @@ -1,3 +1,5 @@ + + # Regression Report - windows-x64-tiger ## 1. ffcd1c5442 - Trust single-edge synthetic profile (#116054) diff --git a/src/benchmarks/gc/GC.Infrastructure/Notebooks/README.md b/src/benchmarks/gc/GC.Infrastructure/Notebooks/README.md index 079608f07d9..13cdaacb044 100644 --- a/src/benchmarks/gc/GC.Infrastructure/Notebooks/README.md +++ b/src/benchmarks/gc/GC.Infrastructure/Notebooks/README.md @@ -4,7 +4,7 @@ This directory contains notebooks that either provide examples or functionality ## Prerequisites -1. Install the latest version of VSCode from [here](https://code.visualstudio.com/). +1. Install the latest version of [VSCode](https://code.visualstudio.com/). 2. Install the [Polyglot Notebooks](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.dotnet-interactive-vscode) Extension. To learn more about installing Notebook Extensions refer to [this](https://code.visualstudio.com/learn/get-started/extensions) page. ## Examples diff --git a/src/benchmarks/gc/GC.Infrastructure/README.md b/src/benchmarks/gc/GC.Infrastructure/README.md index 6e567b04c39..287f3024989 100644 --- a/src/benchmarks/gc/GC.Infrastructure/README.md +++ b/src/benchmarks/gc/GC.Infrastructure/README.md @@ -17,7 +17,7 @@ This section details the end-to-end workflow associated with getting the infrast 1. Clone the performance repo: ``git clone https://github.com/dotnet/performance C:\performance\``. 2. Install: 1. The Dotnet 7 SDK. - 1. The link to the installers can be found [here](https://dotnet.microsoft.com/en-us/download/dotnet/7.0). + 1. The [Download .NET 7.0 page](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) contains the installers. 2. [crank](https://github.com/dotnet/crank) 1. crank can be installed by invoking: ``dotnet tool install Microsoft.Crank.Controller --version "0.2.0-*" --global``. 3. Ensure that your machine can connected to Corp Net for the ASP.NET Scenarios. You can still run GCPerfSim and Microbenchmark test suites without being connected to Corp Net. @@ -82,7 +82,7 @@ To run GCPerfSim on the ASP.NET Machines, do the following: 2. ``sc.exe create "CrankAgentService" binpath= "%USERPROFILE%\crank-agent.exe --url http://*:5001 --service"``. 2. Then run the crank-agent by invoking ``crank-agent`` locally. -The list of machines you can choose to run the configuration can be found [here](https://github.com/aspnet/Benchmarks/tree/main/scenarios#profiles). +The list of machines you can choose to run the configuration can be found in the [ASP.NET Core Benchmark Scenarios documentation](https://github.com/aspnet/Benchmarks/tree/main/scenarios#profiles). ##### Microbenchmarks @@ -139,7 +139,7 @@ To run the infrastructure on a specific set of ASP.NET Benchmarks, do the follow 1. ``cd C:\performance\artifacts\bin\GC.Infrastructure\Release\net7.0\``. 2. ``.\GC.Infrastructure.exe aspnetbenchmarks --configuration C:\performance\src\benchmarks\gc\GC.Infrastructure\Configurations\ASPNetBenchmarks\ASPNetBenchmarks.yaml``. -More details about running and troubleshooting ASP.NET benchmarks can be found [here](./docs/ASPNETBenchmarks.md). +More details about running and troubleshooting ASP.NET benchmarks can be found in the [ASP.NET Benchmarks guide](./docs/ASPNETBenchmarks.md). ###### Uploading Your Own Binaries @@ -181,7 +181,7 @@ runs: ###### Updating Which Benchmarks to Run -The file that dictates which ASP.NET benchmarks to run is a CSV file and can be configured based on what test you need to run; an example of this file can be found [here](./Configurations/ASPNetBenchmarks/ASPNetBenchmarks.csv). +The file that dictates which ASP.NET benchmarks to run is a CSV file and can be configured based on what test you need to run; an example is provided in [ASPNetBenchmarks.csv](./Configurations/ASPNetBenchmarks/ASPNetBenchmarks.csv). You can update this file by changing the following field: @@ -197,7 +197,7 @@ The format of this file is: where: 1. Legend column should contain the name of the ASP.NET benchmark followed by an underscore and the name of the OS. -2. The Base CommandLine is the base crank command that's run. More details about how to appropriately set this can be found [here](#how-to-add-new-benchmarks). +2. The Base CommandLine is the base crank command that's run. More details about how to appropriately set this can be found in the next section. It's worth noting that if you have specified Linux based binaries in the corerun path, the Windows based ASP.NET benchmarks will exhibit undefined behavior.