Skip to content
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

Clarify build configs and full trimming #2688

Merged
merged 2 commits into from
Dec 20, 2024
Merged

Clarify build configs and full trimming #2688

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef38b48
Clarify build configs and full trimming.
davidbritch Dec 20, 2024
c706410
Edit.
davidbritch Dec 20, 2024
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
6 changes: 3 additions & 3 deletions docs/deployment/trimming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Trimming behavior can be controlled by setting the `$(TrimMode)` build property
```

> [!IMPORTANT]
> The `$(TrimMode)` build property shouldn't be conditioned by build configuration. This is because features switches are enabled or disabled based on the value of the `$(TrimMode)` build property, and the same features should be enabled or disabled in all build configurations so that your code behaves identically.
> Don't set the `$(TrimMode)` build property when using Native AOT deployment, which automatically performs full trimming of your app. For more information, see [Native AOT deployment on iOS and Mac Catalyst](nativeaot.md).

The `full` trim mode removes any code that's not used by your app. The `partial` trim mode trims the base class library (BCL), assemblies for the underlying platforms (such as *Mono.Android.dll* and *Microsoft.iOS.dll*), and any other assemblies that have opted into trimming with the `$(TrimmableAsssembly)` build item:

Expand All @@ -35,10 +35,10 @@ The `full` trim mode removes any code that's not used by your app. The `partial`

This is equivalent to setting `[AssemblyMetadata("IsTrimmable", "True")]` when building the assembly.

In a .NET MAUI app, it's not necessary to set the `$(PublishTrimmed)` build property to `true` in your app's project file, because this is set by default.
Full trimming shouldn't be conditioned by build configuration. This is because features switches are enabled or disabled based on the value of the `$(TrimMode)` build property, and the same features should be enabled or disabled in all build configurations so that your code behaves identically.

> [!NOTE]
> Don't set the `$(TrimMode)` build property when using Native AOT deployment. Native AOT deployment automatically performs full trimming of your app. For more information, see [Native AOT deployment on iOS and Mac Catalyst](nativeaot.md).
> In a .NET MAUI app, it's not necessary to set the `$(PublishTrimmed)` build property to `true` in your app's project file, because this is set by default.

For more trimming options, see [Trimming options](/dotnet/core/deploying/trimming/trimming-options).

Expand Down
Loading