Minor documentation updates.
[cumulus.git] / NEWS
diff --git a/NEWS b/NEWS
index 312638e..19c2377 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,4 +1,67 @@
-0.3
+0.6 [???]
+    - SNAPSHOT FORMAT CHANGE: A few minor tweaks have been made to the
+      snapshot format.  There is nothing substantial--this is primarily
+      a cleaning up of the format before use becomes more widespread.
+      An efficient and explicit means for representing sparse files has
+      been added to the format.  Updated tools will be needed to
+      properly understand the new snapshots.  Tools will continue to be
+      able to read the old snapshot format.
+    - LOCAL DATABASE CHANGE: The local database has been changed so that
+      segment utilization data for past snapshots is stored more
+      efficiently.  The script in contrib/upgrade0.6-localdb.sql must be
+      run on a database to upgrade it prior to running backups with the
+      new tool.
+    - The statcache implementation has been reworked, and the format
+      changed.  The first backup will run more slowly since the old
+      statcache data will be ignored.  New statcache data will be
+      written to statcache2.  The old statcache file can be deleted.
+    - Metadata is shared between snapshots where possible.  The
+      --full-metadata option can be used to disable this (completely
+      writing out all metadata with the new snapshot).
+    - Add an "intent" field to snapshots, which specifies informally how
+      long a snapshot is intended to be kept.  For example, 1 can be
+      used for daily snapshots, and 7 for weekly snapshots.  Segment
+      cleaning is now partly guided by intent values, but tuning of the
+      cleaning algorithms is not yet finished.
+
+0.5.1 [2007-11-13]
+    - Have the lbs-util tool check the version number when reading a
+      snapshot, and signal an error if the format is not recognized.
+    - Include a sample script, contrib/parity-gen, for creating
+      RAID-like parity sets to recover from some segment corruption.
+      The par2 command (http://parchive.sourceforge.net/) is used to
+      actually generate the parity sets; the parity-gen script simply
+      automates maintaining the parity sets.
+
+0.5 [2007-10-16]
+    - Much improved Python interface for accessing and manipulating LBS
+      archives and local database information.  The interface should not
+      yet be considered completely stable.
+    - Python implementation of lbs-util now includes most of the
+      features of the Perl implementation, plus some other new features.
+      The Perl library and utility are deprecated and have been removed
+      from this release.
+    - Preliminary snapshot restore support in lbs-util.  This is still
+      not yet extensively tested.
+
+0.4 [2007-08-24]
+    - Documentation improvements: a getting started README, and a
+      description of some of the implementation details.
+    - Include an example filter script, lbs-filter-gpg, for encrypting
+      segment data as it is written.
+    - Add support for signed snapshot descriptor files (via the
+      --signature-filter option).  Due to the checksums contained in the
+      snapshot descriptor, the signature covers the entire contents of
+      the snapshot.
+    - Preview release of lbs-util.py, a Python-based program for
+      managing LBS snapshots.  It currently implements a very simple
+      form of automatic segment cleaning, though this isn't much tested.
+    - Improved segment repacking support; after cleaning segments,
+      objects can be written out in different groups based on age.  This
+      may help with long-term segment cleaning efficiency, but probably
+      needs more tuning.
+
+0.3 [2007-08-10]
     - LOCAL DATABASE CHANGE: A checksums file is now written out along
       with the snapshot descriptor that contains checksums of segments
       used in a snapshot.  This will allow quick integrity checks of a
@@ -19,6 +82,8 @@
     - Bugfix: File descriptors of files being backed up were closed
       twice.  In some cases this might have led to an unrelated file
       being closed (if the file descriptor was quickly re-used).
+    - Preview of a new lbs-util command for maintaining snapshots.
+      Functionality is currently limited.
 
 0.2.2 [2007-07-27]
     - Update reference restore.pl script to handle octal/hexadecimal