vdr/vdr/debian README.Debian

[Tobias Grimm]

Update of /cvsroot/pkg-vdr-dvb/vdr/vdr/debian
In directory haydn:/tmp/cvs-serv7295

Modified Files:
	README.Debian 
Log Message:
added documentation for optional packages

Index: README.Debian
===================================================================
RCS file: /cvsroot/pkg-vdr-dvb/vdr/vdr/debian/README.Debian,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- README.Debian	15 Jul 2004 21:28:49 -0000	1.8
+++ README.Debian	1 Aug 2004 10:41:18 -0000	1.9
@@ -152,6 +152,36 @@
 Optional Patches
 ----------------
 
-TODO !!!!
+A lot of VDR enthusiasts have improved VDR by creating patches that fix
+existing problems or add new functionality. Some of these patches may not work
+for everyone, so we decided to make them optional. This means, that these
+patches are only included as dpatch files in the vdr source package, NOT in
+the binary packages. They are named opt-<nn>_<patch name>, where <nn> is a
+two-digit-number and <patch name> a unique identifier. To enable a patch, just
+uncomment it in debian/patches/00list and recompile vdr.
+
+Most of these optional patches modify the interfaces used by the plugins. This
+means, that the plugins become binary incompatible. If you activate/deactivate
+patches in the vdr package, all plugins must be recompiled with the new vdr-dev
+package! There is only one exception from this rule - patches named 
+opt-<nn>-x_<patch name> do not affect the plugin interfaces and can therefore 
+be enabled or disabled without the need to recompile the plugins.
+
+If you decide to compile your own patched vdr packages, you should set
+PLUGIN_CHECK_PATCHLEVEL="yes" in /etc/default/vdr. With this enabled, vdr
+will only load plugins, that have been compiled with the correct vdr patch. This
+checking is done by using a custom control field called "vdr-patchlevel". When
+compiling vdr with some optional patches enabled, these patches will be listed
+in this control field and added to vdr-dev as /usr/include/vdr/patchlevel.
+When compiling a plugin, this patchlevel file is added as the "vdr-patchlevel"
+control field to the plugins binary package. By comparing the "vdr-patchlevel"
+field of vdr and the plugin packages, the vdr package can decide whether to
+load a plugin or not.
+
+Keep in mind, that if you enable any optional patches, you can't use apt-get
+anymore on the official Debian repositories to update existing vdr or plugin
+packages or install additional plugins. You always have to compile the plugins
+yourself! The optional patches are mainly intended for people who would like to
+create their own customized vdr distribution.
 
  -- Tobias Grimm <tg@e-tobi.net>,  Thu, 3 Jun 2004 02:20:00 +0100