Update the NEWS file with some information about format changes.
[cumulus.git] / NEWS
1 0.6
2     - SNAPSHOT FORMAT CHANGE: A few minor tweaks have been made to the
3       snapshot format.  There is nothing substantial--this is primarily
4       a cleaning up of the format before use becomes more widespread.
5       Updated tools will be needed to properly understand the new
6       snapshots.  Tools will continue to be able to read the old
7       snapshot format.
8     - LOCAL DATABASE CHANGE: The local database has been changed so that
9       segment utilization data for past snapshots is stored more
10       efficiently.  The script in contrib/upgrade0.6-localdb.sql must be
11       run on a database to upgrade it prior to running backups with the
12       new tool.
13     - The statcache implementation has been reworked, and the format
14       changed.  The first backup will run more slowly since the old
15       statcache data will be ignored.  New statcache data will be
16       written to statcache2.  The old statcache file can be deleted.
17
18 0.5.1 [2007-11-13]
19     - Have the lbs-util tool check the version number when reading a
20       snapshot, and signal an error if the format is not recognized.
21     - Include a sample script, contrib/parity-gen, for creating
22       RAID-like parity sets to recover from some segment corruption.
23       The par2 command (http://parchive.sourceforge.net/) is used to
24       actually generate the parity sets; the parity-gen script simply
25       automates maintaining the parity sets.
26
27 0.5 [2007-10-16]
28     - Much improved Python interface for accessing and manipulating LBS
29       archives and local database information.  The interface should not
30       yet be considered completely stable.
31     - Python implementation of lbs-util now includes most of the
32       features of the Perl implementation, plus some other new features.
33       The Perl library and utility are deprecated and have been removed
34       from this release.
35     - Preliminary snapshot restore support in lbs-util.  This is still
36       not yet extensively tested.
37
38 0.4 [2007-08-24]
39     - Documentation improvements: a getting started README, and a
40       description of some of the implementation details.
41     - Include an example filter script, lbs-filter-gpg, for encrypting
42       segment data as it is written.
43     - Add support for signed snapshot descriptor files (via the
44       --signature-filter option).  Due to the checksums contained in the
45       snapshot descriptor, the signature covers the entire contents of
46       the snapshot.
47     - Preview release of lbs-util.py, a Python-based program for
48       managing LBS snapshots.  It currently implements a very simple
49       form of automatic segment cleaning, though this isn't much tested.
50     - Improved segment repacking support; after cleaning segments,
51       objects can be written out in different groups based on age.  This
52       may help with long-term segment cleaning efficiency, but probably
53       needs more tuning.
54
55 0.3 [2007-08-10]
56     - LOCAL DATABASE CHANGE: A checksums file is now written out along
57       with the snapshot descriptor that contains checksums of segments
58       used in a snapshot.  This will allow quick integrity checks of a
59       snapshot, without needing to decompress or decrypt the segment
60       files.  The local database schema was modified to store the
61       checksums for segments.
62     - Build dependence on libtar has been dropped.  All necessary
63       support for writing TAR files is now directly included with the
64       source.
65     - The snapshot format is now documented, at least in part.  See
66       format.txt.
67     - Snapshots now include link count and inode number for files with
68       multiple hard links, so that a restore program could determine
69       which files should be hard linked on restore.  The reference
70       restore.pl script does not use this.
71     - Bugfix: Print a help message instead of crashing if no files are
72       specified.
73     - Bugfix: File descriptors of files being backed up were closed
74       twice.  In some cases this might have led to an unrelated file
75       being closed (if the file descriptor was quickly re-used).
76     - Preview of a new lbs-util command for maintaining snapshots.
77       Functionality is currently limited.
78
79 0.2.2 [2007-07-27]
80     - Update reference restore.pl script to handle octal/hexadecimal
81       (format change introduced in 0.2).
82     - Better support for mixing multiple backup schemes: the statcache
83       file is now per-scheme, so performance should be better in cases
84       where multiple different backups (of different source directories)
85       are made, all sharing the same local database directory.
86
87 0.2.1 [2007-07-20]
88     - Bugfix: Do not print an error when only one directory is specified
89       to back up.
90
91 0.2 [2007-07-20]
92     - SNAPSHOT FORMAT CHANGE: Metadata logs in backups can now contain
93       octal and hexadecimal values.  Old restore programs may not be
94       able to read these new backups.  The reference restore.pl script
95       has not yet been updated.
96     - LOCAL DATABASE CHANGE: Backups may be assigned a name with the
97       --scheme= command-line option, to allow different backup sets to
98       be mixed in the same directory.  The database schema for the local
99       database is changed.
100     - Improved selection (inclusion/exclusion) of files to be included
101       in a backup.
102     - Device major/minor numbers are dumped for block and character
103       devices.
104
105 0.1 [2007-07-14]
106     - Initial release.