From 34aa8fe8b48a60fcc84456212a46e38989be6de4 Mon Sep 17 00:00:00 2001 From: Klaus Schmidinger Date: Wed, 12 Feb 2025 22:02:25 +0100 Subject: [PATCH] Adjusted PLUGINS.html to the new API version numbering introduced in version 2.7.2 --- HISTORY | 1 + PLUGINS.html | 17 ++++++++--------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/HISTORY b/HISTORY index 6b153f2e..2b3ceffd 100644 --- a/HISTORY +++ b/HISTORY @@ -10078,3 +10078,4 @@ Video Disk Recorder Revision History to Markus Ehrnsperger). Plugins that implemented cStatus::OsdStatusMessage() will still work as before, because the default implementation of cStatus::OsdStatusMessage2() calls cStatus::OsdStatusMessage(). +- Adjusted PLUGINS.html to the new API version numbering introduced in version 2.7.2. diff --git a/PLUGINS.html b/PLUGINS.html index 668ff25e..ae11a165 100644 --- a/PLUGINS.html +++ b/PLUGINS.html @@ -166,7 +166,7 @@ is used: VDR/PLUGINS/src VDR/PLUGINS/src/hello VDR/PLUGINS/lib -VDR/PLUGINS/lib/libvdr-hello.so.1.1.0 +VDR/PLUGINS/lib/libvdr-hello.so.1

The src directory contains one subdirectory for each plugin, which carries @@ -185,7 +185,7 @@ The lib directory contains the dynamically loadable libraries of all available plugins. Note that the names of these files are created by concatenating

- +
libvdr-hello.so.1.1.0
libvdr-hello.so.1
VDR plugin
library prefix		name of
the plugin		shared object
indicator		API version number
this plugin was
compiled for

@@ -196,6 +196,11 @@ the current VDR version. That way minor fixes to VDR, that don't require changes to the VDR header files, can be made without requiring all plugins to be recompiled.

+While in earlier versions of VDR the API version number was closely related to the +VDR version number, starting with VDR version 2.7.2 the API version number was changed +from a dot separated, three part number to a single integer, completely unrelated to +the VDR version. This was done to avoid confusion. +

The plugin library files can be stored in any directory. If the default organization is not used, the path to the plugin directory has be be given to VDR through the -L option. @@ -391,13 +396,7 @@ just like shown in the above example. This is a convention that allows the M to extract the version number when generating the file name for the distribution archive.

A new plugin project should start with version number 0.0.1 and should reach -version 1.0.0 once it is completely operative and well tested. Following the -Linux kernel version numbering scheme, versions with even release numbers -(like 1.0.x, 1.2.x, 1.4.x...) should be stable releases, -while those with odd release numbers (like 1.1.x, 1.3.x, -1.5.x...) are usually considered "under development". The three parts of -a version number are not limited to single digits, so a version number of 1.2.15 -would be acceptable. +version 1.0.0 once it is completely operative and well tested.

Description