summaryrefslogtreecommitdiff
path: root/doc/misc/ediff.texi
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2018-11-27 10:09:55 +0200
committerEli Zaretskii <eliz@gnu.org>2018-11-27 10:09:55 +0200
commitf0531b8e64250414baf1c0d2dde3fbfc55a748a0 (patch)
tree5b243f19adc24c9a76d8f65501cc46f5547bed06 /doc/misc/ediff.texi
parent2925ce5a7ec1424cfaea9f2f86bd3cab27832584 (diff)
downloademacs-f0531b8e64250414baf1c0d2dde3fbfc55a748a0.tar.gz
Improve documentation of Ediff wordwise commands
* lisp/vc/ediff.el (ediff-windows-wordwise) (ediff-windows-linewise, ediff-regions-wordwise): Update and clarify the doc strings. * doc/misc/ediff.texi (Major Entry Points): Update and clarify the documentation of 'ediff-windows-wordwise' and 'ediff-regions-wordwise'. See the discussion starting at https://lists.gnu.org/archive/html/help-gnu-emacs/2018-11/msg00197.html for the details.
Diffstat (limited to 'doc/misc/ediff.texi')
-rw-r--r--doc/misc/ediff.texi13
1 files changed, 6 insertions, 7 deletions
diff --git a/doc/misc/ediff.texi b/doc/misc/ediff.texi
index 746c4c829d2..cce8321d9eb 100644
--- a/doc/misc/ediff.texi
+++ b/doc/misc/ediff.texi
@@ -210,11 +210,11 @@ ancestors. Ediff selects only the files that are under version control.
@item ediff-windows-wordwise
@findex ediff-windows-wordwise
-Compare windows word-by-word.
+Compare text visible in 2 windows word-by-word.
@item ediff-windows-linewise
@findex ediff-windows-linewise
-Compare windows line-by-line.
+Compare text visible in 2 windows line-by-line.
@item ediff-regions-wordwise
@findex ediff-regions-wordwise
@@ -373,13 +373,12 @@ The commands @code{ediff-windows-wordwise},
@code{ediff-windows-linewise}, @code{ediff-regions-wordwise} and
@code{ediff-regions-linewise} do comparison on parts of existing Emacs
buffers. The commands @code{ediff-windows-wordwise} and
-@code{ediff-regions-wordwise} are intended for relatively small segments
-of buffers (e.g., up to 100 lines, depending on the speed of your machine),
+@code{ediff-regions-wordwise} could be slow on very large buffers,
as they perform comparison on the basis of words rather than lines.
-(Word-wise comparison of large chunks of text can be slow.)
+(Word-wise comparison of large chunks of text is relatively expensive.)
-To compare large regions, use @code{ediff-regions-linewise}. This
-command displays differences much like @code{ediff-files} and
+To compare very large regions, use @code{ediff-regions-linewise}.
+This command displays differences much like @code{ediff-files} and
@code{ediff-buffers}.
The functions @code{ediff-patch-file} and @code{ediff-patch-buffer} apply a