Rev 5434: Better docs. in file:///home/vila/src/bzr/bugs/323111-orphans/

[Vincent Ladeuil]

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

------------------------------------------------------------
revno: 5434
revision-id: v.ladeuil+lp at free.fr-20101015145742-8uhqzb1rks3law3f
parent: v.ladeuil+lp at free.fr-20101015142103-xmh9nam9uekj3jq0
committer: Vincent Ladeuil <v.ladeuil+lp at free.fr>
branch nick: orphan-config-option
timestamp: Fri 2010-10-15 16:57:42 +0200
message:
  Better docs.
-------------- next part --------------
=== modified file 'bzrlib/help_topics/en/conflict-types.txt'
--- a/bzrlib/help_topics/en/conflict-types.txt	2010-10-15 11:10:34 +0000
+++ b/bzrlib/help_topics/en/conflict-types.txt	2010-10-15 14:57:42 +0000
@@ -257,8 +257,8 @@
 
 There are two possible values for this option:
 
-* ``never`` (the default): will leave the orphans in place and generate a
-  conflicts,
+* ``conflict`` (the default): will leave the orphans in place and
+  generate a conflicts,
 
 * ``move``: will move the orphans to a ``bzr-orphans`` directory at the root
   of the working tree with names like ``<file>.~#~``.

=== modified file 'bzrlib/transform.py'
--- a/bzrlib/transform.py	2010-10-15 14:21:03 +0000
+++ b/bzrlib/transform.py	2010-10-15 14:57:42 +0000
@@ -1412,10 +1412,12 @@
 
 
 orphaning_registry = registry.Registry()
-orphaning_registry.register('conflict', refuse_orphan,
-                            'Never create orphans.')
-orphaning_registry.register('move', move_orphan,
-                            'Move orphans into the bzr-orphans directory.')
+orphaning_registry.register(
+    'conflict', refuse_orphan,
+    'Leave orphans in place and create a conflict on the directory.')
+orphaning_registry.register(
+    'move', move_orphan,
+    'Move orphans into the bzr-orphans directory.')
 orphaning_registry._set_default_key('conflict')
 
 

=== modified file 'doc/en/release-notes/bzr-2.3.txt'
--- a/doc/en/release-notes/bzr-2.3.txt	2010-10-15 14:21:03 +0000
+++ b/doc/en/release-notes/bzr-2.3.txt	2010-10-15 14:57:42 +0000
@@ -159,18 +159,13 @@
 * ``unshelve --preview`` now can show diff in a non-ascii encoding.
   (Andrej A Antonov, #518916)
 
-* When a bzr command remove a previously versioned directory, all
-  unversioned files are moved to a 'bzr-orphans' directory at the working
-  tree root with backup names (<file>.~#~). This was previously creating
-  spurious conflicts during merge, pull or switch operations.
-
-* It's now possible to request orphan creation when a versioned directory
-  should be deleted (when doing a pull, a merge or switch) via the
-  ``bzr.transform.orphan_policy`` configuration variable. Acceptable values
-  are ``conflict`` (the default behaviour that refuse to delete the
-  directory) or ``move`` to create orphans (the unversioned files present
-  in the directory). The orphans will be named ``<file>.~#~``.
-  (Vincent Ladeuil, #323111)
+* Deleting a versioned directory can leave orphans: unversioned files that
+  were present don't have a parent anymore. The
+  ``bzr.transform.orphan_policy`` configuration option controls the ``bzr``
+  behaviour: ``conflict`` (the default) leave the orphans in place and
+  create a conflict for the directory, ``move`` create orphans named
+  ``<file>.~#~`` in a ``bzr-orphans`` directory at the root of the working
+  tree.  (Vincent Ladeuil, #323111)
 
 Improvements
 ************

=== modified file 'doc/en/whats-new/whats-new-in-2.3.txt'
--- a/doc/en/whats-new/whats-new-in-2.3.txt	2010-10-15 11:10:34 +0000
+++ b/doc/en/whats-new/whats-new-in-2.3.txt	2010-10-15 14:57:42 +0000
@@ -97,12 +97,12 @@
 * ``pull``, ``merge`` or ``switch`` can lead to conflicts when deleting a
   versioned directory contains unversioned files. The cause of the conflict
   is that deleting the directory will orphan the unversioned files so the
-  user needs to instruct ``bzr`` what do to do about these orpahns. This
-  can is controlled by setting the ``bzr.transform.orphan_policy``
-  configuration variable with a value of ``move``. In this case the
-  unversioned files are moved to a ``bzr-orphans`` directory at the root of
-  the working tree. The default behaviour is specified (if needed) by
-  setting the variable to ``conflict``.  (Vincent Ladeuil, #323111)
+  user needs to instruct ``bzr`` what do to do about these orpahns. This is
+  controlled by setting the ``bzr.transform.orphan_policy`` configuration
+  variable with a value of ``move``. In this case the unversioned files are
+  moved to a ``bzr-orphans`` directory at the root of the working tree. The
+  default behaviour is specified (if needed) by setting the variable to
+  ``conflict``.  (Vincent Ladeuil, #323111)
 
 Documentation
 *************