Skip to content

Add API and language version to backwards compatibility section#52

Open
sarahhaggarty wants to merge 1 commit into
mainfrom
api-and-lang-version
Open

Add API and language version to backwards compatibility section#52
sarahhaggarty wants to merge 1 commit into
mainfrom
api-and-lang-version

Conversation

@sarahhaggarty

Copy link
Copy Markdown
Collaborator

This PR adds details about checking compatibility of API and language versions to the backwards compatibility section.

version of the Kotlin standard library.

For the JVM, a library compiled with a given language and API version is compatible with that version and the next later version.
For example, if you configure version 2.1, consumers can compile against and run the library with Kotlin 2.1.0 – 2.2.0.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For example, if you configure languge version 2.3 and api version 2.1, consumers would need to use Kotlin 2.2.0 or newer to compile code using your library, and would need to provide Kotlin standard library 2.1.0 or newer at runtime to run it.


For the JVM, a library compiled with a given language and API version is compatible with that version and the next later version.
For example, if you configure version 2.1, consumers can compile against and run the library with Kotlin 2.1.0 – 2.2.0.
On other platforms, a library compiled with a given language and API version is only compatible with that version.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On other platform LV/AV don't affect compatibility, you always need to be at least same major version (i.e. 2.2.20 vs 2.2 is fine, but 2.3 vs 2.2.20 is not).

There is an initiaive on proper support of LV - KT-76131. Not sure if we should mention it, as it's now a bit shelved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants