From: rkinyon <rkinyon@50811bd7-b8ce-0310-adc1-d9db26280581>
Date: Mon, 19 Feb 2007 12:06:57 +0000 (+0000)
Subject: Documentation
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=e61e2e0904b17731ba6b56df272ec236c20bbfe2;p=dbsrgits%2FDBM-Deep.git

Documentation
---

diff --git a/lib/DBM/Deep.pod b/lib/DBM/Deep.pod
index 1fd95c2..918168b 100644
--- a/lib/DBM/Deep.pod
+++ b/lib/DBM/Deep.pod
@@ -936,12 +936,6 @@ the transaction.
 Transactions in DBM::Deep are done using a variant of the MVCC method, the
 same method used by the InnoDB MySQL engine.
 
-=head2 Software-Transactional Memory
-
-The addition of transactions to this module provides the basis for STM within
-Perl 5. Contention is resolved using a default last-write-wins. Currently,
-this default cannot be changed, but it will be addressed in a future version.
-
 =head1 PERFORMANCE
 
 Because DBM::Deep is a conncurrent datastore, every change is flushed to disk
@@ -984,6 +978,16 @@ DBM::Deep to use 16bit addresses, meaning that the seek times will be less.
 
 =back
 
+=head1 MIGRATION
+
+As of 1.0000, the file format has changed. Furthermore, DBM::Deep is now
+designed to potentially change file format between point-releases, if needed to
+support a requested feature. To aid in this, a migration script is provided
+within the CPAN distribution called C<utils/upgrade_db.pl>.
+
+B<NOTE:> This script is not installed onto your system because it carries a copy
+of every version prior to the current version.
+
 =head1 TODO
 
 The following are items that are planned to be added in future releases. These
diff --git a/utils/upgrade_db.pl b/utils/upgrade_db.pl
index 226488e..2badd62 100755
--- a/utils/upgrade_db.pl
+++ b/utils/upgrade_db.pl
@@ -169,9 +169,11 @@ This is the name of target output DB file.
 =item B<-version>
 
 Optionally, you can specify the version of L<DBM::Deep> for the output file.
-This can either be an upgrade or a downgrade.
+This can either be an upgrade or a downgrade. The minimum version supported is
+0.91.
 
-If the version is the same, this is just like a call to compress().
+If the version is the same as the input file, this acts like a compressed copy
+of the database.
 
 =item B<-autobless>
 
@@ -184,7 +186,7 @@ Prints a brief help message, then exits.
 
 =item B<-man>
 
-Prints this longer message, then exits;
+Prints a much longer message, then exits;
 
 =back