Skip to content

Commit

Permalink
Document disabling ApiCompat checks (dotnet#37011)
Browse files Browse the repository at this point in the history
* Document disabling ApiCompat checks
  • Loading branch information
eiriktsarpalis authored May 26, 2020
1 parent a90124f commit 1692e34
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/coding-guidelines/updating-ref-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ This document provides the steps you need to take to update the reference assemb

## For most assemblies within libraries

1. Implement the API in the source assembly and [build it](../workflow/building/libraries/README.md#building-individual-libraries).
1. Implement the API in the source assembly and [build it](../workflow/building/libraries/README.md#building-individual-libraries). Note that when adding new public types, this might fail with a `TypeMustExist` error. The deadlock can be worked around by disabling the `RunApiCompat` property: `dotnet build /p:RunApiCompat=false`.
2. Run the following command (from the src directory) `msbuild /t:GenerateReferenceAssemblySource` to update the reference assembly**.
3. Navigate to the ref directory and build the reference assembly.
4. Add, build, and run tests.
Expand Down

0 comments on commit 1692e34

Please sign in to comment.