From: oetiker <oetiker@a5681a0c-68f1-0310-ab6d-d61299d08faa>
Date: Wed, 29 Apr 2009 06:52:25 +0000 (+0000)
Subject: added some remarks on CDEF versus VDEF to the docs -- Pablo Sanchez
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=f0bd3122f71380f196a5f29d5143f7c341cca2ad;p=rrdtool.git

added some remarks on CDEF versus VDEF to the docs -- Pablo Sanchez


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

diff --git a/CONTRIBUTORS b/CONTRIBUTORS
index f317978..f90d720 100644
--- a/CONTRIBUTORS
+++ b/CONTRIBUTORS
@@ -41,6 +41,7 @@ Mike Mitchell <mcm with unx.sas.com>
 Mike Slifcak <slif with bellsouth.net> many rrdtool-1.1.x fixes
 Oleg Cherevko <olwi with icyb.kiev.ua>
 Otmar Lendl <O.Lendl with Austria.EU.net> (lots of bugfixes)
+Pablo Sanchez <pablo at blueoakdb.com> (CDEF vs VDEF)
 Patrick Cherry <patrick with bytemark.co.uk>
 Paul Joslin <Paul.Joslin with sdrc.com>
 Peter Speck <speck with vitality.dk> eps/svg/pdf file format code in rrdtool-1.x
diff --git a/doc/rrdgraph_data.pod b/doc/rrdgraph_data.pod
index 95b1ec7..02f9663 100644
--- a/doc/rrdgraph_data.pod
+++ b/doc/rrdgraph_data.pod
@@ -90,6 +90,34 @@ the script, just as if it were generated by a B<DEF> instruction.
 
 Example: C<CDEF:mydatabits=mydata,8,*>
 
+=head1 About CDEF versus VDEF
+
+At some point in processing, B<RRDtool> has gathered an array of rates
+ready to display.
+
+B<CDEF> works on such an array.  For example, I<CDEF:new=ds0,8,*>
+would multiply each of the array members by eight (probably
+transforming bytes into bits). The result is an array containing the
+new values.
+
+B<VDEF> also works on such an array but in a different way.  For
+example, I<VDEF:max=ds0,MAXIMUM> would scan each of the array members
+and store the maximum value.
+
+=head2 When do you use B<VDEF> versus B<CDEF>?  
+
+Use B<CDEF> to transform your data prior to graphing.  In the above
+example, we'd use a B<CDEF> to transform bytes to bits before
+graphing the bits.
+
+You use a B<VDEF> if you want I<max(1,5,3,2,4)> to return five which
+would be displayed in the graph's legend (to answer, what was the
+maximum value during the graph period).
+
+If you want to apply 'complex' operations to the result of a VDEF you have
+to use a CDEF again since VDEFs only look like RPN expressions, they aren't
+realy.
+
 =head1 SEE ALSO
 
 L<rrdgraph> gives an overview of how B<rrdtool graph> works.