From: Tobias Oetiker <tobi@oetiker.ch>
Date: Fri, 20 Jul 2007 22:16:36 +0000 (+0000)
Subject: better docs on the aggregate functions
X-Git-Tag: 1.3rc2~123
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d670de4d95d420199d4ef4c45b90d07acbf73105;p=thirdparty%2Frrdtool-1.x.git

better docs on the aggregate functions


git-svn-id: svn://svn.oetiker.ch/rrdtool/trunk/program@1160 a5681a0c-68f1-0310-ab6d-d61299d08faa
---

diff --git a/doc/rrdcreate.pod b/doc/rrdcreate.pod
index 3689e293..49db70ec 100644
--- a/doc/rrdcreate.pod
+++ b/doc/rrdcreate.pod
@@ -173,7 +173,35 @@ data point>.
 The data is also processed with the consolidation function (I<CF>) of
 the archive. There are several consolidation functions that
 consolidate primary data points via an aggregate function: B<AVERAGE>,
-B<MIN>, B<MAX>, B<LAST>. The format of B<RRA> line for these
+B<MIN>, B<MAX>, B<LAST>. 
+
+=over
+
+=item AVERAGE
+
+the average of the data points is stored.
+
+=item MIN
+
+the smallest of the data points is stored.
+
+=item MAX
+
+the largest of the data points is stored.
+
+=item LAST
+
+the last data points is used.
+
+=back
+
+Note that data aggregation inevitably leads to loss of precision and
+information. The trick is to pick the aggregate function such that the
+I<interesting> properties of your data is kept across the aggregation
+process.
+
+
+The format of B<RRA> line for these
 consolidation functions is:
 
 B<RRA:>I<AVERAGE | MIN | MAX | LAST>B<:>I<xff>B<:>I<steps>B<:>I<rows>