Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.61 KB

updating-ref-source.md

File metadata and controls

18 lines (13 loc) · 1.61 KB
Raw

This document provides the steps you need to take to update the reference assembly when adding new public APIs to an implementation assembly (post API Review).

For most assemblies within libraries

  1. Implement the API in the source assembly and build it.
  2. Run the following command (from the src directory) msbuild /t:GenerateReferenceSource to update the reference assembly**.
  3. Navigate to the ref directory and build the reference assembly.
  4. Add, build, and run tests.

** Note: If you already added the new API to the reference source, re-generating it (after building the source assembly) will update it to be fully qualified and placed in the correct order. This can be done by running the GenerateReferenceSource command from the ref directory.

For System.Runtime

These steps can also be applied to some unique assemblies which depend on changes in System.Private.Corelib coming from coreclr (partial facades like System.Memory, for example).

  1. Build coreclr release.
  2. Build corefx release with coreclr bits (see (// TODO //)) for more details).
  3. Run msbuild /t:GenerateReferenceSource /p:ConfigurationGroup=Release from the System.Runtime/ref directory.
  4. 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.