Rev 5204: Document the API break. in http://bazaar.launchpad.net/~lifeless/bzr/lock_return

[Robert Collins]

At http://bazaar.launchpad.net/~lifeless/bzr/lock_return

------------------------------------------------------------
revno: 5204
revision-id: robertc at robertcollins.net-20100506234939-prhk3x301ag1y1ai
parent: robertc at robertcollins.net-20100506234135-yivbzczw1sejxnxc
committer: Robert Collins <robertc at robertcollins.net>
branch nick: lock_return
timestamp: Fri 2010-05-07 11:49:39 +1200
message:
  Document the API break.
=== modified file 'NEWS'
--- a/NEWS	2010-05-06 23:41:35 +0000
+++ b/NEWS	2010-05-06 23:49:39 +0000
@@ -13,6 +13,12 @@
 Compatibility Breaks
 ********************
 
+* An API break has been made to the lock_write method of ``Branch`` and
+  ``Repository`` objects; they now return ``branch.BranchWriteLockResult``
+  and ``repository.RepositoryWriteLockResult`` objects. This makes
+  changing the API in future easier and permits some cleaner calling code.
+  (Robert Collins)
+
 New Features
 ************