Rev 5417: Add NEWS entry, tweak osutils.available_backup_name docstring. in file:///home/vila/src/bzr/bugs/323111-orphans/

[Vincent Ladeuil]

At file:///home/vila/src/bzr/bugs/323111-orphans/

------------------------------------------------------------
revno: 5417
revision-id: v.ladeuil+lp at free.fr-20100909202015-uwo1zl3ghnw1ogkk
parent: v.ladeuil+lp at free.fr-20100909195111-xta4ws1g50jluhhb
committer: Vincent Ladeuil <v.ladeuil+lp at free.fr>
branch nick: backup-names
timestamp: Thu 2010-09-09 22:20:15 +0200
message:
  Add NEWS entry, tweak osutils.available_backup_name docstring.
-------------- next part --------------
=== modified file 'NEWS'
--- a/NEWS	2010-09-03 02:53:10 +0000
+++ b/NEWS	2010-09-09 20:20:15 +0000
@@ -20,6 +20,10 @@
   is now named "msg" instead of earlier "message".
   (Parth Malwankar, #603461)
 
+* ``BzrDir.generate_backup_name`` has been deprecated and replaced by a
+  private method. ``osutils.available_backup_name`` provides an extensible
+  replacement. (Vincent Ladeuil)
+
 * ``bzrlib.transform.TreeTransformBase.final_kind``,
   ``bzrlib.transform.TreeTransform.tree_kind`` and
   ``bzrlib.transform.TransformPreview.tree_kind`` now return None instead

=== modified file 'bzrlib/osutils.py'
--- a/bzrlib/osutils.py	2010-09-09 09:27:33 +0000
+++ b/bzrlib/osutils.py	2010-09-09 20:20:15 +0000
@@ -2359,7 +2359,9 @@
 def available_backup_name(base, exists):
     """Find a non-existing backup file name.
 
-    This will *not* create anything, this only return a 'free' entry.
+    This will *not* create anything, this only return a 'free' entry.  This
+    should be used for checking names in a directory below a locked
+    tree/branch/repo to avoid race conditions.
 
     :param base: The base name.
     :param exists: A callable returning True if the passed path exists.