Rev 2459: Make the dirstate API changes be prominently documented for upgraders. in file:///home/robertc/source/baz/dirstate/

[Robert Collins]

At file:///home/robertc/source/baz/dirstate/

------------------------------------------------------------
revno: 2459
revision-id: robertc at robertcollins.net-20070301050053-u0ac7vavyzplbjz1
parent: robertc at robertcollins.net-20070301042839-hgs5fy98vuws6iau
committer: Robert Collins <robertc at robertcollins.net>
branch nick: dirstate
timestamp: Thu 2007-03-01 16:00:53 +1100
message:
  Make the dirstate API changes be prominently documented for upgraders.
modified:
  NEWS                           NEWS-20050323055033-4e00b5db738777ff
=== modified file 'NEWS'
--- a/NEWS	2007-02-22 15:04:35 +0000
+++ b/NEWS	2007-03-01 05:00:53 +0000
@@ -1,5 +1,23 @@
 IN DEVELOPMENT
 
+  SURPRISES:
+
+    * For users of bzrlib: Two major changes have been made to the working tree
+      api in bzrlib. The first is that many methods and attributes, including
+      the inventory attribute, are no longer valid for use until one of
+      lock_read/lock_write/lock_tree_write has been called, and become invalid
+      again after unlock is called. This has been done to improve performance
+      and correctness as part of the dirstate development. (Robert Collins,
+      John A Meinel, Martin Pool, and others).
+    * For users of bzrlib: The attribute 'tree.inventory' should be considered
+      readonly. Previously it was possible to directly alter this attribute, or
+      its contents, and have the tree notice this. This has been made
+      unsupported - it may work in some tree formats, but in the newer dirstate
+      format such actions will have no effect and will be ignored, or even
+      cause assertions. All operations possible can still be carried out by a
+      combination of the tree API, and the bzrlib.transform API. (Robert
+      Collins, John A Meinel, Martin Pool, and others).
+
   IMPROVEMENTS:
 
     * Support for OS Windows 98. Also .bzr.log on any windows system