From: Michael Vrable <mvrable@cs.ucsd.edu>
Date: Tue, 15 Jan 2008 21:57:55 +0000 (-0800)
Subject: Documentation updates.
X-Git-Url: https://git.vrable.net/?a=commitdiff_plain;h=be68c96ef7500b196bc347498b0e9a4a51663ba3;p=cumulus.git

Documentation updates.
---

diff --git a/NEWS b/NEWS
index 32bea66..d1318ca 100644
--- a/NEWS
+++ b/NEWS
@@ -2,9 +2,10 @@
     - 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.
-      Updated tools will be needed to properly understand the new
-      snapshots.  Tools will continue to be able to read the old
-      snapshot format.
+      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
@@ -14,6 +15,14 @@
       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
diff --git a/TODO b/TODO
new file mode 100644
index 0000000..8bd8e1d
--- /dev/null
+++ b/TODO
@@ -0,0 +1,11 @@
+* Allow different fields to be written out to the metadata log and the
+statcache file.
+
+* Implement a scheme for cleaning metadata log segments when metadata is
+re-used.
+
+* Allow direct backup to a remote network server, probably implemented
+using an external helper script which is called to transfer a file.
+
+* Continue to investigate schemes for adding parity blocks for error
+recovery.