From: oetiker Date: Mon, 25 Apr 2005 19:07:18 +0000 (+0000) Subject: resolved all XXX situations X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=26f7c5c1ba83c8ab82cd271b143061f7fb13394c;p=rrdtool.git resolved all XXX situations git-svn-id: svn://svn.oetiker.ch/rrdtool/branches/1.2/program@426 a5681a0c-68f1-0310-ab6d-d61299d08faa --- diff --git a/doc/rpntutorial.pod b/doc/rpntutorial.pod index 9829eb8..86312cd 100644 --- a/doc/rpntutorial.pod +++ b/doc/rpntutorial.pod @@ -96,11 +96,7 @@ multiplication operator: Now let's go back to the first example of multiple logic operators, but replace the value 20 with the variable "input": -=for comment -XXX wo kommt das A ploetzlich her? Hier braucht es einen Satz, dass A als -XXX placeholder zum Lesbarmachen verwendet wird (shortcut). - - 1) input,10,GT,10,input,IF eval is input,10,GT result is A + 1) input,10,GT,10,input,IF eval is input,10,GT ( lets call this A ) Read eval as "if input > 10 then true" and replace "input,10,GT" with "A": diff --git a/doc/rrdcgi.pod b/doc/rrdcgi.pod index 45d24ec..fcd5ad7 100644 --- a/doc/rrdcgi.pod +++ b/doc/rrdcgi.pod @@ -114,11 +114,8 @@ argument to a GRAPH command. =item RRD::GRAPH I -=for comment -XXX Shouldn't it be IMAGE-tag below? Fritz - This tag creates the RRD graph defined by its argument and then is -replaced by an appropriate EIMGE tag referring to the graph. +replaced by an appropriate EIMG ... E tag referring to the graph. The B<--lazy> option in RRD graph can be used to make sure that graphs are only regenerated when they are out of date. The arguments to the B tag work as described in the B manual page. diff --git a/doc/rrdfetch.pod b/doc/rrdfetch.pod index 6eb10d1..a6382b9 100644 --- a/doc/rrdfetch.pod +++ b/doc/rrdfetch.pod @@ -135,14 +135,12 @@ or just B. You can suffix it with B or B or use including B (00:00), B (12:00) and British B (16:00). -=for comment -XXX Wouldn't it be nice to have z'N\"uni and z'Vieri for Switzerland? - -The I can be specified as I I -and optional a 2- or 4-digit I number (e.g. March 8 1999). -Alternatively, you can use I (e.g. Monday), -or one of the words: B, B, B. -You can also specify the I as a full date in several numerical formats, including B, B, or B. +The I can be specified as I I and +optional a 2- or 4-digit I number (e.g. March 8 1999). Alternatively, +you can use I (e.g. Monday), or one of the words: +B, B, B. You can also specify the I as a +full date in several numerical formats, including B, +B, or B. I: this is different from the original at(1) behavior, where a single-number date is interpreted as MMDD[YY]YY. diff --git a/doc/rrdgraph_data.pod b/doc/rrdgraph_data.pod index 975c385..5b71c87 100644 --- a/doc/rrdgraph_data.pod +++ b/doc/rrdgraph_data.pod @@ -41,8 +41,6 @@ from an B. For instance, if your B has an B with a resolution of 1800 seconds per B, you should create an image with width 400 and time span 400*1800 seconds (use appropriate start and end times, such as C<--start end-8days8hours>). -=for comment -XXX is the above start/end syntax correct? Fritz If consolidation needs to be done, the B of the B specified in the B itself will be used to reduce the data density. This behaviour can diff --git a/doc/rrdgraph_examples.pod b/doc/rrdgraph_examples.pod index b5280ae..f09ce84 100644 --- a/doc/rrdgraph_examples.pod +++ b/doc/rrdgraph_examples.pod @@ -48,10 +48,7 @@ Note: 10 spaces to move text to the right COMMENT:" " -=for comment -XXX I don't understand the following; Fritz - -Note: three times size == 11 chars, "###.## xBps" +Note: the column titles have to be as wide as the columns COMMENT:"Maximum " COMMENT:"Average " diff --git a/doc/rrdgraph_graph.pod b/doc/rrdgraph_graph.pod index 94bfdbc..84597f6 100644 --- a/doc/rrdgraph_graph.pod +++ b/doc/rrdgraph_graph.pod @@ -208,6 +208,9 @@ a variable here. =cut +#### This section describes the curruently defunct +#### PieChart code. + =item BB<:>IB<#>I[I][B<:>I] B has now support for B. If you include the @@ -221,8 +224,8 @@ is defined by the value part of the L function. It should return a number between 0 and 100, being a percentage. Providing wrong input will produce undefined results. -=for comment -XXX Above: shouldn't this be caught and and error be generated? Fritz +#### +#### =pod diff --git a/doc/rrdgraph_rpn.pod b/doc/rrdgraph_rpn.pod index c24be0f..ff50865 100644 --- a/doc/rrdgraph_rpn.pod +++ b/doc/rrdgraph_rpn.pod @@ -72,12 +72,9 @@ Z<> B Pops two elements from the stack and returns the smaller or larger, -respectively. The two numbers shouldn't be I or I, -if they are that value is pushed back onto the stack as the result. - -= for comment -XXX What happens above if both a infinite and undefined value are on the -XXX stack? Fritz +respectively. Note that I is larger than anything else. +If one of the input numbers is I then the result of the operation will be +I too. B diff --git a/doc/rrdtutorial.pod b/doc/rrdtutorial.pod index fed67ec..e43830c 100644 --- a/doc/rrdtutorial.pod +++ b/doc/rrdtutorial.pod @@ -40,12 +40,12 @@ data from them. =head2 What data can be put into an RRD? -XXX time series ??? XXX You name it, it will probably fit. You should -be able to measure some value at several points in time and provide -this information to RRDtool. If you can do this, RRDtool will be able -to store it. The values must be numerical but don't have to be -integers, as is the case with MRTG (the next section will give more -details on this more specialized application). +You name it, it will probably fit as long as it is some sort of time-series +data. This means you have to be able to measure some value at several points in time and +provide this information to RRDtool. If you can do this, RRDtool will be +able to store it. The values must be numerical but don't have to be +integers, as is the case with MRTG (the next section will give more details +on this more specialized application). Many examples below talk about SNMP which is an acronym for Simple Network Management Protocol. "Simple" refers to the protocol -- it does not @@ -227,13 +227,9 @@ represents a counter. This counter is read every five minutes (default). In the same database two round robin archives (RRAs) are kept, one averages the data every time it is read (e.g., there's nothing to average) and keeps 24 samples (24 times 5 minutes is 2 -hours). The other averages 6 values (half hour) and contains 10 of +hours). The other averages 6 values (half hour) and contains 10 such averages (e.g., 5 hours). -=for comment - XXX The remaining options will be discussed later on. (there aren't any - XXX in the example above, Fritz) - RRDtool works with special time stamps coming from the UNIX world. This time stamp is the number of seconds that passed since January 1st 1970 UTC. The time stamp value is translated into local time and @@ -413,21 +409,20 @@ Rader's tutorial on RPN. But first finish this tutorial. Hang on! If we can multiply values with 1'000, it should also be possible to display kilometers per hour from the same data! -=for comment -XXX strange format below: -*- ; Fritz - To change a value that is measured in meters per second: - -*- Calculate meters per hour: value * 3'600 - -*- Calculate kilometers per hour: value / 1'000 - -*- Together this makes: value * (3'600/1'000) or value * 3.6 + + Calculate meters per hour: value * 3'600 + Calculate kilometers per hour: value / 1'000 + Together this makes: value * (3'600/1'000) or value * 3.6 In our example database we made a mistake and we need to compensate for this by multiplying with 1'000. Applying that correction: - -*- value * 3.6 * 1'000 == value * 3'600 + + value * 3.6 * 1'000 == value * 3'600 Now let's create this PNG, and add some more magic ... - rrdtool graph speed3.png \ + rrdtool graph speed3.png \ --start 920804400 --end 920808000 \ --vertical-label km/h \ DEF:myspeed=test.rrd:speed:AVERAGE \