# HG changeset patch
# User cannam
# Date 1253616801 0
# Node ID 064ad81ea53c2cc403a0afa69039966548533b18
# Parent  28097c1b3de4271f394a51ba5d1d2bf72fe7dc7d
* Document the errors that can result from plugin load failure

diff -r 28097c1b3de4 -r 064ad81ea53c README
--- a/README	Mon Jun 08 10:08:26 2009 +0000
+++ b/README	Tue Sep 22 10:53:21 2009 +0000
@@ -64,6 +64,47 @@
  The plugin could not be loaded.  Remember that the plugin must be
  installed in the Vamp plugin path.
 
+ Normally this message will be preceded by one of the following
+ errors:
+
+   Invalid plugin key <key>
+
+    - You have perhaps mistyped the argument to vamp-plugin-tester?
+
+   Plugin <id> not found in library <name>
+
+    - The library was found and loaded and was apparently a valid
+      Vamp plugin library, but it didn't contain a plugin of that id.
+      Check you typed the id correctly, and if this is your library,
+      check that the vampGetPluginDescriptor function returns the
+      plugin descriptor properly.
+
+   No valid <name> found in Vamp path
+
+    - No Vamp plugin library of that name was found in the path.
+      This message will often be accompanied by one of the following
+      errors; if it isn't, then that probably means the file did not
+      exist at all.
+
+   Unable to load library <name>
+
+    - A dynamic library of that name was found, but the system library
+      loader could not load it.  Perhaps it depends on another library
+      that is not available, or it was built for the wrong architecture?
+
+   No vampGetPluginDescriptor function found in library <name>
+
+    - A dynamic library of that name was found and loaded, but it
+      lacked the necessary public vampGetPluginDescriptor function.
+
+      * Are you sure this is a Vamp plugin library?
+      * If you made it, did you remember to include the global
+        vampGetPluginDescriptor function in your library along with
+	your plugin classes?
+      * If you are using Visual C++, did you remember to mark the
+        vampGetPluginDescriptor symbol exported, as described in
+        the README.msvc file in the SDK?
+
  ** ERROR: (plugin|parameter|output) identifier <x> contains invalid characters
 
  An identifier contains characters other than the permitted set (ASCII