made news the same as the announcement
[rrdtool.git] / NEWS
diff --git a/NEWS b/NEWS
index dc5d532..5497a67 100644 (file)
--- a/NEWS
+++ b/NEWS
 RRDTOOL NEWS
 ============
 RRDTOOL NEWS
 ============
-Major Changes between 1.0.x and 1.2.x
 
 
+#####################################
+Major Changes between 1.2.x and 1.3.x
+-------------------------------------
+
+NEW Fast file access methods (Bernhard Fischer / Tobi Oetiker)
+----------------------------
+* introduced file-accessor functions rrd_read/rrd_seek/rrd_write
+
+* implemented full mmap-based file access with madvise hints for
+  improved scalability, much reduced memory-footprint and much less
+  blocking while accessing the disk
+
+* implemented optional full file-descriptor access instead of FILE*
+  access
+
+NEW Graphing (Tobi Oetiker)
+------------
+* libart has been replaced by cairo/pango
+
+* pango markup is supported (--pango-markup)
+
+* full grid fitting
+
+* --graph-render-mode=mono for non anti aliased graphing
+
+* --font-render-mode=mono for non anti aliased fonts
+
+* fonts come through fontconfig, use the Pango font nameing scheme
+  -> 'Times 20' ... it is not possible to use truetype fonts
+  directly anymore.
+
+* Tabs are position independent.
+
+* TRENDNAN filter that ignores NAN values while calculating the
+  TREND data. (Timo Stripf)
+
+* --full-size-mode to specify the outer border of the image and not
+  just of the graphing canvas (Matthew Chambers)
+
+* TEXTALIGN command to alter default text alignment behavior
+
+* C API in-memory graphing with rrd_graph_v (Evan Miller)
+
+* draw dashed lines in graphs (Thomas Gutzler)
+
+* new interface graphv which returns information using the rrd_info
+  interface (Tobi Oetiker and Mark Plaksin)
+
+* improved horizontal grid. Have a bit more grid lines and y-axis
+  labels while keeping them far enough apart to not run into each
+  other.
+
+NEW Forecasting (Evan Miller)
+---------------
+* the new MHWPREDICT consolidation function uses a variation of the
+  Holt-Winters method. It is a drop-in replacement for HWPREDICT,
+  and is better suited for data whose seasonal variations grow or
+  shrink in proportion to the average.
+
+* If you create an RRD with the new MHWPREDICT function, the
+  resulting rrd file will be version 0004 and can only be used in
+  rrdtool 1.3.
+
+Rewrites
+--------
+* rrd_restore now uses libxml for parsing which makes things much
+  more tolerant towards xml variations. The old code could mostly
+  just parse the XML as it was output by rrdtool dump. See also:
+  the note at the bottom of this document. (by Florian octo
+  Forster)
+
+* rrd_update rewritten to make it more modular. Fixed two
+  longstanding HW bugs in the process (Evan Miller)
+
+Internationalization (Takao Fujiwara and Tobi Oetiker)
+--------------------
+* The help output by rrdtool has been internationalized. There are
+  no real translations included with rrdtool yet, contributions are
+  welcome.
+
+* The internationalization will only be compiled if libintl and
+  friends are available on your system. Use the configure option
+  --disable-libintl if you want to disable this feature
+
+Language Bindings
+-----------------
+* ruby rrd_fetch will return step as a last property -- Mike Perham
+
+RRDtool dump / restore incompatibility
+--------------------------------------
+* rrdtool dump 1.3 does emit completely legal XML. Basically this
+  means that it contains an XML header and a DOCTYPE definition.
+  Unfortunately this causes older versions of rrdtool restore to be
+  unhappy.
+
+* To restore a new dump with an old rrdtool restore version, either
+  remove the XML header and the doctype by hand (both on the first
+  line of the dump) or use rrdtool dump --no-header.
+
+
+######################################################################################
+Major Changes between 1.0.x and 1.2.x
+======================================================================================
 Graphing
 --------
 
 * rewritten graphics generation based on libart.
 Graphing
 --------
 
 * rewritten graphics generation based on libart.
-  - antialiased output
+  - anti-aliased output
   - alpha transparency support
   - truetype fonts
  
 * additional graphics formats: EPS, PDF, SVG
 
   - alpha transparency support
   - truetype fonts
  
 * additional graphics formats: EPS, PDF, SVG
 
-* extended multipart documentation
+* extended multi-part documentation
 
 * VDEF support; define and use variables.  Find, and use, the
   maximum rate seen by rrdtool; compute and show the average
 
 * VDEF support; define and use variables.  Find, and use, the
   maximum rate seen by rrdtool; compute and show the average
@@ -33,17 +135,24 @@ Logging
   Compare current data with expected data, detect and log when
   the rates are outside expected levels
 
   Compare current data with expected data, detect and log when
   the rates are outside expected levels
 
-* COMPUTE datatype for artificial datasources calculating their
-  input using RPN math and data from the other datasources.
+* COMPUTE data type for artificial data-sources calculating their
+  input using RPN math and data from the other data-sources.
  
 Incompatibilities
 -----------------
 * Colons in COMMENT arguments to rrdtool graph must be escaped with a backslash
 
  
 Incompatibilities
 -----------------
 * Colons in COMMENT arguments to rrdtool graph must be escaped with a backslash
 
+* the --alt-y-mrtg option is gone or rather since 1.2.7 it is back but
+  without functionality.
+
+* In pipe mode, rrdtool answers with OK only if it was successful with the
+  command. Otherwhise the answer will be ERROR...
+
+
 Behind the Scenes
 -----------------
 * In order to support Holt-Winters and Calculated Datasources,
 Behind the Scenes
 -----------------
 * In order to support Holt-Winters and Calculated Datasources,
-  the rrdtool dataformat has changed. While the new version of rrdtool can
+  the rrdtool data format has changed. While the new version of rrdtool can
   read files created with rrdtool 1.0.x. It is not possible to read files
   created by rrdtool-1.2.x with rrdtool-1.0.x
 
   read files created with rrdtool 1.0.x. It is not possible to read files
   created by rrdtool-1.2.x with rrdtool-1.0.x
 
@@ -53,70 +162,3 @@ Behind the Scenes
   system.
 
 * Memory Mapped IO support for faster logging.
   system.
 
 * Memory Mapped IO support for faster logging.
-
----------------
-
-  Configure and Makefiles and accordingly.
-
-2002/03/26 Peter Speck <speck@ruc.dk>
-  Contribution of an svg output routine for the new gfx graphing part
-
-2002/03/23 Alex van den Bogaerdt <alex@ergens.op.Het.Net>
-  Several visible changes made to rrd_graph
-  * Pie chart support workable
-  * Elements that are not used do not take up space on the img
-  * Hack for the missing rotated text (see --vertical-label)
-  * Tiny boxes in front of labels now scale with the text
-
-2002/01/15 Tobias Oetiker <tobi@oetiker.ch>
-  The BIG graph update
-  * Replace libgd with libart
-  * Added freetype
-  * Updated zlib and libpng
-  * rrd_gfx.c intrduced as libart wrapper
-  * LINE takes now a float as argument
-  * RRDtool uses truetype for fonts
-  * thanks to libart there is now full alpha transparenc
-    and antialiasing.
-  * the new option --font lets customize the font
-    and size for various graph elements
-  * Updated to -> libtool 1.4.2 automake 2.12 autoconf 2.52
-  * new --zoom commandline option for zoom ans shrinking
-  ---- Still missing is rotatet text for the yaxis description
-  ---- Still missing is tab support in the text rendere
-  ---- Still missing is autoconf support for a default truetype font
-
-2001/07/26 Alex van den Bogaerdt <alex@ergens.op.Het.Net>
-  Added TOTAL to the VDEF functions.
-
-2001/07/19 Alex van den Bogaerdt <alex@ergens.op.Het.Net>
-  VDEF support.  This is a variable containing one value
-  and a time component.  This type of variable can hold
-  the result of a function over a complete time series
-  of data (DEF or CDEF) such as the maximum seen, and when.
-
-2001/03/10 Jake Brutlag <jakeb@corp.webtv.net>
-  Support for COMPUTE data sources (CDEF data sources). Removes the RPN
-  parser and calculator from rrd_graph and puts then in a new file,
-  rrd_rpncalc.c. Changes to core files rrd_create and rrd_update. Some
-  clean-up of aberrant behavior stuff, including a bug fix. 
-  Documentation update (rrdcreate.pod, rrdupdate.pod). Change xml format.
-  
-2001/03/07 Tobias Oetiker <oetiker@ee.ethz.ch> 
-  Integrated complete rewrite
-  of rrdgraph documentation by Alex van den Bogaerdt
-  <alex@ergens.op.Het.Net>. This also contains info on his planned
-  changes to the rrdgraph module
-
-2001/03/02 Tobias Oetiker <oetiker@ee.ethz.ch>
-  Added Aberrant Patch from Jake Brutlag <jakeb@microsoft.com>
-  From now one, new rrd files use version tag 0002. They can
-  NOT be read by the old 1.0.x RRDtools. 
-  Jake:
-  Aberrant Behavior Detection support. A brief overview added to
-  rrdtool.pod.  Major updates to rrd_update.c, rrd_create.c. Minor update to
-  other core files.  Updated documentation: rrdcreate.pod, rrdgraph.pod,
-  rrdtune.pod.  This is backwards compatible (i.e. new tool can read and will
-  leave the binary header unchanged for old files).
-  See http://cricket.sourceforge.net/aberrant/rrd_hw.htm