From 89fb899737597ebd2ad0ccc47ca7d64592ee885a Mon Sep 17 00:00:00 2001
From: oetiker <oetiker@a5681a0c-68f1-0310-ab6d-d61299d08faa>
Date: Tue, 16 Aug 2005 05:30:29 +0000
Subject: [PATCH] added notes about VDEF expressions not being general purpose

git-svn-id: svn://svn.oetiker.ch/rrdtool/branches/1.2@673 a5681a0c-68f1-0310-ab6d-d61299d08faa
---
 program/doc/rrdgraph_data.pod     |  3 +++
 program/doc/rrdgraph_examples.pod | 16 ++++++++--------
 program/doc/rrdgraph_rpn.pod      | 15 +++++++--------
 3 files changed, 18 insertions(+), 16 deletions(-)

diff --git a/program/doc/rrdgraph_data.pod b/program/doc/rrdgraph_data.pod
index c3891d46..04d97617 100644
--- a/program/doc/rrdgraph_data.pod
+++ b/program/doc/rrdgraph_data.pod
@@ -71,6 +71,9 @@ elements.
 
 Example: C<VDEF:avg=mydata,AVERAGE>
 
+Note that currently only agregation functions work in VDEF rpn expressions.
+Patches to change this are welcome.
+
 =head1 CDEF
 
 B<CDEF>:I<vname>=I<RPN expression>
diff --git a/program/doc/rrdgraph_examples.pod b/program/doc/rrdgraph_examples.pod
index f09ce847..9f0233be 100644
--- a/program/doc/rrdgraph_examples.pod
+++ b/program/doc/rrdgraph_examples.pod
@@ -30,14 +30,14 @@ ready because comments are intermixed with the examples.
 
     DEF:ds0=/home/rrdtool/data/router1.rrd:ds0:AVERAGE
     DEF:ds1=/home/rrdtool/data/router1.rrd:ds1:AVERAGE
-    VDEF:ds0max=ds0,MAXIMUM,8,*
-    VDEF:ds0avg=ds0,AVERAGE,8,*
-    VDEF:ds0min=ds0,MINIMUM,8,*
-    VDEF:ds0pct=95,ds0,PERCENTILE,8,*
-    VDEF:ds1max=ds1,MAXIMUM,8,*
-    VDEF:ds1avg=ds1,AVERAGE,8,*
-    VDEF:ds1min=ds1,MINIMUM,8,*
-    VDEF:ds1pct=95,ds1,PERCENTILE,8,*
+    VDEF:ds0max=ds0,MAXIMUM
+    VDEF:ds0avg=ds0,AVERAGE
+    VDEF:ds0min=ds0,MINIMUM
+    VDEF:ds0pct=ds0,95,PERCENT
+    VDEF:ds1max=ds1,MAXIMUM
+    VDEF:ds1avg=ds1,AVERAGE
+    VDEF:ds1min=ds1,MINIMUM
+    VDEF:ds1pct=ds1,95,PERCENT
 
 Note: consolidation occurs here.
 
diff --git a/program/doc/rrdgraph_rpn.pod b/program/doc/rrdgraph_rpn.pod
index 1aaef653..dfc9a0bd 100644
--- a/program/doc/rrdgraph_rpn.pod
+++ b/program/doc/rrdgraph_rpn.pod
@@ -15,11 +15,12 @@ takes as many elements from the stack as needed. Pushing is done
 implicitly, so whenever you specify a number or a variable, it gets
 pushed onto the stack automatically.
 
-At the end of the calculation there should be one and only one
-value left on the stack.  This is the outcome of the function and
-this is what is put into the I<vname>.  For B<CDEF> instructions,
-the stack is processed for each data point on the graph. B<VDEF>
-instructions work on an entire data set in one run.
+At the end of the calculation there should be one and only one value left on
+the stack.  This is the outcome of the function and this is what is put into
+the I<vname>.  For B<CDEF> instructions, the stack is processed for each
+data point on the graph. B<VDEF> instructions work on an entire data set in
+one run. Note, that currently B<VDEF> instructions only support a limited
+list of functions.
 
 Example: C<VDEF:maximum=mydata,MAXIMUM>
 
@@ -195,8 +196,6 @@ number 2 if it is the second, and so on. This special value allows
 you to make calculations based on the position of the value within
 the data set. This function cannot be used in B<VDEF> instructions.
 
-Z<>
-
 =item Time
 
 Time inside RRDtool is measured in seconds since the epoch. The
@@ -230,7 +229,7 @@ Z<>
 
 =head1 VARIABLES
 
-These operators work only on B<VDEF> statements.
+These operators work only on B<VDEF> statements. Note that currently ONLY these work for B<VDEF>.
 
 =over 4
 
-- 
2.30.2