Rev 4971: (nmb) Improve revert documentation of pending merges in file:///home/pqm/archives/thelove/bzr/%2Btrunk/

[Canonical.com Patch Queue Manager]

At file:///home/pqm/archives/thelove/bzr/%2Btrunk/

------------------------------------------------------------
revno: 4971 [merge]
revision-id: pqm at pqm.ubuntu.com-20100118183511-t20mudbbaunoip4t
parent: pqm at pqm.ubuntu.com-20100118174722-3z5e479b2tjvaw22
parent: nmb at wartburg.edu-20100118022555-a3ott6qcsch43zwi
committer: Canonical.com Patch Queue Manager <pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Mon 2010-01-18 18:35:11 +0000
message:
  (nmb) Improve revert documentation of pending merges
modified:
  NEWS                           NEWS-20050323055033-4e00b5db738777ff
  bzrlib/builtins.py             builtins.py-20050830033751-fc01482b9ca23183
=== modified file 'NEWS'
--- a/NEWS	2010-01-17 20:06:41 +0000
+++ b/NEWS	2010-01-18 18:35:11 +0000
@@ -111,6 +111,9 @@
   should appear up-to-date.)
   (John Arbash Meinel, Martin <gzlist>, #488724)
 
+* Improve discussion of pending merges in the documentation for
+  ``revert``.  (Neil Martinsen-Burrell, #505093)
+
 Improvements
 ************
 

=== modified file 'bzrlib/builtins.py'
--- a/bzrlib/builtins.py	2010-01-15 04:05:36 +0000
+++ b/bzrlib/builtins.py	2010-01-18 18:35:11 +0000
@@ -4083,22 +4083,23 @@
     created as above.  Directories containing unknown files will not be
     deleted.
 
-    The working tree contains a list of pending merged revisions, which will
-    be included as parents in the next commit.  Normally, revert clears that
-    list as well as reverting the files.  If any files are specified, revert
-    leaves the pending merge list alone and reverts only the files.  Use "bzr
-    revert ." in the tree root to revert all files but keep the merge record,
-    and "bzr revert --forget-merges" to clear the pending merge list without
+    The working tree contains a list of revisions that have been merged but
+    not yet committed. These revisions will be included as additional parents
+    of the next commit.  Normally, using revert clears that list as well as
+    reverting the files.  If any files are specified, revert leaves the list
+    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
+    .`` in the tree root to revert all files but keep the recorded merges,
+    and ``bzr revert --forget-merges`` to clear the pending merge list without
     reverting any files.
 
-    Using "bzr revert --forget-merges", it is possible to apply the changes
-    from an arbitrary merge as a single revision.  To do this, perform the
-    merge as desired.  Then doing revert with the "--forget-merges" option will
-    keep the content of the tree as it was, but it will clear the list of
-    pending merges.  The next commit will then contain all of the changes that
-    would have been in the merge, but without any mention of the other parent
-    revisions.  Because this technique forgets where these changes originated,
-    it may cause additional conflicts on later merges involving the source and
+    Using "bzr revert --forget-merges", it is possible to apply all of the
+    changes from a branch in a single revision.  To do this, perform the merge
+    as desired.  Then doing revert with the "--forget-merges" option will keep
+    the content of the tree as it was, but it will clear the list of pending
+    merges.  The next commit will then contain all of the changes that are
+    present in the other branch, but without any other parent revisions.
+    Because this technique forgets where these changes originated, it may
+    cause additional conflicts on later merges involving the same source and
     target branches.
     """