Rev 5506: Document hunk editing when shelving. in http://bazaar.launchpad.net/~vila/bzr/integration/

[Vincent Ladeuil]

At http://bazaar.launchpad.net/~vila/bzr/integration/

------------------------------------------------------------
revno: 5506 [merge]
revision-id: v.ladeuil+lp at free.fr-20101018110607-nsiigg3j8egyfdmp
parent: pqm at pqm.ubuntu.com-20101018104738-4rhxk936z09b8t19
parent: nmb at wartburg.edu-20101018043449-od1pxjn295kq5gow
committer: Vincent Ladeuil <v.ladeuil+lp at free.fr>
branch nick: trunk
timestamp: Mon 2010-10-18 13:06:07 +0200
message:
  Document hunk editing when shelving.
modified:
  bzrlib/builtins.py             builtins.py-20050830033751-fc01482b9ca23183
  doc/en/release-notes/bzr-2.3.txt NEWS-20050323055033-4e00b5db738777ff
-------------- next part --------------
=== modified file 'bzrlib/builtins.py'
--- a/bzrlib/builtins.py	2010-10-18 04:55:38 +0000
+++ b/bzrlib/builtins.py	2010-10-18 11:06:07 +0000
@@ -5907,6 +5907,18 @@
 
     You can put multiple items on the shelf, and by default, 'unshelve' will
     restore the most recently shelved changes.
+
+    For complicated changes, it is possible to edit the changes in a separate
+    editor program to decide what the file remaining in the working copy
+    should look like.  To do this, add the configuration option
+
+        change_editor = PROGRAM @new_path @old_path
+
+    where @new_path is replaced with the path of the new version of the 
+    file and @old_path is replaced with the path of the old version of 
+    the file.  The PROGRAM should save the new file with the desired 
+    contents of the file in the working tree.
+        
     """
 
     takes_args = ['file*']
@@ -5924,7 +5936,7 @@
         Option('destroy',
                help='Destroy removed changes instead of shelving them.'),
     ]
-    _see_also = ['unshelve']
+    _see_also = ['unshelve', 'configuration']
 
     def run(self, revision=None, all=False, file_list=None, message=None,
             writer=None, list=False, destroy=False, directory=u'.'):

=== modified file 'doc/en/release-notes/bzr-2.3.txt'
--- a/doc/en/release-notes/bzr-2.3.txt	2010-10-18 04:55:38 +0000
+++ b/doc/en/release-notes/bzr-2.3.txt	2010-10-18 11:06:07 +0000
@@ -58,6 +58,9 @@
 Documentation
 *************
 
+* Add documentation of the ability to edit hunks when shelving.
+  (Neil Martinsen-Burrell, #517660)
+
 * Document the comment character in the .bzrignore file, including a
   workaround for ignore patterns that begin with #.
   (Neil Martinsen-Burrell, #621515)