From a5c2af72778b26b5b51fc9327bb4f5e01b5ed2da Mon Sep 17 00:00:00 2001 From: Klaus Schmidinger Date: Fri, 17 May 2002 16:29:02 +0200 Subject: Makefile improvements --- PLUGINS.html | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) (limited to 'PLUGINS.html') diff --git a/PLUGINS.html b/PLUGINS.html index 5098ace6..6caff0e8 100644 --- a/PLUGINS.html +++ b/PLUGINS.html @@ -16,12 +16,15 @@ This document describes the "outside" interface of the plugin system. It handles everything necessary for a plugin to get hooked into the core VDR program and present itself to the user.

-
  +
  Important modifications introduced in version 1.1.1 are marked like this.
-
  +
  Important modifications introduced in version 1.1.2 are marked like this.
+
  +Important modifications introduced in version 1.1.3 are marked like this. +

Quick start

@@ -117,7 +120,7 @@ from the web, it will typically have a name like

and will unpack into a directory named

-
  +
  hello-0.0.1

@@ -125,7 +128,7 @@ To use the plugins and plugins-clean targets from the VDR you need to unpack such an archive into the VDR/PLUGINS/src directory and create a symbolic link with the basic plugin name, as in -
  +
  



 ln -s hello-0.0.1 hello

@@ -191,7 +194,7 @@ its memory. You don't need to worry about the details behind all this. If your plugin requires additional source files, simply add them to your plugin's source directory and adjust the Makefile accordingly.

-
  +
  Header files usually contain preprocessor statements that prevent the same file (or rather its contents, to be precise) from being included more than once, like @@ -410,7 +413,7 @@ If a plugin implements a function that runs in the background (presumably in a thread of its own), or wants to make use of internationalization, it needs to implement the function -
  +
  



 virtual bool Start(void);

@@ -422,7 +425,7 @@ its task. This may, for instance, be a thread that collects data from the DVB stream, which is later presented to the user via a function that is available from the main menu.

-
  +
  A return value of false indicates that something has gone wrong and the plugin will not be able to perform its task. In that case, the plugin should write a proper error message to the log file. The first plugin that returns @@ -486,7 +489,7 @@ interaction is possible. If a specific action takes longer than a few seconds, the plugin should launch a separate thread to do this. -
  +
 

Housekeeping

Chores, chores...

@@ -533,7 +536,7 @@ previously stored in the global setup data (see below). It shall return true if the parameter was parsed correctly, false in case of an error. If false is returned, an error message will be written to the log file (and program execution will continue). -
  +
  A possible implementation of SetupParse() could look like this: 



@@ -588,7 +591,7 @@ needs setup parameters that are not directly user adjustable. It can use
 SetupStore() and SetupParse() without presenting these
 parameters to the user.
 
-
 
+
 
 
The Setup menu

 
 
Have it your way!

@@ -648,7 +651,7 @@ your setup parameters and use that one to copy all parameters with one single st
 (like VDR does with its cSetup class).
 

 
-
 
+
 
 
Configuration files

 
 
I want my own stuff!

@@ -815,16 +818,18 @@ and display their help and/or version information in addition to its own output.
 
 If you want to make your plugin available to other VDR users, you'll need to
 make a package that can be easily distributed.
+
 
 The Makefile that has been created by the call to
 newplugin
-provides the target package, which does this for you.
+provides the target dist, which does this for you.
 

-Simply change into your source directory and execute make package:
+Simply change into your source directory and execute make dist:
 
 


 cd VDR/PLUGINS/src/hello
-make package
+make dist
 

+

 
 After this you should find a file named like
 
-- 
cgit v1.2.3