Skip to content

Commit

Permalink
Update docs after repos merge (#1132)
Browse files Browse the repository at this point in the history
* don't ignore pfx files, we have few of them in these repo (certificate files used by networking benchmarks)

* change folder structure: corefx -> libraries, coreclr -> runtime

* change categories names

* update prerequisites docs

* update benchmarkdotnet docs

* update the microbenchmark design guidelines docs

* update the Microbenchmarks readme page docs

* update profiling workflow docs

* update benchmarking workflow docs

* remove old benchmarking workflow doc

* update README.md to point to the new docs

* Apply suggestions from code review

Co-Authored-By: Bill Wert <[email protected]>

* revert accidental TFM removal

* dotnet runtime -> dotnet/runtime

* update the categories description

* change Categories names for real

Co-authored-by: Bill Wert <[email protected]>
  • Loading branch information
adamsitnik and billwert authored Jan 17, 2020
1 parent dfab3ae commit 8aed638
Show file tree
Hide file tree
Showing 474 changed files with 451 additions and 820 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,6 @@ ClientBin/
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs

Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ Finding these benchmarks in a separate repository might be surprising. Performan

* [Microbenchmarks Guide](./src/benchmarks/micro/README.md) for information on running our microbenchmarks
* [Real-World Scenarios Guide](./src/benchmarks/real-world/JitBench/README.md) for information on running our real-world scenario benchmarks
* [Benchmarking workflow for CoreFX](./docs/benchmarking-workflow-corefx.md) for information on working with CoreFX
* [Benchmarking workflow for dotnet/runtime repository](./docs/benchmarking-workflow-dotnet-runtime.md) for information on benchmarking local [dotnet/runtime](https://github.com/dotnet/runtime) builds
* [Profiling workflow for dotnet/runtime repository](./docs/profiling-workflow-dotnet-runtime.md) for information on profiling local [dotnet/runtime](https://github.com/dotnet/runtime) builds

## Contributing to Repository

Expand Down
22 changes: 11 additions & 11 deletions azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ jobs:
pool: Hosted VS2017
queue: Windows.10.Amd64.ClientRS5.Open
csproj: src\benchmarks\micro\MicroBenchmarks.csproj
runCategories: 'coreclr corefx'
runCategories: 'runtime libraries'
channels:
- master
- release/3.1.2xx
Expand All @@ -103,7 +103,7 @@ jobs:
pool: Hosted VS2017
queue: Windows.10.Amd64.ClientRS4.DevEx.15.8.Open
csproj: src\benchmarks\micro\MicroBenchmarks.csproj
runCategories: 'coreclr corefx'
runCategories: 'runtime libraries'
channels: # for public jobs we want to make sure that the PRs don't break any of the supported frameworks
- LTS # use LTS channel for net461 framework

Expand All @@ -117,7 +117,7 @@ jobs:
pool: Hosted VS2017
queue: Windows.10.Amd64.ClientRS5.Open
csproj: src\benchmarks\micro\MicroBenchmarks.csproj
runCategories: 'coreclr corefx'
runCategories: 'runtime libraries'
channels: # for public jobs we want to make sure that the PRs don't break x86
- master

Expand Down Expand Up @@ -162,7 +162,7 @@ jobs:
queue: Ubuntu.1804.Amd64.Open
container: ubuntu_x64_build_container
csproj: src/benchmarks/micro/MicroBenchmarks.csproj
runCategories: 'coreclr corefx'
runCategories: 'runtime libraries'
channels: # for public jobs we want to make sure that the PRs don't break any of the supported frameworks
- master
- release/3.1.2xx
Expand Down Expand Up @@ -232,7 +232,7 @@ jobs:
pool: Hosted VS2017
queue: Windows.10.Amd64.19H1.Tiger.Perf # using a dedicated private Helix queue (perftigers)
csproj: src\benchmarks\micro\MicroBenchmarks.csproj
runCategories: 'coreclr corefx'
runCategories: 'runtime libraries'
channels: # for private jobs we want to benchmark .NET Core 3.0 and 5.0 only
- master
- release/3.1.2xx
Expand All @@ -247,7 +247,7 @@ jobs:
pool: Hosted VS2017
queue: Windows.10.Amd64.19H1.Tiger.Perf # using a dedicated private Helix queue (perftigers)
csproj: src\benchmarks\micro\MicroBenchmarks.csproj
runCategories: 'coreclr corefx'
runCategories: 'runtime libraries'
channels: # for private jobs we want to benchmark .NET Core 3.0 and 5.0 only
- master
- release/3.1.2xx
Expand Down Expand Up @@ -293,7 +293,7 @@ jobs:
queue: Ubuntu.1804.Amd64.Tiger.Perf # using a dedicated private Helix queue (perftigers)
container: ubuntu_x64_build_container
csproj: src/benchmarks/micro/MicroBenchmarks.csproj
runCategories: 'coreclr corefx'
runCategories: 'runtime libraries'
channels: # for private jobs we want to benchmark .NET Core 3.0 and 5.0 only
- master
- release/3.1.2xx
Expand Down Expand Up @@ -361,7 +361,7 @@ jobs:
pool: Hosted VS2017
queue: Windows.10.Amd64.ClientRS1.Perf # using a dedicated private Helix queue (perfsnakes)
csproj: src\benchmarks\micro\MicroBenchmarks.csproj
runCategories: 'coreclr corefx'
runCategories: 'runtime libraries'
channels: # for private jobs we want to benchmark .NET Core 5.0 and 3.1
- master
- release/3.1.2xx
Expand All @@ -376,7 +376,7 @@ jobs:
pool: Hosted VS2017
queue: Windows.10.Amd64.ClientRS1.Perf # using a dedicated private Helix queue (perfsnakes)
csproj: src\benchmarks\micro\MicroBenchmarks.csproj
runCategories: 'coreclr corefx'
runCategories: 'runtime libraries'
channels: # for private jobs we want to benchmark .NET Core 5.0 and 3.1
- master
- release/3.1.2xx
Expand Down Expand Up @@ -422,7 +422,7 @@ jobs:
queue: Ubuntu.1604.Amd64.Perf # using a dedicated private Helix queue (perfsnakes)
container: ubuntu_x64_build_container
csproj: src/benchmarks/micro/MicroBenchmarks.csproj
runCategories: 'coreclr corefx'
runCategories: 'runtime libraries'
channels: # for private jobs we want to benchmark .NET Core 5.0 and 3.1
- master
- release/3.1.2xx
Expand Down Expand Up @@ -470,7 +470,7 @@ jobs:
queue: Ubuntu.1804.Arm64.Perf
container: ubuntu_x64_build_container
csproj: src/benchmarks/micro/MicroBenchmarks.csproj
runCategories: 'coreclr corefx'
runCategories: 'runtime libraries'
channels: # for private jobs we want to benchmark .NET Core 5.0 and 3.1
- master
- release/3.1.2xx
Expand Down
2 changes: 1 addition & 1 deletion docs/benchmarkdotnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ Please use this option only when you are sure that the benchmarks you want to ru

### CoreRun

It's possible to benchmark private builds of CoreCLR/FX using CoreRun.
It's possible to benchmark private builds of [dotnet/runtime](https://github.com/dotnet/runtime) using CoreRun.

```cmd
dotnet run -c Release -f netcoreapp3.0 --coreRun $thePath
Expand Down
Loading

0 comments on commit 8aed638

Please sign in to comment.