From 4d784693ebc5f91c7eede32170046355ef3969b2 Mon Sep 17 00:00:00 2001 From: Eric Erhardt Date: Mon, 31 Aug 2020 19:56:28 -0500 Subject: [PATCH] Updating ref source documentation for full facades (#41629) --- docs/coding-guidelines/updating-ref-source.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/coding-guidelines/updating-ref-source.md b/docs/coding-guidelines/updating-ref-source.md index a906f97..a0599fa 100644 --- a/docs/coding-guidelines/updating-ref-source.md +++ b/docs/coding-guidelines/updating-ref-source.md @@ -3,7 +3,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). 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**. +2. Run the following command (from the src directory) `dotnet 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. @@ -15,3 +15,11 @@ These steps can also be applied to some unique assemblies which depend on change 1) Run `dotnet build --no-incremental /t:GenerateReferenceSource` from the System.Runtime/src directory. 2) Filter out all unrelated changes and extract the changes you care about (ignore certain attributes being removed). Generally, this step is not required for other reference assemblies. + +## For Full Facade Assemblies + +For assemblies that are "full facades" over another assembly (ex. System.Runtime.Serialization.Json or System.Xml.XDocument), use the following command to generate the reference source code instead: + +``` +dotnet msbuild /t:GenerateReferenceAssemblySource /p:GenAPIAdditionalParameters=--follow-type-forwards +``` -- 2.7.4