From: Tobias Oetiker <tobi@oetiker.ch>
Date: Sun, 22 Jan 2006 12:02:47 +0000 (+0000)
Subject: clarified the documentation of xff -- Michael Bunk  mb computer-leipzig.com
X-Git-Tag: 1.2.13~36
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c8c31e21ea06bea978d0ffab9bf41aab49e22a94;p=thirdparty%2Frrdtool-1.x.git

clarified the documentation of xff -- Michael Bunk  mb computer-leipzig.com



git-svn-id: svn://svn.oetiker.ch/rrdtool/branches/1.2/program@751 a5681a0c-68f1-0310-ab6d-d61299d08faa
---

diff --git a/doc/rrdcreate.pod b/doc/rrdcreate.pod
index 036b1073..62907c83 100644
--- a/doc/rrdcreate.pod
+++ b/doc/rrdcreate.pod
@@ -180,7 +180,9 @@ B<RRA:>I<AVERAGE | MIN | MAX | LAST>B<:>I<xff>B<:>I<steps>B<:>I<rows>
 
 I<xff> The xfiles factor defines what part of a consolidation interval may
 be made up from I<*UNKNOWN*> data while the consolidated value is still
-regarded as known.
+regarded as known. It is given as the ratio of allowed I<*UNKNOWN*> PDPs
+to the number of PDPs in the interval. Thus, it ranges from 0 to 1 (exclusive).
+
 
 I<steps> defines how many of these I<primary data points> are used to build
 a I<consolidated data point> which then goes into the archive.