Commit 2702ee9e authored by Martin Finkel's avatar Martin Finkel

docs: move and clarify versioning document

parent f3cdc9cf
...@@ -244,7 +244,7 @@ If you have a request or question regarding the roadmap, feel free to open an [i ...@@ -244,7 +244,7 @@ If you have a request or question regarding the roadmap, feel free to open an [i
## Versioning ## Versioning
As this is a libvlc binding, we try to follow the libvlc versioning scheme as much as possible. The versioning strategy is explained in the [VERSIONING](VERSIONING.md) document. As this is a libvlc binding, we try to follow the libvlc versioning scheme as much as possible. The versioning strategy is explained in the [versioning](docs/versioning.md) document.
## Release Notes ## Release Notes
......
...@@ -20,14 +20,7 @@ Some advanced customizations and features are only accessible through LibVLC opt ...@@ -20,14 +20,7 @@ Some advanced customizations and features are only accessible through LibVLC opt
The list of such LibVLC string options can be found here https://wiki.videolan.org/VLC_command-line_help/ The list of such LibVLC string options can be found here https://wiki.videolan.org/VLC_command-line_help/
## LibVLC versions and current status
LibVLC 2.x not supported by VideoLAN, security issues, does not work with LibVLCSharp. ## LibVLC Versioning
LibVLC 3.x current stable version. Check out our [versioning docs](versioning.md).
\ No newline at end of file
LibVLC 4.x current nightly version.
## Relation to LibVLCSharp versioning
Check out our [versioning docs](../versioning.md).
\ No newline at end of file
...@@ -2,6 +2,14 @@ ...@@ -2,6 +2,14 @@
_This strategy applies to all LibVLCSharp [nuget packages](https://www.nuget.org/profiles/videolan) (Forms, etc.)._ _This strategy applies to all LibVLCSharp [nuget packages](https://www.nuget.org/profiles/videolan) (Forms, etc.)._
## LibVLC versions and current status
LibVLC 2.x is **NOT** supported by VideoLAN. Its usage is highly discouraged and there is no support.
LibVLC 3.x is the current stable engine version. This is the recommended version to use and LibVLCSharp works with this.
LibVLC 4.x is the current nightly engine version. LibVLCSharp 4 support is underway.
## Versioning strategy ## Versioning strategy
### We are tied to the libvlc versioning as this binding targets the libvlc public API ### We are tied to the libvlc versioning as this binding targets the libvlc public API
...@@ -11,14 +19,16 @@ This makes it easier for people to understand and use the wrapper with libvlc, o ...@@ -11,14 +19,16 @@ This makes it easier for people to understand and use the wrapper with libvlc, o
#### 0.x versions #### 0.x versions
Initial LibVLCSharp releases were 0.x versions and target libvlc 3. It's getting stable now, though some APIs might still change (notably `VideoView` public API). When we consider it ready, we will move the LibVLCSharp package version to 3.x and 4.x. Initial LibVLCSharp releases were 0.x versions and targetted libvlc 3.
## Long Term Support (LTS) ## Long Term Support (LTS)
### We will maintain up to 2 major libvlc versions at the same time, using 2 different branches, starting with libvlc 3 ### We will maintain up to 2 major libvlc versions at the same time, using 2 different branches, starting with libvlc 3
So when libvlc 4 gets released, we will maintain both LibVLCSharp 3.x and LibVLCSharp 4.x using the same nuget package id. When libvlc 5 lands, it is likely that we remove support for libvlc 3. We will still accept PRs and contributions from the community for older LibVLCSharp versions. So when libvlc 4 gets released, we will maintain both LibVLCSharp 3.x and LibVLCSharp 4.x using the same nuget package id.
When libvlc 5 lands, it is likely that we remove support for libvlc 3. We will however still accept PRs and contributions from the community for older LibVLCSharp versions.
## Breaking changes ## Breaking changes
### Since our major version (i.e. [1].0.0) is tied to the libvlc major version, if we need to introduce breaking changes in the wrapper, we will bump the minor version (i.e. 1.[1].0) and reserve the last number (i.e. 1.1.[1]) for improvements and general maintenance (non breaking API changes). ### Since **our major version (i.e. [1].0.0) is tied to the libvlc major version, if we need to introduce breaking changes in the wrapper, we will bump the minor version (i.e. 1.[1].0)** and reserve the last number (i.e. 1.1.[1]) for improvements and general maintenance (non breaking API changes).
\ No newline at end of file \ No newline at end of file
...@@ -69,7 +69,7 @@ namespace LibVLCSharp.Shared ...@@ -69,7 +69,7 @@ namespace LibVLCSharp.Shared
/// <para/> Ensure that you installed the VideoLAN.LibVLC.[YourPlatform] package in your target project /// <para/> Ensure that you installed the VideoLAN.LibVLC.[YourPlatform] package in your target project
/// <para/> This will throw a <see cref="VLCException"/> if the native libvlc libraries cannot be found or loaded. /// <para/> This will throw a <see cref="VLCException"/> if the native libvlc libraries cannot be found or loaded.
/// <para/> It may also throw a <see cref="VLCException"/> if the LibVLC and LibVLCSharp major versions do not match. /// <para/> It may also throw a <see cref="VLCException"/> if the LibVLC and LibVLCSharp major versions do not match.
/// See https://code.videolan.org/videolan/LibVLCSharp/blob/master/VERSIONING.md for more info about the versioning strategy. /// See https://code.videolan.org/videolan/LibVLCSharp/-/blob/master/docs/versioning.md for more info about the versioning strategy.
/// </summary> /// </summary>
/// <param name="libvlcDirectoryPath">The path to the directory that contains libvlc and libvlccore /// <param name="libvlcDirectoryPath">The path to the directory that contains libvlc and libvlccore
/// No need to specify unless running netstandard 1.1, or using custom location for libvlc /// No need to specify unless running netstandard 1.1, or using custom location for libvlc
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment