Skip to content

Commit e67dd6d

Browse files
authored
Update the documentation around roll forward in the runtime config docs (#31698)
1 parent dcead5c commit e67dd6d

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

documentation/specs/runtime-configuration-file.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -132,10 +132,11 @@ This section is created when building a project. Settings include:
132132
* `System.GC.Server` (old: `gcServer`) - Boolean indicating if the server GC should be used (Default: `true`).
133133
* `System.GC.Concurrent` (old: `gcConcurrent`) - Boolean indicating if background garbage collection should be used.
134134
* `framework` - Indicates the `name`, `version`, and other properties of the shared framework to use when activating the application including `applyPatches` and `rollForwardOnNoCandidateFx`. The presence of this section (or another framework in the new `frameworks` section) indicates that the application is a framework-dependent app.
135-
* `applyPatches` - When `false`, the most compatible framework version previously found is used. When `applyPatches` is unspecified or `true`, the framework from either the same or a higher version that differs only by the patch field will be used. See [roll-forward-on-no-candidate documentation](https://github.com/dotnet/core-setup/blob/main/Documentation/design-docs/roll-forward-on-no-candidate-fx.md) for more information.
136-
* `rollForwardOnNoCandidateFx` - Determines roll-forward behavior. Only applies to `production` releases. Values: 0(Off), 1 (roll forward on [minor] or [patch]), 2 (Roll forward on [major], [minor] or [patch])
137-
See [roll-forward-on-no-candidate documentation](https://github.com/dotnet/core-setup/blob/main/Documentation/design-docs/roll-forward-on-no-candidate-fx.md) for more information.
138-
* `frameworks` - This is an optional array added in 3.0 that allows multiple frameworks to be specified. The `name`, `version`, `applyPatches` and `rollForwardOnNoCandidateFx` properties are available. The `framework` section is no longer necessary in 3.0, but if present is treated as if it was the first framework in the `frameworks` section. The presence of frameworks in this section (or the `framework` section) indicates that the application is a framework-dependent app. See the notes at the end of this document for more information.
135+
* `rollForward` - Introduced in .NET Core 3.0. Determines roll-forward behavior. Values: `LatestPatch`, `Minor`, `Major`, `LatestMinor`, `LatestMajor`, `Disable`. See [high-level design](https://github.com/dotnet/designs/blob/main/accepted/2019/runtime-binding.md#rollforward) and [detailed design](https://github.com/dotnet/runtime/blob/main/docs/design/features/framework-version-resolution.md) for more information.
136+
* `applyPatches` - **Deprecated in favor of `rollForward`**, please use `rollForward` property instead. When `false`, the most compatible framework version previously found is used. When `applyPatches` is unspecified or `true`, the framework from either the same or a higher version that differs only by the patch field will be used. See [roll-forward-on-no-candidate documentation](https://github.com/dotnet/runtime/blob/main/docs/design/features/roll-forward-on-no-candidate-fx.md) for more information.
137+
* `rollForwardOnNoCandidateFx` - **Deprecated in favor of `rollForward`**, please use `rollForward` property instead - Determines roll-forward behavior. Only applies to `production` releases. Values: 0(Off), 1 (roll forward on [minor] or [patch]), 2 (Roll forward on [major], [minor] or [patch])
138+
See [roll-forward-on-no-candidate documentation](https://github.com/dotnet/runtime/blob/main/docs/design/features/roll-forward-on-no-candidate-fx.md) for more information.
139+
* `frameworks` - This is an optional array added in 3.0 that allows multiple frameworks to be specified. The `name`, `version`, `rollForward` (.NET Core 3.0 +), `applyPatches` (deprecated) and `rollForwardOnNoCandidateFx` (deprecated) properties are available. The `framework` section is no longer necessary in 3.0, but if present is treated as if it was the first framework in the `frameworks` section. The presence of frameworks in this section (or the `framework` section) indicates that the application is a framework-dependent app. See the notes at the end of this document for more information.
139140
* `additionalProbingPaths` - Optional property which specifies additional paths to consider when looking for dependencies. The value is either a single string, or an array of strings.
140141
* `tfm` - Optional string value which specifies the Target Framework Moniker.
141142

0 commit comments

Comments
 (0)