Skip to content

Composite ReadyToRun - clarify enabling conditions #55899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fowl2 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Composite ReadyToRun - clarify enabling conditions #55899

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions docs/core/deploying/ready-to-run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,18 @@ These symbols will be placed in the publish directory and for Windows will have

## Composite ReadyToRun

Normal ReadyToRun compilation produces binaries that can be serviced and manipulated individually. Starting in .NET 6, support for Composite ReadyToRun compilation has been added. Composite ReadyToRun compiles a set of assemblies that must be distributed together. This has the advantage that the compiler is able to perform better optimizations and reduces the set of methods that cannot be compiled via the ReadyToRun process. However, as a tradeoff, compilation speed is significantly decreased, and the overall file size of the application is significantly increased. Due to these tradeoffs, use of Composite ReadyToRun is only recommended for applications that disable [Tiered Compilation](../runtime-config/compilation.md#tiered-compilation) or applications running on Linux that are seeking the best startup time with [self-contained](index.md#publish-as-self-contained) deployment. To enable composite ReadyToRun compilation, specify the `<PublishReadyToRunComposite>` property.
Normal ReadyToRun compilation produces assemblies that can be serviced and deployed individually. Composite ReadyToRun compiles a set of assemblies together, allowing the compiler to perform additional optimizations and compile more methods ahead of time.

Composite ReadyToRun has the following tradeoffs:

- Compilation takes significantly longer.
- The application is significantly larger.
- Only [self-contained](index.md#publish-as-self-contained) deployments are supported.
- The compiled assemblies must be distributed together.

Composite ReadyToRun is supported in .NET 6 and later. In .NET 7 and later, it's enabled by default for self-contained [single-file](single-file/overview.md) deployments that use ReadyToRun.

To enable composite ReadyToRun explicitly, set `PublishReadyToRunComposite` to `true`:

```xml
<PropertyGroup>
Expand All @@ -92,7 +103,7 @@ Normal ReadyToRun compilation produces binaries that can be serviced and manipul
```

> [!NOTE]
> In .NET 6, Composite ReadyToRun is only supported for [self-contained](index.md#publish-as-self-contained) deployment.
> `PublishReadyToRunComposite` is ignored if the deployment is not [self-contained](index.md#publish-as-self-contained).

## Cross platform/architecture restrictions

Expand Down
Loading