From: Marc Fournier Date: Tue, 14 Jun 2016 05:38:30 +0000 (+0200) Subject: src/*.pod: fix minor warnings spotted by podchecker X-Git-Tag: collectd-5.5.2~4^2 X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=4371ef7f98f6f51ea3df34d5e26e175d6b44a328;p=collectd.git src/*.pod: fix minor warnings spotted by podchecker --- diff --git a/src/collectd-email.pod b/src/collectd-email.pod index 6f585427..6a07b886 100644 --- a/src/collectd-email.pod +++ b/src/collectd-email.pod @@ -33,7 +33,7 @@ with the plugin: =over 4 -=item +=item * E-Mail type (e.g. "ham", "spam", "virus", ...) and size (bytes): @@ -41,13 +41,13 @@ E-Mail type (e.g. "ham", "spam", "virus", ...) and size (bytes): If C is less than or equal to zero, C is ignored. -=item +=item * Spam score: s: -=item +=item * Successful spam checks (e.g. "BAYES_99", "SUBJECT_DRUG_GAP_C", ...): diff --git a/src/collectd-exec.pod b/src/collectd-exec.pod index 57e5b6e2..074bbbdc 100644 --- a/src/collectd-exec.pod +++ b/src/collectd-exec.pod @@ -268,12 +268,12 @@ to make use of collectd's more powerful interface. =over 4 -=item +=item * The user, the binary is executed as, may not have root privileges, i.Ee. must have an UID that is non-zero. This is for your own good. -=item +=item * Early versions of the plugin did not use a command but treated all lines as if they were arguments to the I command. When the I command was diff --git a/src/collectd-perl.pod b/src/collectd-perl.pod index d4137bb7..02563066 100644 --- a/src/collectd-perl.pod +++ b/src/collectd-perl.pod @@ -705,7 +705,7 @@ types used by the read, write and match functions. =over 4 -=item +=item * Please feel free to send in new plugins to collectd's mailing list at EcollectdEatEverplant.orgE for review and, possibly, @@ -721,7 +721,7 @@ L. =over 4 -=item +=item * collectd is heavily multi-threaded. Each collectd thread accessing the perl plugin will be mapped to a Perl interpreter thread (see L). @@ -733,7 +733,7 @@ registered callback may be called more than once in parallel). Please note that no data is shared between threads by default. You have to use the B module to do so. -=item +=item * Each function name registered with collectd has to be available before the first thread has been created (i.Ee. basically at compile time). This @@ -742,14 +742,14 @@ C<*foo = \&bar; plugin_register (TYPE_READ, "plugin", "foo");> most likely will not work. This is due to the fact that the symbol table is not shared across different threads. -=item +=item * Each plugin is usually only loaded once and kept in memory for performance reasons. Therefore, END blocks are only executed once when collectd shuts down. You should not rely on END blocks anyway - use B instead. -=item +=item * The perl plugin exports the internal API of collectd which is considered unstable and subject to change at any time. We try hard to not break backwards @@ -763,7 +763,7 @@ dispatched by the perl plugin after upgrades. =over 4 -=item +=item * Currently, it is not possible to flush a single Perl plugin only. You can either flush all Perl plugins or none at all and you have to use C as diff --git a/src/collectd-python.pod b/src/collectd-python.pod index b382424b..8564ae77 100644 --- a/src/collectd-python.pod +++ b/src/collectd-python.pod @@ -85,12 +85,12 @@ collectd script as well as from a normal Python interpreter: =over 4 -=item +=item * B<1.> collectd will try to import the B module to give you a decent way of entering your commands. The daemonized collectd won't do that. -=item +=item * B<2.> collectd will block I. Pressing I will usually cause collectd to shut down. This would be problematic in an interactive session, @@ -100,7 +100,7 @@ exception either. To quit collectd send I (press I at the beginning of a new line). -=item +=item * B<3.> collectd handles I. This means that Python won't be able to determine the return code of spawned processes with system(), popen() and @@ -513,18 +513,18 @@ different events. With one exception all of them are called as shown above. =over 4 -=item +=item * I is a callable object that will be called every time the event is triggered. -=item +=item * I is an optional object that will be passed back to the callback function every time it is called. If you omit this parameter no object is passed back to your callback, not even None. -=item +=item * I is an optional identifier for this callback. The default name is B.I. I is taken from the B<__module__> attribute of @@ -532,7 +532,7 @@ your callback function. Every callback needs a unique identifier, so if you want to register the same callback multiple times in the same module you need to specify a name here. Otherwise it's safe to ignore this parameter. -=item +=item * I is the full identifier assigned to this callback. @@ -609,7 +609,7 @@ I is either the string that was returned by the register function or a callback function. The identifier will be constructed in the same way as for the register functions. -=item B(I][, I]) -> None +=item B(I None Flush one or all plugins. I and the specified I are passed on to the registered flush-callbacks. If omitted, the timeout defaults @@ -653,7 +653,7 @@ types used by the read, write and match functions. =over 4 -=item +=item * Please feel free to send in new plugins to collectd's mailing list at EcollectdEatEverplant.orgE for review and, possibly, @@ -669,7 +669,7 @@ L. =over 4 -=item +=item * collectd is heavily multi-threaded. Each collectd thread accessing the Python plugin will be mapped to a Python interpreter thread. Any such thread will be @@ -679,13 +679,13 @@ Hence, any plugin has to be thread-safe if it provides several entry points from collectd (i.Ee. if it registers more than one callback or if a registered callback may be called more than once in parallel). -=item +=item * The Python thread module is initialized just before calling the init callbacks. This means you must not use Python's threading module prior to this point. This includes all config and possibly other callback as well. -=item +=item * The python plugin exports the internal API of collectd which is considered unstable and subject to change at any time. We try hard to not break backwards @@ -699,7 +699,7 @@ dispatched by the python plugin after upgrades. =over 4 -=item +=item * Not all aspects of the collectd API are accessible from Python. This includes but is not limited to filters and data sets. diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 499634c5..f85c7e79 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -357,13 +357,13 @@ There are a couple of limitations you should be aware of: =over 4 -=item +=item * The I cannot be left unspecified, because it is not reasonable to add apples to oranges. Also, the internal lookup structure won't work if you try to group by type. -=item +=item * There must be at least one unspecified, ungrouped field. Otherwise nothing will be aggregated. @@ -438,19 +438,19 @@ This will create the files: =over 4 -=item +=item * foo.example.com/cpu-even-average/cpu-idle -=item +=item * foo.example.com/cpu-even-average/cpu-system -=item +=item * foo.example.com/cpu-even-average/cpu-user -=item +=item * ... @@ -1175,11 +1175,17 @@ The following options are valid within B blocks: Sets the plugin instance to I. =item B I + =item B I + =item B B|B + =item B B|B + =item B I + =item B
I
+ =item B I These options behave exactly equivalent to the appropriate options of the @@ -5952,20 +5958,20 @@ The following methods are used to find the machine's UUID, in order: =over 4 -=item +=item * Check I (or I). -=item +=item * Check for UUID from HAL (L) if present. -=item +=item * Check for UUID from C / SMBIOS. -=item +=item * Check for UUID from Xen hypervisor. diff --git a/src/collectd.pod b/src/collectd.pod index 2f7b9f70..8ea47ec8 100644 --- a/src/collectd.pod +++ b/src/collectd.pod @@ -68,7 +68,7 @@ There are two big groups of plugins, B and B plugins: =over 4 -=item +=item * Input plugins are queried periodically. They somehow acquire the current value of whatever they where designed to work with and submit these values back to @@ -76,7 +76,7 @@ the daemon, i. e. they "dispatch" the values. As an example, the C reads the current cpu-counters of time spent in the various modes (user, system, nice, ...) and dispatches these counters to the daemon. -=item +=item * Output plugins get the dispatched values from the daemon and does something with them. Common applications are writing to RRD-files, CSV-files or sending