From: Florian Forster <octo@huhu.verplant.org>
Date: Wed, 27 Aug 2008 06:55:49 +0000 (+0200)
Subject: collectd.conf(5), README: Added a note that the onewire plugin is experimental.
X-Git-Tag: collectd-4.5.0~26
X-Git-Url: https://git.octo.it/?a=commitdiff_plain;h=add168aec6535610f754eddbd74df653586614ad;p=collectd.git

collectd.conf(5), README: Added a note that the onewire plugin is experimental.
---

diff --git a/README b/README
index eddf432c..58ce45d3 100644
--- a/README
+++ b/README
@@ -135,8 +135,9 @@ Features
       Network UPS tools: UPS current, voltage, power, charge, utilisation,
       temperature, etc. See upsd(8).
 
-    - onewire
+    - onewire (EXPERIMENTAL!)
       Read onewire sensors using the owcapu library of the owfs project.
+      Please read in collectd.conf(5) why this plugin is experimental.
 
     - perl
       The perl plugin implements a Perl-interpreter into collectd. You can
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 038def1b..8893a4ec 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1039,6 +1039,8 @@ L<upsc(8)>.
 
 =head2 Plugin C<onewire>
 
+B<EXPERIMENTAL!> See notes below.
+
 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
 L<http://owfs.org/> to read sensors connected via the onewire bus.
 
@@ -1077,6 +1079,17 @@ interfaces are collected.
 
 =back
 
+B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
+work with big setups. It works with one sensor being attached to one
+controller, but as soon as you throw in a couple more senors and maybe a hub
+or two, reading all values will take more than ten seconds (the default
+interval). We will probably add some separate thread for reading the sensors
+and some cache or something like that, but it's not done yet. We will try to
+maintain backwards compatibility in the future, but we can't probmise. So in
+short: If it works for you: Great! But kaap in mind that the config I<might>
+change, though this is unlikely. Oh, and if you want to help improving this
+plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
+
 =head2 Plugin C<perl>
 
 This plugin embeds a Perl-interpreter into collectd and provides an interface