Rev 5507: Document revision ranges for diff. in http://bazaar.launchpad.net/~vila/bzr/integration/

[Vincent Ladeuil]

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

------------------------------------------------------------
revno: 5507 [merge]
revision-id: v.ladeuil+lp at free.fr-20101018123603-g70x0vt75z3aygu0
parent: pqm at pqm.ubuntu.com-20101018115718-cbuoc2gafnjldngk
parent: nmb at wartburg.edu-20101018041145-666nlwc98l85gemt
committer: Vincent Ladeuil <v.ladeuil+lp at free.fr>
branch nick: trunk
timestamp: Mon 2010-10-18 14:36:03 +0200
message:
  Document revision ranges for diff.
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 11:06:07 +0000
+++ b/bzrlib/builtins.py	2010-10-18 12:36:03 +0000
@@ -1866,6 +1866,13 @@
     "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
     produces patches suitable for "patch -p1".
 
+    Note that when using the -r argument with a range of revisions, the
+    differences are computed between the two specified revisions.  That
+    is, the command does not show the changes introduced by the first 
+    revision in the range.  This differs from the interpretation of 
+    revision ranges used by "bzr log" which includes the first revision
+    in the range.
+
     :Exit values:
         1 - changed
         2 - unrepresentable changes
@@ -1889,7 +1896,11 @@
 
             bzr diff -r1..3 xxx
 
-        To see the changes introduced in revision X::
+        The changes introduced by revision 2 (equivalent to -r1..2)::
+
+            bzr diff -c2
+
+        To see the changes introduced by revision X::
         
             bzr diff -cX
 
@@ -1899,9 +1910,10 @@
 
             bzr diff -r<chosen_parent>..X
 
-        The changes introduced by revision 2 (equivalent to -r1..2)::
+        The changes between the current revision and the previous revision
+        (equivalent to -c-1 and -r-2..-1)
 
-            bzr diff -c2
+            bzr diff -r-2..
 
         Show just the differences for file NEWS::
 

=== modified file 'doc/en/release-notes/bzr-2.3.txt'
--- a/doc/en/release-notes/bzr-2.3.txt	2010-10-18 11:06:07 +0000
+++ b/doc/en/release-notes/bzr-2.3.txt	2010-10-18 12:36:03 +0000
@@ -61,6 +61,9 @@
 * Add documentation of the ability to edit hunks when shelving.
   (Neil Martinsen-Burrell, #517660)
 
+* Be more specific about the meaning of revision ranges for ``bzr diff``.
+  (Neil Martinsen-Burrell, #247282)
+
 * Document the comment character in the .bzrignore file, including a
   workaround for ignore patterns that begin with #.
   (Neil Martinsen-Burrell, #621515)