sensors plugin: Improved the documentation in the sample configfile and the `collectd...

diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index 0d63dffe95f9fada132327c8c969e4996c3d822a..f74a118539b4192ef0a57dc7a49df4c3b48aac11 100644 (file)
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -83,27 +83,20 @@
 #      Process name
 #</Plugin>
 
+## There are two different naming schemes for the sensors plugin, to preserver
+## backwards compatibility. The `extended naming' is prefered, but not the
+## default for this reason. See `collectd.conf(5)' for more information.
 #<Plugin sensors>
-## Collect only required sensors.
-## 
-## Default sensors and .rrd files names
-## compatible with old .rrd files (temp and fan).
-##
 #      ExtendedSensorNaming false
 #      Sensor it8712-temp1
 #      Sensor it8712-fan3
 #      Sensor it8712-in8
-##
-## Extended sensors and .rrd files names break compatibility
-## with previous naming and .rrd files,
-## see collectd.conf(5) for detailed information.
-##
+## -- OR --
 #      ExtendedSensorNaming true
 #      Sensor it8712-isa-0290/temperature-temp1
 #      Sensor it8712-isa-0290/fanspeed-fan3
 #      Sensor it8712-isa-0290/voltage-in8
-##
-## Reverse sensors sellection?
+#
 #      IgnoreSelected false
 #</Plugin>
 

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 86fcf296c5b26bf5d732a17bf65864a4309297e5..aae7356b90b421376a92bc31008624bda4f68156 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -232,30 +232,30 @@ Sets the Time-To-Live of generated ICMP packets.
 
 =item B<ExtendedSensorNaming> I<true>|I<false>
 
-If set to I<true> this option switches on the extended sensors
-and RRD files naming.
+If set to I<true> this option switches on the extended sensors and RRD-files
+naming. This option exists to preserve backwards compatibility. It is
+recommended that you set this option to I<true>. The default is I<false> to
+maintain compatibility only.
 
-Sensors get names like I<chip-bus-address/type-feature>
-(e.g. I<it8712-isa-0290/voltage-in1>) and RRD files are therefore
-stored in a standalone directory inside the B<DataDir> directory and get
-names like I<lm_sensors-chip-bus-address/type-feature.rrd>
-(e.g. I<lm_sensors-it8712-isa-0290/voltage-in1.rrd>).
+Sensors get names like I<chip-bus-address/type-feature> (e.g.
+I<it8712-isa-0290/voltage-in1>) and RRD files are therefore stored in a
+standalone directory inside the B<DataDir> directory and get names like
+I<lm_sensors-chip-bus-address/type-feature.rrd> (e.g.
+I<lm_sensors-it8712-isa-0290/voltage-in1.rrd>).
 
 The B<ExtendedSensorNaming> option breaks the compatibility with previous
 sensors and RRD files naming and the place where RRDs are stored. If you turn
 it on, the plugin will create new RRD files in a standalone directory inside
-the B<DataDir> directory and without previous history. You can rename
-previous RRD files to the new ones to continue collecting data into the same
-RRDs.
-
-If not set or set to I<false>, the extended naming is not active. Sensors
-get names like I<chip-feature> (e.g. I<it8712-in1>) and RRD files
-are stored in the main B<DataDir> directory and get names like
-I<sensors-chip-feature.rrd> (e.g. I<sensors-it8712-in1.rrd>).
-You simply continue using the plugin the old way and additionally also
-getting data for newly added sensors in this mode.
-
-Default setting is I<false>.
+the B<DataDir> directory and without previous history. You can rename ``old''
+RRD-files to preserve already collected statistics, because the file layout
+hasn't changed. If you have two chips of the same type, you need to use
+B<ExtendedSensorNaming> in order to collect information from both chips.
+
+If not set or set to I<false>, the extended naming is not active. Sensors get
+names like I<chip-feature> (e.g. I<it8712-in1>) and RRD files are stored in the
+main B<DataDir> directory and get names like I<sensors-chip-feature.rrd> (e.g.
+I<sensors-it8712-in1.rrd>).  You simply continue using the plugin the old way
+and additionally also getting data for newly added sensors in this mode.
 
 =item B<Sensor> I<chip-feature> or B<Sensor> I<chip-bus-address/type-feature>