From: Kern Sibbald Date: Sat, 28 Mar 2009 08:38:57 +0000 (+0000) Subject: Doc tweaks X-Git-Tag: Release-3.0.0~87 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=cc7b048efe58112ea65af912677efaddc2c915e4;p=bacula%2Fbacula Doc tweaks git-svn-id: https://bacula.svn.sourceforge.net/svnroot/bacula/trunk@8616 91ce42f0-d328-0410-95d8-f526ca767f89 --- diff --git a/bacula/release-3-status.txt b/bacula/release-3-status.txt index a9ce67ff89..be17c2627f 100644 --- a/bacula/release-3-status.txt +++ b/bacula/release-3-status.txt @@ -78,12 +78,9 @@ Item 28: Implement an option to modify the last written date for volumes Item n: Split documentation into several books New features needing documentation: -- Update src/plugins/README - command separator in console (!$%&'()*+,-/:;<>?[]^`{|}~) - examples/database/dbcheck.sql - dbport in dbcheck -- filepattern (restore with regex in bsr) -- Allow Mixed Priorities Kjetil Torgrim Homme 30Jun08 - Eliminated license problems with OpenSSL. - The exchange plugin truncates the exchange logs as soon as it has sent the data to the sd. If the sd is spooling and something @@ -91,8 +88,7 @@ New features needing documentation: the logs are lost, which could be a problem under some restore scenarios. - Regex filtered bsrs Kjetil Torgrim Homme 15Aug08 -- Added FD bVarAccurate and bVarFileSeen variables -- Added plugin entrypoint checkFile +- Allow Mixed Priorities Kjetil Torgrim Homme 30Jun08 Code to be completed before 3.0.0 is released: 1. Fix Exchange plugin bugs 1234,1235,1236,1237 @@ -103,10 +99,11 @@ Code to be completed before 3.0.0 is released: - is file deleted (at end of job) - Pass accurate flag to Plugin (* this works) * code implemented not yet intgrated into Exchange plugin -7. Plugin checks +4. Plugin checks + - check plugin version - check plugin entry point definitions - check plugin license, author, ... -8. Install similar files to below ... +5. Install similar files to below ... /usr/share/doc/bat/help (default) Typical /usr/share/doc/xxx changelog.Debian.gz diff --git a/bacula/src/plugins/README b/bacula/src/plugins/README index 6e9112e94d..d5483ec984 100644 --- a/bacula/src/plugins/README +++ b/bacula/src/plugins/README @@ -1,8 +1,12 @@ -This is a first cut of a plugins implementation for Bacula. -The current code is simply a test program named main, which -when executed will load the plugin named plugin.so and then -call it with a few calls, then exit. +This is the plugins implementation for Bacula. +The current plugins for the DIR and SD are untested. +For the File daemon, there are three plugins. The +first is purely experimental. The second is quite functional +and useful -- bpipe, and the third is the Exchange plugin + +For more details on plugins please see the New Features +chapter of the Concepts document. What is implemented: - load a plugin @@ -22,15 +26,10 @@ What is implemented: - Figure out a way to deal with 3 types of plugins (Director, File daemon, Storage daemon). - Pass Version information in plugin Initialize - -What is not yet implemented: - Document the interface - Test Win32 plugins - Print all plugins loaded when Bacula starts - Print all plugins loaded during traceback -- Implement plugin license/version checking -- Some better method to pass variables -- Define more functionality (Bacula entry points, ...) - Make libbac.a into a shared object and allow plugin to call functions in directly so that plugins can use the same "safe" system utilities that Bacula uses. @@ -39,3 +38,9 @@ What is not yet implemented: - Error handling must be much improved and brought into Bacula programming style. It currently just printf()s a message then exits (partially done). + +What is not yet implemented: +- Implement plugin license/version checking +- Some better method to pass variables +- Define more functionality (Bacula entry points, ...) + especially for DIR and SD plugins