diff --git a/lib/App/Netdisco/Worker/Plugin.pm b/lib/App/Netdisco/Worker/Plugin.pm index 1cbbba68..8d0e4759 100644 --- a/lib/App/Netdisco/Worker/Plugin.pm +++ b/lib/App/Netdisco/Worker/Plugin.pm @@ -112,7 +112,7 @@ combining those transports with application protocols such as SNMP, NETCONF scraping. The combination of transport and protocol is known as a I. Workers can be restricted to certain vendor platforms using familiar ACL -syntax. They are also attached to specific phases in Netdisco's backend +syntax. They are also attached to specific actions in Netdisco's backend operation (discover, macsuck, etc). =head1 Application Configuration @@ -126,13 +126,13 @@ C distribution. =head1 How to Configure -The C setting is empty, and used only if you want to add -new plugins but not change the set enabled by default. If you do want to add +The C setting is empty, and used when you want to add +new plugins and not change the set enabled by default. If you do want to add to or remove from the default set, then create a version of C instead. Netdisco prepends "C" to any entry in the -list. For example, "C" will load the +list. For example, "C" will load the C package. You can prepend module names with "C" as shorthand for the "Netdisco @@ -142,20 +142,23 @@ module. If an entry in the list starts with a "C<+>" (plus) sign then Netdisco attemps to load the module as-is, without prepending anything to the name. This allows -you to have App::Netdisco Worker plugins in other namespaces. +you to have worker plugins in any namespace. Plugin modules can either ship with the App::Netdisco distribution itself, or be installed separately. Perl uses the standard C<@INC> path searching mechanism to load the plugin modules. See the C and C settings in order to modify C<@INC> for loading local -plugins. As an example, if your plugin is called -"App::NetdiscoX::Worker::Plugin::MyPluginName" then it could live at: +plugins. + +As an example, if you set C to be true, set +C to be C<'X::MyPluginName'> (the plugin package is +"App::NetdiscoX::Worker::Plugin::MyPluginName") then your plugin lives at: ~netdisco/nd-site-local/lib/App/NetdiscoX/Worker/Plugin/MyPluginName.pm The order of the entries is significant, workers being executed in the order -which they appear in C and C (although -see L for caveats). +which they appear in C followed by C. +See L for further details. =cut