- "\n"
- "Flushes the cache of another plugin.";
-
-static char unregister_doc[] = "Unregisters a callback. This function needs exactly one parameter either\n"
- "the function to unregister or the callback identifier to unregister.";
-
-static char reg_log_doc[] = "register_log(callback[, data][, name]) -> identifier\n"
- "\n"
- "Register a callback function for log messages.\n"
- "\n"
- "'callback' is a callable object that will be called every time something\n"
- " is logged.\n"
- "'data' is an optional object that will be passed back to the callback\n"
- " function every time it is called.\n"
- "'name' is an optional identifier for this callback. The default name\n"
- " is 'python.<module>'.\n"
- " Every callback needs a unique identifier, so if you want to\n"
- " register this callback multiple time from the same module you need\n"
- " to specify a name here.\n"
- "'identifier' is the full identifier assigned to this callback.\n"
- "\n"
- "The callback function will be called with two or three parameters:\n"
- "severity: An integer that should be compared to the LOG_ constants.\n"
- "message: The text to be logged.\n"
- "data: The optional data parameter passed to the register function.\n"
- " If the parameter was omitted it will be omitted here, too.";
-
-static char reg_init_doc[] = "register_init(callback[, data][, name]) -> identifier\n"
- "\n"
- "Register a callback function that will be executed once after the config.\n"
- "file has been read, all plugins heve been loaded and the collectd has\n"
- "forked into the background.\n"
- "\n"
- "'callback' is a callable object that will be executed.\n"
- "'data' is an optional object that will be passed back to the callback\n"
- " function when it is called.\n"
- "'name' is an optional identifier for this callback. The default name\n"
- " is 'python.<module>'.\n"
- " Every callback needs a unique identifier, so if you want to\n"
- " register this callback multiple time from the same module you need\n"
- " to specify a name here.\n"
- "'identifier' is the full identifier assigned to this callback.\n"
- "\n"
- "The callback function will be called without parameters, except for\n"
- "data if it was supplied.";
-
-static char reg_config_doc[] = "register_config(callback[, data][, name]) -> identifier\n"
- "\n"
- "Register a callback function for config file entries.\n"
- "'callback' is a callable object that will be called for every config block.\n"
- "'data' is an optional object that will be passed back to the callback\n"
- " function every time it is called.\n"
- "'name' is an optional identifier for this callback. The default name\n"
- " is 'python.<module>'.\n"
- " Every callback needs a unique identifier, so if you want to\n"
- " register this callback multiple time from the same module you need\n"
- " to specify a name here.\n"
- "'identifier' is the full identifier assigned to this callback.\n"
- "\n"
- "The callback function will be called with one or two parameters:\n"
- "config: A Config object.\n"
- "data: The optional data parameter passed to the register function.\n"
- " If the parameter was omitted it will be omitted here, too.";
-
-static char reg_read_doc[] = "register_read(callback[, interval][, data][, name]) -> identifier\n"
- "\n"
- "Register a callback function for reading data. It will just be called\n"
- "in a fixed interval to signal that it's time to dispatch new values.\n"
- "'callback' is a callable object that will be called every time something\n"
- " is logged.\n"
- "'interval' is the number of seconds between between calls to the callback\n"
- " function. Full float precision is supported here.\n"
- "'data' is an optional object that will be passed back to the callback\n"
- " function every time it is called.\n"
- "'name' is an optional identifier for this callback. The default name\n"
- " is 'python.<module>'.\n"
- " Every callback needs a unique identifier, so if you want to\n"
- " register this callback multiple time from the same module you need\n"
- " to specify a name here.\n"
- "'identifier' is the full identifier assigned to this callback.\n"
- "\n"
- "The callback function will be called without parameters, except for\n"
- "data if it was supplied.";
-
-static char reg_write_doc[] = "register_write(callback[, data][, name]) -> identifier\n"
- "\n"
- "Register a callback function to receive values dispatched by other plugins.\n"
- "'callback' is a callable object that will be called every time a value\n"
- " is dispatched.\n"
- "'data' is an optional object that will be passed back to the callback\n"
- " function every time it is called.\n"
- "'name' is an optional identifier for this callback. The default name\n"
- " is 'python.<module>'.\n"
- " Every callback needs a unique identifier, so if you want to\n"
- " register this callback multiple time from the same module you need\n"
- " to specify a name here.\n"
- "'identifier' is the full identifier assigned to this callback.\n"
- "\n"
- "The callback function will be called with one or two parameters:\n"
- "values: A Values object which is a copy of the dispatched values.\n"
- "data: The optional data parameter passed to the register function.\n"
- " If the parameter was omitted it will be omitted here, too.";
-
-static char reg_notification_doc[] = "register_notification(callback[, data][, name]) -> identifier\n"
- "\n"
- "Register a callback function for notifications.\n"
- "'callback' is a callable object that will be called every time a notification\n"
- " is dispatched.\n"
- "'data' is an optional object that will be passed back to the callback\n"
- " function every time it is called.\n"
- "'name' is an optional identifier for this callback. The default name\n"
- " is 'python.<module>'.\n"
- " Every callback needs a unique identifier, so if you want to\n"
- " register this callback multiple time from the same module you need\n"
- " to specify a name here.\n"
- "'identifier' is the full identifier assigned to this callback.\n"
- "\n"
- "The callback function will be called with one or two parameters:\n"
- "notification: A copy of the notification that was dispatched.\n"
- "data: The optional data parameter passed to the register function.\n"
- " If the parameter was omitted it will be omitted here, too.";
-
-static char reg_flush_doc[] = "register_flush(callback[, data][, name]) -> identifier\n"
- "\n"
- "Register a callback function for flush messages.\n"
- "'callback' is a callable object that will be called every time a plugin\n"
- " requests a flush for either this or all plugins.\n"
- "'data' is an optional object that will be passed back to the callback\n"
- " function every time it is called.\n"
- "'name' is an optional identifier for this callback. The default name\n"
- " is 'python.<module>'.\n"
- " Every callback needs a unique identifier, so if you want to\n"
- " register this callback multiple time from the same module you need\n"
- " to specify a name here.\n"
- "'identifier' is the full identifier assigned to this callback.\n"
- "\n"
- "The callback function will be called with two or three parameters:\n"
- "timeout: Indicates that only data older than 'timeout' seconds is to\n"
- " be flushed.\n"
- "id: Specifies which values are to be flushed. Might be None.\n"
- "data: The optional data parameter passed to the register function.\n"
- " If the parameter was omitted it will be omitted here, too.";
-
-static char reg_shutdown_doc[] = "register_shutdown(callback[, data][, name]) -> identifier\n"
- "\n"
- "Register a callback function for collectd shutdown.\n"
- "'callback' is a callable object that will be called once collectd is\n"
- " shutting down.\n"
- "'data' is an optional object that will be passed back to the callback\n"
- " function if it is called.\n"
- "'name' is an optional identifier for this callback. The default name\n"
- " is 'python.<module>'.\n"
- " Every callback needs a unique identifier, so if you want to\n"
- " register this callback multiple time from the same module you need\n"
- " to specify a name here.\n"
- "'identifier' is the full identifier assigned to this callback.\n"
- "\n"
- "The callback function will be called with no parameters except for\n"
- " data if it was supplied.";
-
+ "\n"
+ "Flushes the cache of another plugin.";
+
+static char unregister_doc[] =
+ "Unregisters a callback. This function needs exactly one parameter either\n"
+ "the function to unregister or the callback identifier to unregister.";
+
+static char reg_log_doc[] =
+ "register_log(callback[, data][, name]) -> identifier\n"
+ "\n"
+ "Register a callback function for log messages.\n"
+ "\n"
+ "'callback' is a callable object that will be called every time something\n"
+ " is logged.\n"
+ "'data' is an optional object that will be passed back to the callback\n"
+ " function every time it is called.\n"
+ "'name' is an optional identifier for this callback. The default name\n"
+ " is 'python.<module>'.\n"
+ " Every callback needs a unique identifier, so if you want to\n"
+ " register this callback multiple time from the same module you need\n"
+ " to specify a name here.\n"
+ "'identifier' is the full identifier assigned to this callback.\n"
+ "\n"
+ "The callback function will be called with two or three parameters:\n"
+ "severity: An integer that should be compared to the LOG_ constants.\n"
+ "message: The text to be logged.\n"
+ "data: The optional data parameter passed to the register function.\n"
+ " If the parameter was omitted it will be omitted here, too.";
+
+static char reg_init_doc[] =
+ "register_init(callback[, data][, name]) -> identifier\n"
+ "\n"
+ "Register a callback function that will be executed once after the "
+ "config.\n"
+ "file has been read, all plugins heve been loaded and the collectd has\n"
+ "forked into the background.\n"
+ "\n"
+ "'callback' is a callable object that will be executed.\n"
+ "'data' is an optional object that will be passed back to the callback\n"
+ " function when it is called.\n"
+ "'name' is an optional identifier for this callback. The default name\n"
+ " is 'python.<module>'.\n"
+ " Every callback needs a unique identifier, so if you want to\n"
+ " register this callback multiple time from the same module you need\n"
+ " to specify a name here.\n"
+ "'identifier' is the full identifier assigned to this callback.\n"
+ "\n"
+ "The callback function will be called without parameters, except for\n"
+ "data if it was supplied.";
+
+static char reg_config_doc[] =
+ "register_config(callback[, data][, name]) -> identifier\n"
+ "\n"
+ "Register a callback function for config file entries.\n"
+ "'callback' is a callable object that will be called for every config "
+ "block.\n"
+ "'data' is an optional object that will be passed back to the callback\n"
+ " function every time it is called.\n"
+ "'name' is an optional identifier for this callback. The default name\n"
+ " is 'python.<module>'.\n"
+ " Every callback needs a unique identifier, so if you want to\n"
+ " register this callback multiple time from the same module you need\n"
+ " to specify a name here.\n"
+ "'identifier' is the full identifier assigned to this callback.\n"
+ "\n"
+ "The callback function will be called with one or two parameters:\n"
+ "config: A Config object.\n"
+ "data: The optional data parameter passed to the register function.\n"
+ " If the parameter was omitted it will be omitted here, too.";
+
+static char reg_read_doc[] =
+ "register_read(callback[, interval][, data][, name]) -> identifier\n"
+ "\n"
+ "Register a callback function for reading data. It will just be called\n"
+ "in a fixed interval to signal that it's time to dispatch new values.\n"
+ "'callback' is a callable object that will be called every time something\n"
+ " is logged.\n"
+ "'interval' is the number of seconds between between calls to the "
+ "callback\n"
+ " function. Full float precision is supported here.\n"
+ "'data' is an optional object that will be passed back to the callback\n"
+ " function every time it is called.\n"
+ "'name' is an optional identifier for this callback. The default name\n"
+ " is 'python.<module>'.\n"
+ " Every callback needs a unique identifier, so if you want to\n"
+ " register this callback multiple time from the same module you need\n"
+ " to specify a name here.\n"
+ "'identifier' is the full identifier assigned to this callback.\n"
+ "\n"
+ "The callback function will be called without parameters, except for\n"
+ "data if it was supplied.";
+
+static char reg_write_doc[] =
+ "register_write(callback[, data][, name]) -> identifier\n"
+ "\n"
+ "Register a callback function to receive values dispatched by other "
+ "plugins.\n"
+ "'callback' is a callable object that will be called every time a value\n"
+ " is dispatched.\n"
+ "'data' is an optional object that will be passed back to the callback\n"
+ " function every time it is called.\n"
+ "'name' is an optional identifier for this callback. The default name\n"
+ " is 'python.<module>'.\n"
+ " Every callback needs a unique identifier, so if you want to\n"
+ " register this callback multiple time from the same module you need\n"
+ " to specify a name here.\n"
+ "'identifier' is the full identifier assigned to this callback.\n"
+ "\n"
+ "The callback function will be called with one or two parameters:\n"
+ "values: A Values object which is a copy of the dispatched values.\n"
+ "data: The optional data parameter passed to the register function.\n"
+ " If the parameter was omitted it will be omitted here, too.";
+
+static char reg_notification_doc[] =
+ "register_notification(callback[, data][, name]) -> identifier\n"
+ "\n"
+ "Register a callback function for notifications.\n"
+ "'callback' is a callable object that will be called every time a "
+ "notification\n"
+ " is dispatched.\n"
+ "'data' is an optional object that will be passed back to the callback\n"
+ " function every time it is called.\n"
+ "'name' is an optional identifier for this callback. The default name\n"
+ " is 'python.<module>'.\n"
+ " Every callback needs a unique identifier, so if you want to\n"
+ " register this callback multiple time from the same module you need\n"
+ " to specify a name here.\n"
+ "'identifier' is the full identifier assigned to this callback.\n"
+ "\n"
+ "The callback function will be called with one or two parameters:\n"
+ "notification: A copy of the notification that was dispatched.\n"
+ "data: The optional data parameter passed to the register function.\n"
+ " If the parameter was omitted it will be omitted here, too.";
+
+static char reg_flush_doc[] =
+ "register_flush(callback[, data][, name]) -> identifier\n"
+ "\n"
+ "Register a callback function for flush messages.\n"
+ "'callback' is a callable object that will be called every time a plugin\n"
+ " requests a flush for either this or all plugins.\n"
+ "'data' is an optional object that will be passed back to the callback\n"
+ " function every time it is called.\n"
+ "'name' is an optional identifier for this callback. The default name\n"
+ " is 'python.<module>'.\n"
+ " Every callback needs a unique identifier, so if you want to\n"
+ " register this callback multiple time from the same module you need\n"
+ " to specify a name here.\n"
+ "'identifier' is the full identifier assigned to this callback.\n"
+ "\n"
+ "The callback function will be called with two or three parameters:\n"
+ "timeout: Indicates that only data older than 'timeout' seconds is to\n"
+ " be flushed.\n"
+ "id: Specifies which values are to be flushed. Might be None.\n"
+ "data: The optional data parameter passed to the register function.\n"
+ " If the parameter was omitted it will be omitted here, too.";
+
+static char reg_shutdown_doc[] =
+ "register_shutdown(callback[, data][, name]) -> identifier\n"
+ "\n"
+ "Register a callback function for collectd shutdown.\n"
+ "'callback' is a callable object that will be called once collectd is\n"
+ " shutting down.\n"
+ "'data' is an optional object that will be passed back to the callback\n"
+ " function if it is called.\n"
+ "'name' is an optional identifier for this callback. The default name\n"
+ " is 'python.<module>'.\n"
+ " Every callback needs a unique identifier, so if you want to\n"
+ " register this callback multiple time from the same module you need\n"
+ " to specify a name here.\n"
+ "'identifier' is the full identifier assigned to this callback.\n"
+ "\n"
+ "The callback function will be called with no parameters except for\n"
+ " data if it was supplied.";
+
+static char CollectdError_doc[] =
+ "Basic exception for collectd Python scripts.\n"
+ "\n"
+ "Throwing this exception will not cause a stacktrace to be logged, \n"
+ "even if LogTraces is enabled in the config.";