mirror of
https://github.com/VSadov/Satori.git
synced 2025-06-08 11:37:04 +09:00
9900dfb4b2
* Move files into hierarchy * fix more links * Fix botr and features links * Remove bad apostrophe * spelling * Apply suggestions from code review Co-Authored-By: Youssef Victor <31348972+Youssef1313@users.noreply.github.com> * Update docs/coding-guidelines/package-projects.md Co-Authored-By: Jan Kotas <jkotas@microsoft.com> Co-authored-by: Youssef Victor <31348972+Youssef1313@users.noreply.github.com> Co-authored-by: Jan Kotas <jkotas@microsoft.com>
18 lines
1.6 KiB
Markdown
18 lines
1.6 KiB
Markdown
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](adding-api-guidelines.md)).
|
|
|
|
## For most assemblies within libraries
|
|
|
|
1. Implement the API in the source assembly and [build it](../workflow/building/libraries/README.md#building-individual-libraries).
|
|
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](https://github.com/dotnet/coreclr) (partial facades like [System.Memory](https://github.com/dotnet/corefx/blob/83711167ee74d2e87cf2d5ed3508c94044bb7edc/src/System.Memory/src/System.Memory.csproj#L6), 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.
|