changeset 7387:7e9a15fa6c8f

update help on git diffs
author Matt Mackall <mpm@selenic.com>
date Tue, 18 Nov 2008 15:35:34 -0600
parents 86bfd65532ac
children 5751631246de
files hgext/mq.py mercurial/commands.py mercurial/help.py tests/test-globalopts.out tests/test-help.out
diffstat 5 files changed, 23 insertions(+), 25 deletions(-) [+]
line wrap: on
line diff
--- a/hgext/mq.py	Mon Nov 17 11:45:38 2008 -0800
+++ b/hgext/mq.py	Tue Nov 18 15:35:34 2008 -0600
@@ -1607,7 +1607,7 @@
     An existing changeset may be placed under mq control with --rev
     (e.g. qimport --rev tip -n patch will place tip under mq control).
     With --git, patches imported with --rev will use the git diff
-    format. See the gitdiffs help topic for information on why this is
+    format. See the diffs help topic for information on why this is
     important for preserving rename/copy information and permission changes.
     """
     q = repo.mq
@@ -1774,9 +1774,10 @@
     -e, -m or -l set the patch header as well as the commit message. If none
     is specified, the header is empty and the commit message is '[mq]: PATCH'.
 
-    Use the --git option to keep the patch in the git extended diff format.
-    Read the gitdiffs help topic for more information on why this is
-    important for preserving permission changes and copy/rename information.
+    Use the --git option to keep the patch in the git extended diff
+    format. Read the diffs help topic for more information on why this
+    is important for preserving permission changes and copy/rename
+    information.
     """
     msg = cmdutil.logmessage(opts)
     def getmsg(): return ui.edit(msg, ui.username())
@@ -1803,7 +1804,7 @@
 
     hg add/remove/copy/rename work as usual, though you might want to use
     git-style patches (--git or [diff] git=1) to track copies and renames.
-    See the gitdiffs help topic for more information on the git diff format.
+    See the diffs help topic for more information on the git diff format.
     """
     q = repo.mq
     message = cmdutil.logmessage(opts)
--- a/mercurial/commands.py	Mon Nov 17 11:45:38 2008 -0800
+++ b/mercurial/commands.py	Tue Nov 18 15:35:34 2008 -0600
@@ -1005,7 +1005,7 @@
     probably with undesirable results.
 
     Use the --git option to generate diffs in the git extended diff
-    format. Read the gitdiffs help topic for more information.
+    format. Read the diffs help topic for more information.
     """
     node1, node2 = cmdutil.revpair(repo, opts.get('rev'))
 
@@ -1042,7 +1042,7 @@
     probably with undesirable results.
 
     Use the --git option to generate diffs in the git extended diff
-    format. Read the gitdiffs help topic for more information.
+    format. Read the diffs help topic for more information.
 
     With the --switch-parent option, the diff will be against the second
     parent. It can be useful to review a merge.
--- a/mercurial/help.py	Mon Nov 17 11:45:38 2008 -0800
+++ b/mercurial/help.py	Tue Nov 18 15:35:34 2008 -0600
@@ -216,34 +216,31 @@
     gives 3, 4 and 5. Similarly, a range of 4:2 gives 4, 3, and 2.
     ''')),
 
-    (['gitdiffs'], _('Git Extended Diff Format'),
+    (['diffs'], _('Diff Formats'),
      _(r'''
     Mercurial's default format for showing changes between two versions
-    of a file is compatible to the unified format of GNU diff, which
+    of a file is compatible with the unified format of GNU diff, which
     can be used by GNU patch and many other standard tools.
 
-    While this de facto standardized format is often enough, there are
-    cases where additional change information should be included in the
-    generated diff file:
+    While this standard format is often enough, it does not encode the
+    following information:
 
      - executable status
      - copy or rename information
      - changes in binary files
      - creation or deletion of empty files
 
-    Mercurial adopted the extended diff format which was invented for
-    the git VCS to support above features.
+    Mercurial also supports the extended diff format from the git VCS
+    which addresses these limitations. The git diff format is not
+    produced by default because there are very few tools which
+    understand this format.
 
-    The git extended diff format is not produced by default, because
-    there are only very few tools (yet) which understand the additional
-    information provided by them.
-
-    This means that, when generating diffs from a Mercurial repository
+    This means that when generating diffs from a Mercurial repository
     (e.g. with "hg export"), you should be careful about things like
     file copies and renames or other things mentioned above, because
     when applying a standard diff to a different repository, this extra
     information is lost. Mercurial's internal operations (like push and
-    pull) are not affected by this, because they use a different, binary
+    pull) are not affected by this, because they use an internal binary
     format for communicating changes.
 
     To make Mercurial produce the git extended diff format, use the
--- a/tests/test-globalopts.out	Mon Nov 17 11:45:38 2008 -0800
+++ b/tests/test-globalopts.out	Tue Nov 18 15:35:34 2008 -0600
@@ -205,7 +205,7 @@
  environment  Environment Variables
  revisions    Specifying Single Revisions
  multirevs    Specifying Multiple Revisions
- gitdiffs     Git Extended Diff Format
+ diffs        Diff Formats
 
 use "hg -v help" to show aliases and global options
 Mercurial Distributed SCM
@@ -268,7 +268,7 @@
  environment  Environment Variables
  revisions    Specifying Single Revisions
  multirevs    Specifying Multiple Revisions
- gitdiffs     Git Extended Diff Format
+ diffs        Diff Formats
 
 use "hg -v help" to show aliases and global options
 %% not tested: --debugger
--- a/tests/test-help.out	Mon Nov 17 11:45:38 2008 -0800
+++ b/tests/test-help.out	Tue Nov 18 15:35:34 2008 -0600
@@ -96,7 +96,7 @@
  environment  Environment Variables
  revisions    Specifying Single Revisions
  multirevs    Specifying Multiple Revisions
- gitdiffs     Git Extended Diff Format
+ diffs        Diff Formats
 
 use "hg -v help" to show aliases and global options
  add          add the specified files on the next commit
@@ -155,7 +155,7 @@
  environment  Environment Variables
  revisions    Specifying Single Revisions
  multirevs    Specifying Multiple Revisions
- gitdiffs     Git Extended Diff Format
+ diffs        Diff Formats
 hg add [OPTION]... [FILE]...
 
 add the specified files on the next commit
@@ -216,7 +216,7 @@
     probably with undesirable results.
 
     Use the --git option to generate diffs in the git extended diff
-    format. Read the gitdiffs help topic for more information.
+    format. Read the diffs help topic for more information.
 
 options: