Skip to content

Commit

Permalink
Add note on WarningsAsErrors (dotnet#81451)
Browse files Browse the repository at this point in the history
  • Loading branch information
MichalStrehovsky committed Feb 1, 2023
1 parent 9e05d33 commit 9459ac6
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/workflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,7 @@ And how to measure performance:

* [Benchmarking workflow for dotnet/runtime repository](https://github.com/dotnet/performance/blob/master/docs/benchmarking-workflow-dotnet-runtime.md)
* [Profiling workflow for dotnet/runtime repository](https://github.com/dotnet/performance/blob/master/docs/profiling-workflow-dotnet-runtime.md)

## Warnings as Errors

The repo build treats warnings as errors. Dealing with warnings when you're in the middle of making changes can be annoying (e.g. unused variable that you plan to use later). To disable treating warnings as errors, set the `WarningsAsErrors` environment variable to `false` before building. This variable will be respected by both the `build.sh`/`build.cmd` root build scripts and builds done with `dotnet build` or Visual Studio. Some people may prefer setting this environment variable globally in their machine settings.

0 comments on commit 9459ac6

Please sign in to comment.