From: Idan Kamara Date: Wed, 24 Oct 2012 09:30:28 +0000 (+0200) Subject: collectd-python.conf(5): change phrasing of function descriptions X-Git-Tag: collectd-5.0.5~1^2~6 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=f0a8b7aae5aeb6c5cc1c2b8e95745927ff4f45ac;p=collectd.git collectd-python.conf(5): change phrasing of function descriptions Signed-off-by: Florian Forster --- diff --git a/src/collectd-python.pod b/src/collectd-python.pod index 06ed1193..ef2e6bd3 100644 --- a/src/collectd-python.pod +++ b/src/collectd-python.pod @@ -174,7 +174,7 @@ example. The following types of B are known to collectd =item configuration functions -This type of functions is called during configuration if an appropriate +These are called during configuration if an appropriate B block has been encountered. It is called once for each B block which matches the name of the callback as provided with the B method - see below. @@ -184,14 +184,14 @@ threading functions here! =item init functions -This type of functions is called once after loading the module and before any +These are called once after loading the module and before any calls to the read and write functions. It should be used to initialize the internal state of the plugin (e.Eg. open sockets, ...). This is the earliest point where you may use threads. =item read functions -This type of function is used to collect the actual data. It is called once +These are used to collect the actual data. It is called once per interval (see the B configuration option of collectd). Usually it will call B to dispatch the values to collectd which will pass them on to all registered B. If this function @@ -200,23 +200,23 @@ amount of time until it returns normally again. =item write functions -This type of function is used to write the dispatched values. It is called +These are used to write the dispatched values. It is called once for every value that was dispatched by any plugin. =item flush functions -This type of function is used to flush internal caches of plugins. It is +These are used to flush internal caches of plugins. It is usually triggered by the user only. Any plugin which caches data before writing it to disk should provide this kind of callback function. =item log functions -This type of function is used to pass messages of plugins or the daemon itself +These are used to pass messages of plugins or the daemon itself to the user. =item notification function -This type of function is used to act upon notifications. In general, a +These are used to act upon notifications. In general, a notification is a status message that may be associated with a data instance. Usually, a notification is generated by the daemon if a configured threshold has been exceeded (see the section "THRESHOLD CONFIGURATION" in