diff --git a/RELEASES.md b/RELEASES.md index 00f119398006..7f7cfa8e6ce1 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -43,7 +43,14 @@ ([#1797](https://github.com/enso-org/enso/pull/1797)). The `engine-version` field has been deprecated in favour of an `edition` field that allows to set up the engine version and dependency resolution using the upcoming Edition - system. + system. New tools will still be able to read the old format, but upon + modification, they will save changes in the new format. As the `edition` file + did not exist in the older version, old tools will actually correctly load the + migrated package file (as we allow for unknown fields), but they will not know + how to interpret the new `edition` field and so will fall back to using the + `default` engine version, which may be unexpected. Ideally, after migration, + the project should be used only with the new tools. The affected tools are the + Launcher and the Project Manager. ## Libraries diff --git a/docs/libraries/editions.md b/docs/libraries/editions.md index c0a873a88cd3..0e22a60a169a 100644 --- a/docs/libraries/editions.md +++ b/docs/libraries/editions.md @@ -26,9 +26,9 @@ This document describes the concept of Editions. ## What Is An Edition -An Edition is in principle a list of library versions that should be compatible -with each other. An Edition specifies the engine version and a set of library -versions that can be used together. +An Edition, is in principle, a list of library versions that should be +compatible with each other. An Edition specifies the engine version and a set of +library versions that can be used together. If a library included in an Edition depends on another library, that other library must also be included in that Edition and the version at which it is @@ -57,9 +57,9 @@ The Edition file is a YAML file that can contain the following fields: [Library Resolution](#library-resolution) for details); if it is not set, it defaults to false. -Every field is optional, but an Edition file to be valid must specify at least -the engine version to be used (either by specifying it directly or extending -another edition that specifies it). +Every field is optional, but for an Edition file to be valid it must specify at +least the engine version to be used (either by specifying it directly or +extending another edition that specifies it). ### Repositories