|
25829
|
1 \input texinfo @c -*-texinfo-*-
|
|
|
2 @c documentation for Ediff
|
|
|
3 @c Written by Michael Kifer
|
|
|
4
|
|
|
5 @comment %**start of header (This is for running Texinfo on a region.)
|
|
|
6
|
|
|
7 @comment Using ediff.info instead of ediff in setfilename breaks DOS.
|
|
|
8 @comment @setfilename ediff
|
|
|
9 @comment @setfilename ediff.info
|
|
|
10 @setfilename ../info/ediff
|
|
|
11
|
|
|
12 @settitle Ediff User's Manual
|
|
|
13 @synindex vr cp
|
|
|
14 @synindex fn cp
|
|
|
15 @synindex pg cp
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
16 @synindex ky cp
|
|
25829
|
17
|
|
34144
|
18 @dircategory Emacs
|
|
25829
|
19 @direntry
|
|
|
20 * Ediff: (ediff). A visual interface for comparing and merging programs.
|
|
|
21 @end direntry
|
|
|
22
|
|
|
23 @iftex
|
|
|
24 @finalout
|
|
|
25 @end iftex
|
|
|
26 @c @smallbook
|
|
|
27 @comment %**end of header (This is for running Texinfo on a region.)
|
|
|
28
|
|
|
29 @ifinfo
|
|
42288
|
30 This file documents Ediff, a comprehensive visual interface to Unix diff
|
|
25829
|
31 and patch utilities.
|
|
|
32
|
|
42602
|
33 Copyright 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
|
|
25829
|
34
|
|
37404
|
35 Permission is granted to copy, distribute and/or modify this document
|
|
|
36 under the terms of the GNU Free Documentation License, Version 1.1 or
|
|
|
37 any later version published by the Free Software Foundation; with no
|
|
|
38 Invariant Sections, with the Front-Cover texts being ``A GNU
|
|
|
39 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
|
|
|
40 license is included in the section entitled ``GNU Free Documentation
|
|
|
41 License'' in the Emacs manual.
|
|
25829
|
42
|
|
37404
|
43 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
|
|
|
44 this GNU Manual, like GNU software. Copies published by the Free
|
|
|
45 Software Foundation raise funds for GNU development.''
|
|
|
46
|
|
|
47 This document is part of a collection distributed under the GNU Free
|
|
|
48 Documentation License. If you want to distribute this document
|
|
|
49 separately from the collection, you can do so by adding a copy of the
|
|
|
50 license to the document, as described in section 6 of the license.
|
|
25829
|
51 @end ifinfo
|
|
|
52
|
|
|
53 @iftex
|
|
|
54 @titlepage
|
|
|
55 @title Ediff User's Manual
|
|
|
56 @sp 4
|
|
42602
|
57 @subtitle Ediff version 2.76.1
|
|
25829
|
58 @sp 1
|
|
42602
|
59 @subtitle January 2002
|
|
25829
|
60 @sp 5
|
|
|
61 @author Michael Kifer
|
|
|
62 @page
|
|
|
63
|
|
|
64 @vskip 0pt plus 1filll
|
|
|
65 @noindent
|
|
42602
|
66 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
|
|
25829
|
67
|
|
37404
|
68 Permission is granted to copy, distribute and/or modify this document
|
|
|
69 under the terms of the GNU Free Documentation License, Version 1.1 or
|
|
|
70 any later version published by the Free Software Foundation; with no
|
|
|
71 Invariant Sections, with the Front-Cover texts being ``A GNU
|
|
|
72 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
|
|
|
73 license is included in the section entitled ``GNU Free Documentation
|
|
|
74 License'' in the Emacs manual.
|
|
|
75
|
|
|
76 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
|
|
|
77 this GNU Manual, like GNU software. Copies published by the Free
|
|
|
78 Software Foundation raise funds for GNU development.''
|
|
|
79
|
|
|
80 This document is part of a collection distributed under the GNU Free
|
|
|
81 Documentation License. If you want to distribute this document
|
|
|
82 separately from the collection, you can do so by adding a copy of the
|
|
|
83 license to the document, as described in section 6 of the license.
|
|
25829
|
84 @end titlepage
|
|
|
85 @page
|
|
|
86 @end iftex
|
|
|
87
|
|
|
88 @node Top, Introduction, (dir), (dir)
|
|
|
89
|
|
|
90
|
|
|
91 @menu
|
|
|
92 * Introduction:: About Ediff.
|
|
|
93 * Major Entry Points:: How to use Ediff.
|
|
|
94 * Session Commands:: Ediff commands used within a session.
|
|
|
95 * Registry of Ediff Sessions:: Keeping track of multiple Ediff sessions.
|
|
|
96 * Session Groups:: Comparing and merging directories.
|
|
|
97 * Remote and Compressed Files:: You may want to know about this.
|
|
|
98 * Customization:: How to make Ediff work the way YOU want.
|
|
|
99 * Credits:: Thanks to those who helped.
|
|
|
100 * Index::
|
|
|
101 @end menu
|
|
|
102
|
|
|
103 @node Introduction, Major Entry Points, Top, Top
|
|
|
104 @chapter Introduction
|
|
|
105
|
|
|
106 @cindex Comparing files and buffers
|
|
|
107 @cindex Merging files and buffers
|
|
|
108 @cindex Patching files and buffers
|
|
|
109 @cindex Finding differences
|
|
|
110
|
|
|
111 Ediff provides a convenient way for simultaneous browsing through
|
|
|
112 the differences between a pair (or a triple) of files or buffers
|
|
|
113 (which are called @samp{variants} for our purposes). The
|
|
|
114 files being compared, file-A, file-B, and file-C (if applicable) are
|
|
|
115 shown in separate windows (side by side, one above the another, or in
|
|
|
116 separate frames), and the differences are highlighted as you step
|
|
|
117 through them. You can also copy difference regions from one buffer to
|
|
|
118 another (and recover old differences if you change your mind).
|
|
|
119
|
|
|
120 Another powerful feature is the ability to merge a pair of files into a
|
|
|
121 third buffer. Merging with an ancestor file is also supported.
|
|
|
122 Furthermore, Ediff is equipped with directory-level capabilities that
|
|
|
123 allow the user to conveniently launch browsing or merging sessions on
|
|
|
124 groups of files in two (or three) different directories.
|
|
|
125
|
|
42288
|
126 In addition, Ediff can apply a patch to a file and then let you step through
|
|
25829
|
127 both files, the patched and the original one, simultaneously,
|
|
|
128 difference-by-difference. You can even apply a patch right out of a mail
|
|
|
129 buffer, i.e., patches received by mail don't even have to be saved. Since
|
|
|
130 Ediff lets you copy differences between variants, you can, in effect, apply
|
|
|
131 patches selectively (i.e., you can copy a difference region from
|
|
|
132 @file{file.orig} to @file{file}, thereby undoing any particular patch that
|
|
|
133 you don't like).
|
|
|
134
|
|
|
135 Ediff even understands multi-file patches and can apply them interactively!
|
|
|
136 (Ediff can recognize multi-file patches only if they are in the context
|
|
|
137 format or GNU unified format. All other patches are treated as 1-file
|
|
33021
|
138 patches. Ediff is [hopefully] using the same algorithm as @code{patch} to
|
|
25829
|
139 determine which files need to be patched.)
|
|
|
140
|
|
|
141 Ediff is aware of version control, which lets you compare
|
|
|
142 files with their older versions. Ediff also works with remote and
|
|
|
143 compressed files, automatically ftp'ing them over and uncompressing them.
|
|
|
144 @xref{Remote and Compressed Files}, for details.
|
|
|
145
|
|
|
146 This package builds upon ideas borrowed from Emerge, and several of Ediff's
|
|
|
147 functions are adaptations from Emerge. Although Ediff subsumes and greatly
|
|
|
148 extends Emerge, much of the functionality in Ediff is influenced by Emerge.
|
|
|
149 The architecture and the interface are, of course, drastically different.
|
|
|
150
|
|
|
151 @node Major Entry Points, Session Commands, Introduction, Top
|
|
|
152 @chapter Major Entry Points
|
|
|
153
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
154 When Ediff starts up, it displays a small control window, which accepts the
|
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
155 Ediff commands and two or three windows displaying the files to be compared
|
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
156 or merged. The control window can be in its own small frame or it can be
|
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
157 part of a bigger frame that displays other buffers. In any case, it is
|
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
158 important that the control window be active (i.e., be the one receiving the
|
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
159 keystrokes) when you use Ediff. You can switch to other Emacs buffers at
|
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
160 will and even edit the files currently being compared with Ediff and then
|
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
161 switch back to Ediff at any time by activating the appropriate Emacs windows.
|
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
162
|
|
25829
|
163 Ediff can be invoked interactively using the following functions, which can
|
|
|
164 be run either from the minibuffer or from the menu bar. In the menu bar,
|
|
|
165 all Ediff's entry points belong to three submenus of the Tools menu:
|
|
|
166 Compare, Merge, and Apply Patch.
|
|
|
167
|
|
|
168 @table @code
|
|
|
169 @item ediff-files
|
|
|
170 @itemx ediff
|
|
|
171 @findex ediff-files
|
|
|
172 @findex ediff
|
|
|
173 Compare two files.
|
|
|
174
|
|
|
175 @item ediff-buffers
|
|
|
176 @findex ediff-buffers
|
|
|
177 Compare two buffers.
|
|
|
178
|
|
|
179 @item ediff-files3
|
|
|
180 @itemx ediff3
|
|
|
181 @findex ediff-files3
|
|
|
182 @findex ediff3
|
|
|
183 Compare three files.
|
|
|
184
|
|
|
185 @item ediff-buffers3
|
|
|
186 @findex ediff-buffers3
|
|
|
187 Compare three buffers.
|
|
|
188
|
|
|
189 @item edirs
|
|
|
190 @itemx ediff-directories
|
|
|
191 @findex edirs
|
|
|
192 @findex ediff-directories
|
|
|
193 Compare files common to two directories.
|
|
|
194 @item edirs3
|
|
|
195 @itemx ediff-directories3
|
|
|
196 @findex edirs3
|
|
|
197 @findex ediff-directories3
|
|
|
198 Compare files common to three directories.
|
|
|
199 @item edir-revisions
|
|
|
200 @itemx ediff-directory-revisions
|
|
|
201 @findex ediff-directory-revisions
|
|
|
202 @findex edir-revisions
|
|
|
203 Compare versions of files in a given directory. Ediff selects only the
|
|
|
204 files that are under version control.
|
|
|
205 @item edir-merge-revisions
|
|
|
206 @itemx ediff-merge-directory-revisions
|
|
|
207 @findex edir-merge-revisions
|
|
|
208 @findex ediff-merge-directory-revisions
|
|
|
209 Merge versions of files in a given directory. Ediff selects only the
|
|
|
210 files that are under version control.
|
|
|
211 @item edir-merge-revisions-with-ancestor
|
|
|
212 @itemx ediff-merge-directory-revisions-with-ancestor
|
|
|
213 @findex edir-merge-revisions-with-ancestor
|
|
|
214 @findex ediff-merge-directory-revisions-with-ancestor
|
|
|
215 Merge versions of files in a given directory using other versions as
|
|
|
216 ancestors. Ediff selects only the files that are under version control.
|
|
|
217
|
|
|
218 @item ediff-windows-wordwise
|
|
|
219 @findex ediff-windows-wordwise
|
|
|
220 Compare windows word-by-word.
|
|
|
221
|
|
|
222 @item ediff-windows-linewise
|
|
|
223 @findex ediff-windows-linewise
|
|
|
224 Compare windows line-by-line.
|
|
|
225
|
|
|
226 @item ediff-regions-wordwise
|
|
|
227 @findex ediff-regions-wordwise
|
|
42602
|
228 Compare regions word-by-word. The regions can come from the same buffer
|
|
|
229 and they can even overlap. You will be asked to specify the buffers that
|
|
|
230 contain the regions, which you want to compare. For each buffer, you will
|
|
|
231 also be asked to mark the regions to be compared. Pay attention to the
|
|
|
232 messages that appear in the minibuffer.
|
|
25829
|
233
|
|
|
234 @item ediff-regions-linewise
|
|
|
235 @findex ediff-regions-linewise
|
|
42602
|
236 Similar to @code{ediff-windows-linewise}, but compares the regions
|
|
|
237 line-by-line. See @code{ediff-windows-linewise} for more details.
|
|
25829
|
238
|
|
|
239 @item ediff-revision
|
|
|
240 @findex ediff-revision
|
|
|
241 Compare versions of the current buffer, if the buffer is visiting
|
|
|
242 a file under version control.
|
|
|
243
|
|
|
244 @item ediff-patch-file
|
|
|
245 @itemx epatch
|
|
|
246 @findex ediff-patch-file
|
|
|
247 @findex epatch
|
|
|
248
|
|
|
249 Patch a file or multiple files, then compare. If the patch applies to just
|
|
|
250 one file, Ediff will invoke a regular comparison session. If it is a
|
|
|
251 multi-file patch, then a session group interface will be used and the user
|
|
|
252 will be able to patch the files selectively. @xref{Session Groups}, for
|
|
|
253 more details.
|
|
|
254
|
|
26263
|
255 Since the patch might be in a buffer or a file, you will be asked which is
|
|
|
256 the case. To avoid this extra prompt, you can invoke this command with a
|
|
|
257 prefix argument. With an odd prefix argument, Ediff assumes the patch
|
|
|
258 is in a file; with an even argument, a buffer is assumed.
|
|
|
259
|
|
33021
|
260 Note that @code{ediff-patch-file} will actually use the @code{patch}
|
|
36331
|
261 utility to change the original files on disk. This is not that
|
|
25829
|
262 dangerous, since you will always have the original contents of the file
|
|
|
263 saved in another file that has the extension @file{.orig}.
|
|
|
264 Furthermore, if the file is under version control, then you can always back
|
|
|
265 out to one of the previous versions (see the section on Version Countrol in
|
|
|
266 Emacs manual).
|
|
|
267
|
|
|
268 @code{ediff-patch-file} is careful about versions control: if the file
|
|
|
269 to be patched is checked in, then Ediff will offer to check it out, because
|
|
|
270 failing to do so may result in the loss of the changes when the file is
|
|
|
271 checked out the next time.
|
|
|
272
|
|
|
273 If you don't intend to modify the file via the patch and just want to see
|
|
|
274 what the patch is all about (and decide later), then
|
|
|
275 @code{ediff-patch-buffer} might be a better choice.
|
|
|
276
|
|
|
277 @item ediff-patch-buffer
|
|
|
278 @itemx epatch-buffer
|
|
|
279 @findex ediff-patch-buffer
|
|
|
280 @findex epatch-buffer
|
|
|
281 Patch a buffer, then compare. The buffer being patched and the file visited
|
|
|
282 by that buffer (if any) is @emph{not} modified. The result of the patch
|
|
|
283 appears in some other buffer that has the name ending with @emph{_patched}.
|
|
|
284
|
|
|
285 This function would refuse to apply a multifile patch to a buffer. Use
|
|
|
286 @code{ediff-patch-file} for that (and when you want the original file to be
|
|
33021
|
287 modified by the @code{patch} utility).
|
|
25829
|
288
|
|
26263
|
289 Since the patch might be in a buffer or a file, you will be asked which is
|
|
|
290 the case. To avoid this extra prompt, you can invoke this command with a
|
|
|
291 prefix argument. With an odd prefix argument, Ediff assumes the patch
|
|
|
292 is in a file; with an even argument, a buffer is assumed.
|
|
|
293
|
|
25829
|
294 @item ediff-merge-files
|
|
|
295 @itemx ediff-merge
|
|
|
296 @findex ediff-merge-files
|
|
|
297 @findex ediff-merge
|
|
|
298 Merge two files.
|
|
|
299
|
|
|
300 @item ediff-merge-files-with-ancestor
|
|
|
301 @itemx ediff-merge-with-ancestor
|
|
|
302 @findex ediff-merge-files-with-ancestor
|
|
|
303 @findex ediff-merge-with-ancestor
|
|
|
304 Like @code{ediff-merge}, but with a third ancestor file.
|
|
|
305
|
|
|
306 @item ediff-merge-buffers
|
|
|
307 @findex ediff-merge-buffers
|
|
|
308 Merge two buffers.
|
|
|
309
|
|
|
310 @item ediff-merge-buffers-with-ancestor
|
|
|
311 @findex ediff-merge-buffers-with-ancestor
|
|
|
312 Same but with ancestor.
|
|
|
313
|
|
|
314
|
|
|
315 @item edirs-merge
|
|
|
316 @itemx ediff-merge-directories
|
|
|
317 @findex edirs-merge
|
|
|
318 @findex ediff-merge-directories
|
|
|
319 Merge files common to two directories.
|
|
|
320 @item edirs-merge-with-ancestor
|
|
|
321 @itemx ediff-merge-directories-with-ancestor
|
|
|
322 @findex edirs-merge-with-ancestor
|
|
|
323 @findex ediff-merge-directories-with-ancestor
|
|
|
324 Same but using files in a third directory as ancestors.
|
|
|
325 If a pair of files doesn't have an ancestor in the ancestor-directory, you
|
|
|
326 will still be able to merge them without the ancestor.
|
|
|
327
|
|
|
328 @item ediff-merge-revisions
|
|
|
329 @findex ediff-merge-revisions
|
|
|
330 Merge two versions of the file visited by the current buffer.
|
|
|
331
|
|
|
332 @item ediff-merge-revisions-with-ancestor
|
|
|
333 @findex ediff-merge-revisions-with-ancestor
|
|
|
334 Same but with ancestor.
|
|
|
335
|
|
|
336 @item ediff-documentation
|
|
|
337 @findex ediff-documentation
|
|
|
338 Brings up this manual.
|
|
|
339
|
|
|
340 @item ediff-show-registry
|
|
|
341 @itemx eregistry
|
|
|
342 Brings up Ediff session registry. This feature enables you to quickly find
|
|
|
343 and restart active Ediff sessions.
|
|
|
344 @end table
|
|
|
345
|
|
|
346 @noindent
|
|
|
347 If you want Ediff to be loaded from the very beginning of your Emacs
|
|
|
348 session, you should put this line in your @file{~/.emacs} file:
|
|
|
349
|
|
|
350 @example
|
|
|
351 (require 'ediff)
|
|
|
352 @end example
|
|
|
353
|
|
|
354 @noindent
|
|
|
355 Otherwise, Ediff will be loaded automatically when you use one of the
|
|
|
356 above functions, either directly or through the menus.
|
|
|
357
|
|
|
358 When the above functions are invoked, the user is prompted for all the
|
|
|
359 necessary information---typically the files or buffers to compare, merge, or
|
|
|
360 patch. Ediff tries to be smart about these prompts. For instance, in
|
|
|
361 comparing/merging files, it will offer the visible buffers as defaults. In
|
|
|
362 prompting for files, if the user enters a directory, the previously input
|
|
|
363 file name will be appended to that directory. In addition, if the variable
|
|
|
364 @code{ediff-use-last-dir} is not @code{nil}, Ediff will offer
|
|
|
365 previously entered directories as defaults (which will be maintained
|
|
|
366 separately for each type of file, A, B, or C).
|
|
|
367 @vindex @code{ediff-use-last-dir}
|
|
|
368
|
|
|
369 All the above functions use the POSIX @code{diff} or @code{diff3} programs
|
|
|
370 to find differences between two files. They process the @code{diff} output
|
|
|
371 and display it in a convenient form. At present, Ediff understands only
|
|
|
372 the plain output from diff. Options such as @samp{-c} are not supported,
|
|
|
373 nor is the format produced by incompatible file comparison programs such as
|
|
|
374 the VMS version of @code{diff}.
|
|
|
375
|
|
|
376 The functions @code{ediff-files}, @code{ediff-buffers},
|
|
|
377 @code{ediff-files3}, @code{ediff-buffers3} first display the coarse,
|
|
33021
|
378 line-based difference regions, as reported by the @code{diff} program. The
|
|
25829
|
379 total number of difference regions and the current difference number are
|
|
|
380 always displayed in the mode line of the control window.
|
|
|
381
|
|
|
382 Since @code{diff} may report fairly large chunks of text as being different,
|
|
|
383 even though the difference may be localized to just a few words or even
|
|
|
384 to the white space or line breaks, Ediff further @emph{refines} the
|
|
|
385 regions to indicate which exact words differ. If the only difference is
|
|
|
386 in the white space and line breaks, Ediff says so.
|
|
|
387
|
|
|
388 On a color display, fine differences are highlighted with color; on a
|
|
|
389 monochrome display, they are underlined. @xref{Highlighting Difference
|
|
|
390 Regions}, for information on how to customize this.
|
|
|
391
|
|
42602
|
392 The commands @code{ediff-windows-wordwise},
|
|
25829
|
393 @code{ediff-windows-linewise}, @code{ediff-regions-wordwise} and
|
|
|
394 @code{ediff-regions-linewise} do comparison on parts of existing Emacs
|
|
42602
|
395 buffers. The commands @code{ediff-windows-wordwise} and
|
|
25829
|
396 @code{ediff-regions-wordwise} are intended for relatively small segments
|
|
42602
|
397 of buffers (e.g., up to 100 lines, depending on the speed of your machine),
|
|
|
398 as they perform comparison on the basis of words rather than lines.
|
|
|
399 (Word-wise comparison of large chunks of text can be slow.)
|
|
25829
|
400
|
|
|
401 To compare large regions, use @code{ediff-regions-linewise}. This
|
|
|
402 command displays differences much like @code{ediff-files} and
|
|
|
403 @code{ediff-buffers}.
|
|
|
404
|
|
|
405 The functions @code{ediff-patch-file} and @code{ediff-patch-buffer} apply a
|
|
|
406 patch to a file or a buffer and then run Ediff on the appropriate
|
|
|
407 files/buffers, displaying the difference regions.
|
|
|
408
|
|
|
409 The entry points @code{ediff-directories}, @code{ediff-merge-directories},
|
|
|
410 etc., provide a convenient interface for comparing and merging files in
|
|
|
411 different directories. The user is presented with Dired-like interface from
|
|
|
412 which one can run a group of related Ediff sessions.
|
|
|
413
|
|
|
414 For files under version control, @code{ediff-revision} lets you compare
|
|
|
415 the file visited by the current buffer to one of its checked-in versions.
|
|
|
416 You can also compare two checked-in versions of the visited file.
|
|
|
417 Moreover, the functions @code{ediff-directory-revisions},
|
|
|
418 @code{ediff-merge-directory-revisions}, etc., let you run a group of
|
|
|
419 related Ediff sessions by taking a directory and comparing (or merging)
|
|
|
420 versions of files in that directory.
|
|
|
421
|
|
|
422 @node Session Commands, Registry of Ediff Sessions, Major Entry Points, Top
|
|
|
423 @chapter Session Commands
|
|
|
424
|
|
|
425 All Ediff commands are displayed in a Quick Help window, unless you type
|
|
|
426 @kbd{?} to shrink the window to just one line. You can redisplay the help
|
|
|
427 window by typing @kbd{?} again. The Quick Help commands are detailed below.
|
|
|
428
|
|
|
429 Many Ediff commands take numeric prefix arguments. For instance, if you
|
|
|
430 type a number, say 3, and then @kbd{j} (@code{ediff-jump-to-difference}),
|
|
|
431 Ediff moves to the third difference region. Typing 3 and then @kbd{a}
|
|
|
432 (@code{ediff-diff-to-diff}) copies the 3d difference region from variant A
|
|
|
433 to variant B. Likewise, 4 followed by @kbd{ra} restores the 4th difference
|
|
|
434 region in buffer A (if it was previously written over via the command
|
|
|
435 @kbd{a}).
|
|
|
436
|
|
|
437 Some commands take negative prefix arguments as well. For instance, typing
|
|
|
438 @kbd{-} and then @kbd{j} will make the last difference region
|
|
|
439 current. Typing @kbd{-2} then @kbd{j} makes the penultimate difference
|
|
|
440 region current, etc.
|
|
|
441
|
|
|
442 Without the prefix argument, all commands operate on the currently
|
|
|
443 selected difference region. You can make any difference region
|
|
|
444 current using the various commands explained below.
|
|
|
445
|
|
|
446 For some commands, the actual value of the prefix argument is
|
|
|
447 immaterial. However, if supplied, the prefix argument may modify the
|
|
|
448 command (see @kbd{ga}, @kbd{gb}, and @kbd{gc}).
|
|
|
449
|
|
|
450 @menu
|
|
|
451 * Quick Help Commands:: Frequently used commands.
|
|
|
452 * Other Session Commands:: Commands that are not bound to keys.
|
|
|
453 @end menu
|
|
|
454
|
|
|
455 @node Quick Help Commands,Other Session Commands,,Session Commands
|
|
|
456 @section Quick Help Commands
|
|
|
457
|
|
|
458 @table @kbd
|
|
|
459 @item ?
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
460 @kindex ?
|
|
25829
|
461 Toggles the Ediff Quick Help window ON and OFF.
|
|
|
462 @item G
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
463 @kindex G
|
|
25829
|
464 Prepares a mail buffer for sending a praise or a curse to the Ediff maintainer.
|
|
|
465
|
|
|
466 @item E
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
467 @kindex E
|
|
25829
|
468 Brings up the top node of this manual, where you can find further
|
|
|
469 information on the various Ediff functions and advanced issues, such as
|
|
|
470 customization, session groups, etc.
|
|
|
471
|
|
|
472 @item v
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
473 @kindex v
|
|
25829
|
474 Scrolls up buffers A and B (and buffer C where appropriate) in a
|
|
|
475 coordinated fashion.
|
|
|
476 @item V
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
477 @kindex V
|
|
25829
|
478 Scrolls the buffers down.
|
|
|
479
|
|
|
480 @item <
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
481 @kindex <
|
|
25829
|
482 Scrolls the buffers to the left simultaneously.
|
|
|
483 @item >
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
484 @kindex >
|
|
25829
|
485 Scrolls buffers to the right.
|
|
|
486
|
|
|
487 @item wd
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
488 @kindex wd
|
|
25829
|
489 Saves the output from the diff utility, for further reference.
|
|
|
490
|
|
33021
|
491 With prefix argument, saves the plain output from @code{diff} (see
|
|
25829
|
492 @code{ediff-diff-program} and @code{ediff-diff-options}). Without the
|
|
33021
|
493 argument, it saves customized @code{diff} output (see
|
|
25829
|
494 @code{ediff-custom-diff-program} and @code{ediff-custom-diff-options}), if
|
|
|
495 it is available.
|
|
|
496
|
|
|
497 @item wa
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
498 @kindex wa
|
|
25829
|
499 Saves buffer A, if it was modified.
|
|
|
500 @item wb
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
501 @kindex wb
|
|
25829
|
502 Saves buffer B, if it was modified.
|
|
|
503 @item wc
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
504 @kindex wc
|
|
25829
|
505 Saves buffer C, if it was modified (if you are in a session that
|
|
|
506 compares three files simultaneously).
|
|
|
507
|
|
|
508 @item a
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
509 @kindex a
|
|
25829
|
510 @emph{In comparison sessions:}
|
|
|
511 Copies the current difference region (or the region specified as the prefix
|
|
|
512 to this command) from buffer A to buffer B.
|
|
|
513 Ediff saves the old contents of buffer B's region; it can
|
|
|
514 be restored via the command @kbd{rb}, which see.
|
|
|
515
|
|
|
516 @emph{In merge sessions:}
|
|
|
517 Copies the current difference region (or the region specified as the prefix
|
|
|
518 to this command) from buffer A to the merge buffer. The old contents of
|
|
|
519 this region in buffer C can be restored via the command @kbd{r}.
|
|
|
520
|
|
|
521 @item b
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
522 @kindex b
|
|
25829
|
523 Works similarly, but copies the current difference region from buffer B to
|
|
|
524 buffer A (in @emph{comparison sessions}) or the merge buffer (in
|
|
|
525 @emph{merge sessions}).
|
|
|
526
|
|
|
527 Ediff saves the old contents of the difference region copied over; it can
|
|
|
528 be reinstated via the command @kbd{ra} in comparison sessions and
|
|
|
529 @kbd{r} in merge sessions.
|
|
|
530
|
|
|
531 @item ab
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
532 @kindex ab
|
|
25829
|
533 Copies the current difference region (or the region specified as the prefix
|
|
|
534 to this command) from buffer A to buffer B. This (and the next five)
|
|
|
535 command is enabled only in sessions that compare three files
|
|
|
536 simultaneously. The old region in buffer B is saved and can be restored
|
|
|
537 via the command @kbd{rb}.
|
|
|
538 @item ac
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
539 @kindex ac
|
|
25829
|
540 Copies the difference region from buffer A to buffer C.
|
|
|
541 The old region in buffer C is saved and can be restored via the command
|
|
|
542 @kbd{rc}.
|
|
|
543 @item ba
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
544 @kindex ba
|
|
25829
|
545 Copies the difference region from buffer B to buffer A.
|
|
|
546 The old region in buffer A is saved and can be restored via the command
|
|
|
547 @kbd{ra}.
|
|
|
548 @item bc
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
549 @kindex bc
|
|
25829
|
550 Copies the difference region from buffer B to buffer C.
|
|
|
551 The command @kbd{rc} undoes this.
|
|
|
552 @item ca
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
553 @kindex ca
|
|
25829
|
554 Copies the difference region from buffer C to buffer A.
|
|
|
555 The command @kbd{ra} undoes this.
|
|
|
556 @item cb
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
557 @kindex cb
|
|
25829
|
558 Copies the difference region from buffer C to buffer B.
|
|
|
559 The command @kbd{rb} undoes this.
|
|
|
560
|
|
|
561 @item p
|
|
|
562 @itemx DEL
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
563 @kindex p
|
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
564 @kindex DEL
|
|
25829
|
565 Makes the previous difference region current.
|
|
|
566 @item n
|
|
|
567 @itemx SPC
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
568 @kindex n
|
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
569 @kindex SPC
|
|
25829
|
570 Makes the next difference region current.
|
|
|
571
|
|
|
572 @item j
|
|
|
573 @itemx -j
|
|
|
574 @itemx Nj
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
575 @kindex j
|
|
25829
|
576 Makes the very first difference region current.
|
|
|
577
|
|
|
578 @kbd{-j} makes the last region current. Typing a number, N, and then `j'
|
|
|
579 makes the difference region N current. Typing -N (a negative number) then
|
|
|
580 `j' makes current the region Last - N.
|
|
|
581
|
|
|
582 @item ga
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
583 @kindex ga
|
|
25829
|
584 Makes current the difference region closest to the position of the point in
|
|
|
585 buffer A.
|
|
|
586
|
|
|
587 However, with a prefix argument, Ediff would position all variants
|
|
|
588 around the area indicated by the current point in buffer A: if
|
|
|
589 the point is inside a difference region, then the variants will be
|
|
|
590 positioned at this difference region. If the point is not in any difference
|
|
|
591 region, then it is in an area where all variants agree with each other. In
|
|
|
592 this case, the variants will be positioned so that each would display this
|
|
|
593 area (of agreement).
|
|
|
594 @item gb
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
595 @kindex gb
|
|
25829
|
596 Makes current the difference region closest to the position of the point in
|
|
|
597 buffer B.
|
|
|
598
|
|
|
599 With a prefix argument, behaves like @kbd{ga}, but with respect to buffer B.
|
|
|
600 @item gc
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
601 @kindex gc
|
|
25829
|
602 @emph{In merge sessions:}
|
|
|
603 makes current the difference region closest to the point in the merge buffer.
|
|
|
604
|
|
|
605 @emph{In 3-file comparison sessions:}
|
|
|
606 makes current the region closest to the point in buffer C.
|
|
|
607
|
|
|
608 With a prefix argument, behaves like @kbd{ga}, but with respect to buffer C.
|
|
|
609
|
|
|
610 @item !
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
611 @kindex !
|
|
25829
|
612 Recomputes the difference regions, bringing them up to date. This is often
|
|
|
613 needed because it is common to do all sorts of editing during Ediff
|
|
|
614 sessions, so after a while, the highlighted difference regions may no
|
|
|
615 longer reflect the actual differences among the buffers.
|
|
|
616
|
|
|
617 @item *
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
618 @kindex *
|
|
25829
|
619 Forces refinement of the current difference region, which highlights the exact
|
|
|
620 words of disagreement among the buffers. With a negative prefix argument,
|
|
|
621 unhighlights the current region.
|
|
|
622
|
|
|
623 Forceful refinement may be needed if Ediff encounters a difference region
|
|
|
624 that is larger than @code{ediff-auto-refine-limit}. In this situation,
|
|
|
625 Ediff doesn't do automatic refinement in order to improve response time.
|
|
|
626 (Ediff doesn't auto-refine on dumb terminals as well, but @kbd{*} still
|
|
|
627 works there. However, the only useful piece of information it can tell you
|
|
|
628 is whether or not the difference regions disagree only in the amount of
|
|
|
629 white space.)
|
|
|
630
|
|
|
631 This command is also useful when the highlighted fine differences are
|
|
|
632 no longer current, due to user editing.
|
|
|
633
|
|
|
634 @item m
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
635 @kindex m
|
|
25829
|
636 Displays the current Ediff session in a frame as wide as the physical
|
|
|
637 display. This is useful when comparing files side-by-side. Typing `m' again
|
|
|
638 restores the original size of the frame.
|
|
|
639
|
|
|
640 @item |
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
641 @kindex |
|
|
25829
|
642 Toggles the horizontal/vertical split of the Ediff display. Horizontal
|
|
|
643 split is convenient when it is possible to compare files
|
|
|
644 side-by-side. If the frame in which files are displayed is too narrow
|
|
|
645 and lines are cut off, typing @kbd{m} may help some.
|
|
|
646
|
|
|
647 @item @@
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
648 @kindex @@
|
|
25829
|
649 Toggles auto-refinement of difference regions (i.e., automatic highlighting
|
|
|
650 of the exact words that differ among the variants). Auto-refinement is
|
|
|
651 turned off on devices where Emacs doesn't support highlighting.
|
|
|
652
|
|
|
653 On slow machines, it may be advantageous to turn auto-refinement off. The
|
|
|
654 user can always forcefully refine specific difference regions by typing
|
|
|
655 @kbd{*}.
|
|
|
656
|
|
|
657 @item h
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
658 @kindex h
|
|
25829
|
659 Cycles between full highlighting, the mode where fine differences are not
|
|
|
660 highlighted (but computed), and the mode where highlighting is done with
|
|
|
661 ASCII strings. The latter is not really recommended, unless on a dumb TTY.
|
|
|
662
|
|
|
663 @item r
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
664 @kindex r
|
|
25829
|
665 Restores the old contents of the region in the merge buffer.
|
|
|
666 (If you copied a difference region from buffer A or B into the merge buffer
|
|
|
667 using the commands @kbd{a} or @kbd{b}, Ediff saves the old contents of the
|
|
|
668 region in case you change your mind.)
|
|
|
669
|
|
|
670 This command is enabled in merge sessions only.
|
|
|
671
|
|
|
672 @item ra
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
673 @kindex ra
|
|
25829
|
674 Restores the old contents of the current difference region in buffer A,
|
|
|
675 which was previously saved when the user invoked one of these commands:
|
|
|
676 @kbd{b}, @kbd{ba}, @kbd{ca}, which see. This command is enabled in
|
|
|
677 comparison sessions only.
|
|
|
678 @item rb
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
679 @kindex rb
|
|
25829
|
680 Restores the old contents of the current difference region in buffer B,
|
|
|
681 which was previously saved when the user invoked one of these commands:
|
|
|
682 @kbd{a}, @kbd{ab}, @kbd{cb}, which see. This command is enabled in
|
|
|
683 comparison sessions only.
|
|
|
684 @item rc
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
685 @kindex rc
|
|
25829
|
686 Restores the old contents of the current difference region in buffer C,
|
|
|
687 which was previously saved when the user invoked one of these commands:
|
|
|
688 @kbd{ac}, @kbd{bc}, which see. This command is enabled in 3-file
|
|
|
689 comparison sessions only.
|
|
|
690
|
|
|
691 @item ##
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
692 @kindex ##
|
|
25829
|
693 Tell Ediff to skip over regions that disagree among themselves only in the
|
|
|
694 amount of white space and line breaks.
|
|
|
695
|
|
|
696 Even though such regions will be skipped over, you can still jump to any
|
|
|
697 one of them by typing the region number and then `j'. Typing @kbd{##}
|
|
|
698 again puts Ediff back in the original state.
|
|
|
699
|
|
|
700 @item #h
|
|
|
701 @itemx #f
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
702 @kindex #f
|
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
703 @kindex #h
|
|
25829
|
704 Ediff works hard to ameliorate the effects of boredom in the workplace...
|
|
|
705
|
|
|
706 Quite often differences are due to identical replacements (e.g., the word
|
|
|
707 `foo' is replaced with the word `bar' everywhere). If the number of regions
|
|
|
708 with such boring differences exceeds your tolerance threshold, you may be
|
|
|
709 tempted to tell Ediff to skip these regions altogether (you will still be able
|
|
|
710 to jump to them via the command @kbd{j}). The above commands, @kbd{#h}
|
|
|
711 and @kbd{#f}, may well save your day!
|
|
|
712
|
|
|
713 @kbd{#h} prompts you to specify regular expressions for each
|
|
|
714 variant. Difference regions where each variant's region matches the
|
|
|
715 corresponding regular expression will be skipped from then on. (You can
|
|
|
716 also tell Ediff to skip regions where at least one variant matches its
|
|
|
717 regular expression.)
|
|
|
718
|
|
|
719 @kbd{#f} does dual job: it focuses on regions that match the corresponding
|
|
|
720 regular expressions. All other regions will be skipped
|
|
|
721 over. @xref{Selective Browsing}, for more.
|
|
|
722
|
|
|
723 @item A
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
724 @kindex A
|
|
25829
|
725 Toggles the read-only property in buffer A.
|
|
|
726 If file A is under version control and is checked in, it is checked out
|
|
|
727 (with your permission).
|
|
|
728 @item B
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
729 @kindex B
|
|
25829
|
730 Toggles the read-only property in buffer B.
|
|
|
731 If file B is under version control and is checked in, it is checked out.
|
|
|
732 @item C
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
733 @kindex C
|
|
25829
|
734 Toggles the read-only property in buffer C (in 3-file comparison sessions).
|
|
|
735 If file C is under version control and is checked in, it is checked out.
|
|
|
736
|
|
|
737 @item ~
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
738 @kindex ~
|
|
25829
|
739 Swaps the windows where buffers A and B are displayed. If you are comparing
|
|
|
740 three buffers at once, then this command would rotate the windows among
|
|
|
741 buffers A, B, and C.
|
|
|
742
|
|
|
743 @item i
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
744 @kindex i
|
|
25829
|
745 Displays all kinds of useful data about the current Ediff session.
|
|
|
746 @item D
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
747 @kindex D
|
|
25829
|
748 Runs @code{ediff-custom-diff-program} on the variants and displays the
|
|
|
749 buffer containing the output. This is useful when you must send the output
|
|
|
750 to your Mom.
|
|
|
751
|
|
33021
|
752 With a prefix argument, displays the plain @code{diff} output.
|
|
25829
|
753 @xref{Patch and Diff Programs}, for details.
|
|
|
754
|
|
|
755 @item R
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
756 @kindex R
|
|
25829
|
757 Displays a list of currently active Ediff sessions---the Ediff Registry.
|
|
|
758 You can then restart any of these sessions by either clicking on a session
|
|
|
759 record or by putting the cursor over it and then typing the return key.
|
|
|
760
|
|
|
761 (Some poor souls leave so many active Ediff sessions around that they loose
|
|
|
762 track of them completely... The `R' command is designed to save these
|
|
|
763 people from the recently discovered Ediff Proficiency Syndrome.)
|
|
|
764
|
|
|
765 Typing @kbd{R} brings up Ediff Registry only if it is typed into an Ediff
|
|
|
766 Control Panel. If you don't have a control panel handy, type this in the
|
|
|
767 minibuffer: @kbd{M-x eregistry}. @xref{Registry of Ediff Sessions}.
|
|
|
768
|
|
|
769 @item M
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
770 @kindex M
|
|
25829
|
771 Shows the session group buffer that invoked the current Ediff session.
|
|
|
772 @xref{Session Groups}, for more information on session groups.
|
|
|
773
|
|
|
774 @item z
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
775 @kindex z
|
|
25829
|
776 Suspends the current Ediff session. (If you develop a condition known as
|
|
|
777 Repetitive Ediff Injury---a serious but curable illness---you must change
|
|
|
778 your current activity. This command tries hard to hide all Ediff-related
|
|
|
779 buffers.)
|
|
|
780
|
|
|
781 The easiest way to resume a suspended Ediff session is through the registry
|
|
|
782 of active sessions. @xref{Registry of Ediff Sessions}, for details.
|
|
|
783 @item q
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
784 @kindex q
|
|
25829
|
785 Terminates this Ediff session. With a prefix argument (e.g.,@kbd{1q}), asks
|
|
|
786 if you also want to delete the buffers of the variants.
|
|
|
787 Modified files and the results of merges are never deleted.
|
|
|
788
|
|
|
789 @item %
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
790 @kindex %
|
|
25829
|
791 Toggles narrowing in Ediff buffers. Ediff buffers may be narrowed if you
|
|
|
792 are comparing only parts of these buffers via the commands
|
|
|
793 @code{ediff-windows-*} and @code{ediff-regions-*}, which see.
|
|
|
794
|
|
|
795 @item C-l
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
796 @kindex C-l
|
|
25829
|
797 Restores the usual Ediff window setup. This is the quickest way to resume
|
|
|
798 an Ediff session, but it works only if the control panel of that session is
|
|
|
799 visible.
|
|
|
800
|
|
26263
|
801 @item $$
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
802 @kindex $$
|
|
25829
|
803 While merging with an ancestor file, Ediff is determined to reduce user's
|
|
|
804 wear and tear by saving him and her much of unproductive, repetitive
|
|
|
805 typing. If it notices that, say, file A's difference region is identical to
|
|
|
806 the same difference region in the ancestor file, then the merge buffer will
|
|
|
807 automatically get the difference region taken from buffer B. The rationale
|
|
|
808 is that this difference region in buffer A is as old as that in the
|
|
|
809 ancestor buffer, so the contents of that region in buffer B represents real
|
|
|
810 change.
|
|
|
811
|
|
|
812 You may want to ignore such `obvious' merges and concentrate on difference
|
|
|
813 regions where both files `clash' with the ancestor, since this means that
|
|
|
814 two different people have been changing this region independently and they
|
|
|
815 had different ideas on how to do this.
|
|
|
816
|
|
|
817 The above command does this for you by skipping the regions where only one
|
|
|
818 of the variants clashes with the ancestor but the other variant agrees with
|
|
26263
|
819 it. Typing @kbd{$$} again undoes this setting.
|
|
|
820
|
|
|
821 @item $*
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
822 @kindex $*
|
|
26263
|
823 When merging files with large number of differences, it is sometimes
|
|
|
824 convenient to be able to skip the difference regions for which you already
|
|
|
825 decided which variant is most appropriate. Typing @kbd{$*} will accomplish
|
|
|
826 precisely this.
|
|
|
827
|
|
|
828 To be more precise, this toggles the check for whether the current merge is
|
|
|
829 identical to its default setting, as originally decided by Ediff. For
|
|
|
830 instance, if Ediff is merging according to the `combined' policy, then the
|
|
|
831 merge region is skipped over if it is different from the combination of the
|
|
|
832 regions in buffers A and B. (Warning: swapping buffers A and B will confuse
|
|
|
833 things in this respect). If the merge region is marked as `prefer-A' then
|
|
|
834 this region will be skipped if it differs from the current difference
|
|
|
835 region in buffer A, etc.
|
|
25829
|
836
|
|
|
837 @item /
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
838 @kindex /
|
|
25829
|
839 Displays the ancestor file during merges.
|
|
|
840 @item &
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
841 @kindex &
|
|
25829
|
842 In some situations, such as when one of the files agrees with the ancestor file
|
|
|
843 on a difference region and the other doesn't, Ediff knows what to do: it copies
|
|
|
844 the current difference region from the second buffer into the merge buffer.
|
|
|
845
|
|
|
846 In other cases, the right course of action is not that clearcut, and Ediff
|
|
|
847 would use a default action. The above command changes the default action.
|
|
|
848 The default action can be @samp{default-A} (choose the region from buffer
|
|
|
849 A), @samp{default-B} (choose the region from buffer B), or @samp{combined}
|
|
|
850 (combine the regions from the two buffers).
|
|
|
851 @xref{Merging and diff3}, for further details.
|
|
|
852
|
|
|
853 The command @kbd{&} also affects the regions in the merge buffers that have
|
|
|
854 @samp{default-A}, @samp{default-B}, or @samp{combined} status, provided
|
|
|
855 they weren't changed with respect to the original. For instance, if such a
|
|
|
856 region has the status @samp{default-A} then changing the default action to
|
|
|
857 @samp{default-B} will also replace this merge-buffer's region with the
|
|
|
858 corresponding region from buffer B.
|
|
|
859
|
|
|
860 @item s
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
861 @kindex s
|
|
25829
|
862 Causes the merge window shrink to its minimum size, thereby exposing as much
|
|
|
863 of the variant buffers as possible. Typing `s' again restores
|
|
|
864 the original size of that window.
|
|
|
865
|
|
|
866 With a positive prefix argument, this command enlarges the merge window.
|
|
|
867 E.g., @kbd{4s} increases the size of the window by about 4 lines, if
|
|
|
868 possible. With a negative numeric argument, the size of the merge window
|
|
|
869 shrinks by that many lines, if possible. Thus, @kbd{-s} shrinks the window
|
|
|
870 by about 1 line and @kbd{-3s} by about 3 lines.
|
|
|
871
|
|
|
872 This command is intended only for temporary viewing; therefore, Ediff
|
|
|
873 restores window C to its original size whenever it makes any other change
|
|
|
874 in the window configuration. However, redisplaying (@kbd{C-l}) or jumping
|
|
|
875 to another difference does not affect window C's size.
|
|
|
876
|
|
|
877 The split between the merge window and the variant windows is controlled by
|
|
|
878 the variable @code{ediff-merge-window-share}, which see.
|
|
|
879
|
|
|
880 @item +
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
881 @kindex +
|
|
25829
|
882 Combines the difference regions from buffers A and B and copies the
|
|
|
883 result into the merge buffer. @xref{Merging and diff3}, and the
|
|
|
884 variables @code{ediff-combine-diffs} and @code{ediff-combination-pattern}.
|
|
|
885
|
|
|
886
|
|
|
887 @item =
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
888 @kindex =
|
|
25829
|
889 You may run into situations when a large chunk of text in one file has been
|
|
|
890 edited and then moved to a different place in another file. In such a case,
|
|
|
891 these two chunks of text are unlikely to belong to the same difference
|
|
|
892 region, so the refinement feature of Ediff will not be able to tell you
|
|
|
893 what exactly differs inside these chunks. Since eyeballing large pieces of
|
|
|
894 text is contrary to human nature, Ediff has a special command to help
|
|
|
895 reduce the risk of developing a cataract.
|
|
|
896
|
|
44029
|
897 In other situations, the currently highlighted region might be big and you
|
|
|
898 might want to reconcile of them interactively.
|
|
|
899
|
|
|
900 All of this can be done with the above comand, @kbd{=}, which
|
|
|
901 compares regions within Ediff buffers. Typing @kbd{=} creates a
|
|
|
902 child Ediff session for comparing regions in buffers A, B, or
|
|
|
903 C as follows.
|
|
|
904
|
|
|
905 First, you will be asked whether you want to compare the fine differences
|
|
|
906 between the currently highlighted buffers on a word-by-word basis. If you
|
|
|
907 accept, a child Ediff session will start using the currently highlighted
|
|
|
908 regions. Ediff will let you step over the differences word-wise.
|
|
|
909
|
|
|
910 If you reject the offer, you will be asked to select regions of your choice.
|
|
25829
|
911
|
|
|
912 @emph{If you are comparing 2 files or buffers:}
|
|
43715
|
913 Ediff will ask you to select regions in buffers A and B.
|
|
25829
|
914
|
|
43715
|
915 @emph{If you are comparing 3 files or buffers simultaneously:} Ediff will
|
|
|
916 ask you to choose buffers and then select regions inside those buffers.
|
|
25829
|
917
|
|
|
918 @emph{If you are merging files or buffers (with or without ancestor):}
|
|
43715
|
919 Ediff will ask you to choose which buffer (A or B) to compare with the
|
|
|
920 merge buffer and then select regions in those buffers.
|
|
25829
|
921
|
|
|
922 @end table
|
|
|
923
|
|
|
924 @node Other Session Commands,,Quick Help Commands,Session Commands
|
|
|
925 @section Other Session Commands
|
|
|
926
|
|
|
927 The following commands can be invoked from within any Ediff session,
|
|
|
928 although some of them are not bound to a key.
|
|
|
929
|
|
|
930 @table @code
|
|
|
931 @item eregistry
|
|
|
932 @itemx ediff-show-registry
|
|
|
933 @findex eregistry
|
|
|
934 @findex ediff-show-registry
|
|
|
935 This command brings up the registry of active Ediff sessions. Ediff
|
|
|
936 registry is a device that can be used to resume any active Ediff session
|
|
|
937 (which may have been postponed because the user switched to some other
|
|
|
938 activity). This command is also useful for switching between multiple
|
|
|
939 active Ediff sessions that are run at the same time. The function
|
|
|
940 @code{eregistry} is an alias for @code{ediff-show-registry}.
|
|
|
941 @xref{Registry of Ediff Sessions}, for more information on this registry.
|
|
|
942
|
|
|
943 @item ediff-toggle-multiframe
|
|
|
944 @findex ediff-toggle-multiframe
|
|
|
945 Changes the display from the multi-frame mode (where the quick help window
|
|
|
946 is in a separate frame) to the single-frame mode (where all Ediff buffers
|
|
|
947 share the same frame), and vice versa. See
|
|
|
948 @code{ediff-window-setup-function} for details on how to make either of
|
|
|
949 these modes the default one.
|
|
|
950
|
|
|
951 This function can also be invoked from the Menubar. However, in some
|
|
|
952 cases, the change will take place only after you execute one of the Ediff
|
|
|
953 commands, such as going to the next difference or redisplaying.
|
|
|
954
|
|
42602
|
955 @item ediff-toggle-use-toolbar
|
|
|
956 @findex ediff-toggle-use-toolbar
|
|
|
957 Available in XEmacs only. The Ediff toolbar provides quick access to some
|
|
|
958 of the common Ediff functions. This function toggles the display of the
|
|
|
959 toolbar. If invoked from the menubar, the function may take sometimes
|
|
|
960 effect only after you execute an Ediff command, such as going to the next
|
|
|
961 difference.
|
|
|
962
|
|
|
963 @item ediff-use-toolbar-p
|
|
|
964 @vindex ediff-use-toolbar-p
|
|
|
965 The use of the toolbar can also be specified via the variable
|
|
|
966 @code{ediff-use-toolbar-p} (default is @code{t}). This variable can be set
|
|
|
967 only in @file{.emacs} --- do @strong{not} change it interactively. Use the
|
|
|
968 function @code{ediff-toggle-use-toolbar} instead.
|
|
|
969
|
|
25829
|
970 @item ediff-revert-buffers-then-recompute-diffs
|
|
|
971 @findex ediff-revert-buffers-then-recompute-diffs
|
|
|
972 This command reverts the buffers you are comparing and recomputes their
|
|
|
973 differences. It is useful when, after making changes, you decided to
|
|
|
974 make a fresh start, or if at some point you changed the files being
|
|
|
975 compared but want to discard any changes to comparison buffers that were
|
|
|
976 done since then.
|
|
|
977
|
|
|
978 This command normally asks for confirmation before reverting files.
|
|
|
979 With a prefix argument, it reverts files without asking.
|
|
|
980
|
|
|
981
|
|
|
982 @item ediff-profile
|
|
|
983 @findex ediff-profile
|
|
|
984 Ediff has an admittedly primitive (but useful) facility for profiling
|
|
|
985 Ediff's commands. It is meant for Ediff maintenance---specifically, for
|
|
|
986 making it run faster. The function @code{ediff-profile} toggles
|
|
|
987 profiling of ediff commands.
|
|
|
988 @end table
|
|
|
989
|
|
|
990 @node Registry of Ediff Sessions, Session Groups, Session Commands, Top
|
|
|
991 @chapter Registry of Ediff Sessions
|
|
|
992
|
|
|
993 Ediff maintains a registry of all its invocations that are
|
|
|
994 still @emph{active}. This feature is very convenient for switching among
|
|
|
995 active Ediff sessions or for quickly restarting a suspended Ediff session.
|
|
|
996
|
|
|
997 The focal point of this activity is a buffer
|
|
|
998 called @emph{*Ediff Registry*}. You can display this buffer by typing
|
|
|
999 @kbd{R} in any Ediff Control Buffer or Session Group Buffer
|
|
|
1000 (@pxref{Session Groups}), or by typing
|
|
|
1001 @kbd{M-x eregistry} into the Minibuffer.
|
|
|
1002 The latter would be the fastest way to bring up the registry
|
|
|
1003 buffer if no control or group buffer is displayed in any of the visible
|
|
|
1004 Emacs windows.
|
|
|
1005 If you are in a habit of running multiple long Ediff sessions and often need to
|
|
|
1006 suspend, resume, or switch between them, it may be a good idea to have the
|
|
|
1007 registry buffer permanently displayed in a separate, dedicated window.
|
|
|
1008
|
|
|
1009 The registry buffer has several convenient key bindings.
|
|
|
1010 For instance, clicking mouse button 2 or typing
|
|
|
1011 @kbd{RET} or @kbd{v} over any session record resumes that session.
|
|
|
1012 Session records in the registry buffer provide a fairly complete
|
|
|
1013 description of each session, so it is usually easy to identify the right
|
|
|
1014 session to resume.
|
|
|
1015
|
|
|
1016 Other useful commands are bound to @kbd{SPC} (next registry record)
|
|
|
1017 and @kbd{DEL} (previous registry record). There are other commands as well,
|
|
|
1018 but you don't need to memorize them, since they are listed at the top of
|
|
|
1019 the registry buffer.
|
|
|
1020
|
|
|
1021 @node Session Groups, Remote and Compressed Files, Registry of Ediff Sessions, Top
|
|
|
1022 @chapter Session Groups
|
|
|
1023
|
|
|
1024 Several major entries of Ediff perform comparison and merging on
|
|
|
1025 directories. On entering @code{ediff-directories},
|
|
|
1026 @code{ediff-directories3},
|
|
|
1027 @code{ediff-merge-directories},
|
|
|
1028 @code{ediff-merge-directories-with-ancestor},
|
|
|
1029 @code{ediff-directory-revisions},
|
|
|
1030 @code{ediff-merge-directory-revisions}, or
|
|
|
1031 @code{ediff-merge-directory-revisions-with-ancestor},
|
|
|
1032 the user is presented with a
|
|
|
1033 Dired-like buffer that lists files common to the directories involved along
|
|
|
1034 with their sizes. (The list of common files can be further filtered through
|
|
|
1035 a regular expression, which the user is prompted for.) We call this buffer
|
|
|
1036 @emph{Session Group Panel} because all Ediff sessions associated with the
|
|
|
1037 listed files will have this buffer as a common focal point.
|
|
|
1038
|
|
|
1039 Clicking button 2 or typing @kbd{RET} or @kbd{v} over a
|
|
|
1040 record describing files invokes Ediff in the appropriate mode on these
|
|
|
1041 files. You can come back to the session group buffer associated with a
|
|
|
1042 particular invocation of Ediff by typing @kbd{M} in Ediff control buffer of
|
|
|
1043 that invocation.
|
|
|
1044
|
|
|
1045 Many commands are available in the session group buffer; some are
|
|
|
1046 applicable only to certain types of work. The relevant commands are always
|
|
|
1047 listed at the top of each session group buffer, so there is no need to
|
|
|
1048 memorize them.
|
|
|
1049
|
|
|
1050 In directory comparison or merging, a session group panel displays only the
|
|
|
1051 files common to all directories involved. The differences are kept in a
|
|
43715
|
1052 separate @emph{directory difference buffer} and are conveniently displayed
|
|
|
1053 by typing @kbd{D} to the corresponding session group panel. Thus, as an
|
|
|
1054 added benefit, Ediff can be used to compare the contents of up to three
|
|
|
1055 directories.
|
|
|
1056
|
|
|
1057 @cindex Directory difference buffer
|
|
|
1058 Sometimes it is desirable to copy some files from one directory to another
|
|
|
1059 without exiting Ediff. The @emph{directory difference buffer}, which is
|
|
|
1060 displayed by typing @kbd{D} as discussed above, can be used for this
|
|
|
1061 purpose. If a file is, say, in Ediff's Directory A, but is missing in
|
|
|
1062 Ediff's Directory B (Ediff will refuse to override existing files), then
|
|
|
1063 typing @kbd{C} or clicking mouse button 2 over that file (which must be
|
|
|
1064 displayed in directory difference buffer) will copy that file from
|
|
|
1065 Directory A to Directory B.
|
|
25829
|
1066
|
|
|
1067 Session records in session group panels are also marked with @kbd{+}, for
|
|
|
1068 active sessions, and with @kbd{-}, for finished sessions.
|
|
|
1069
|
|
|
1070 Sometimes, it is convenient to exclude certain sessions from a group.
|
|
|
1071 Usually this happens when the user doesn't intend to run Ediff of certain
|
|
|
1072 files in the group, and the corresponding session records just add clutter
|
|
|
1073 to the session group buffer. To help alleviate this problem, the user can
|
|
|
1074 type @kbd{h} to mark a session as a candidate for exclusion and @kbd{x} to
|
|
|
1075 actually hide the marked sessions. There actions are reversible: with a
|
|
|
1076 prefix argument, @kbd{h} unmarks the session under the cursor, and @kbd{x}
|
|
|
1077 brings the hidden sessions into the view (@kbd{x} doesn't unmark them,
|
|
|
1078 though, so the user has to explicitly unmark the sessions of interest).
|
|
|
1079
|
|
|
1080 Group sessions also understand the command @kbd{m}, which marks sessions
|
|
|
1081 for future operations (other than hiding) on a group of sessions. At present,
|
|
|
1082 the only such group-level operation is the creation of a multi-file patch.
|
|
|
1083
|
|
|
1084 @vindex ediff-autostore-merges
|
|
|
1085 For group sessions created to merge files, Ediff can store all merges
|
|
|
1086 automatically in a directory. The user is asked to specify such directory
|
|
|
1087 if the value of @code{ediff-autostore-merges} is non-nil. If the value is
|
|
|
1088 @code{nil}, nothing is done to the merge buffers---it will be the user's
|
|
|
1089 responsibility to save them. If the value is @code{t}, the user will be
|
|
|
1090 asked where to save the merge buffers in all merge jobs, even those that do
|
|
|
1091 not originate from a session group. It the value is neither @code{nil} nor
|
|
|
1092 @code{t}, the merge buffer is saved @emph{only} if this merge session was
|
|
|
1093 invoked from a session group. This behavior is implemented in the function
|
|
|
1094 @code{ediff-maybe-save-and-delete-merge}, which is a hook in
|
|
|
1095 @code{ediff-quit-merge-hook}. The user can supply a different hook, if
|
|
|
1096 necessary.
|
|
|
1097
|
|
|
1098 The variable @code{ediff-autostore-merges} is buffer-local, so it can be
|
|
29165
|
1099 set on a per-buffer basis. Therefore, use @code{setq-default} to change
|
|
|
1100 this variable globally.
|
|
25829
|
1101
|
|
|
1102 @cindex Multi-file patches
|
|
42288
|
1103 A multi-file patch is a concatenated output of several runs of the Unix
|
|
33021
|
1104 @code{diff} command (some versions of @code{diff} let you create a
|
|
25829
|
1105 multi-file patch in just one run). Ediff facilitates creation of
|
|
|
1106 multi-file patches as follows. If you are in a session group buffer
|
|
|
1107 created in response to @code{ediff-directories} or
|
|
|
1108 @code{ediff-directory-revisions}, you can mark (by typing @kbd{m}) the
|
|
|
1109 desired Ediff sessions and then type @kbd{P} to create a
|
|
|
1110 multi-file patch of those marked sessions.
|
|
|
1111 Ediff will then display a buffer containing the patch.
|
|
33021
|
1112 The patch is generated by invoking @code{diff} on all marked individual
|
|
25829
|
1113 sessions (represented by files) and session groups (represented by
|
|
|
1114 directories). Ediff will also recursively descend into any @emph{unmarked}
|
|
|
1115 session group and will search for marked sessions there. In this way, you
|
|
|
1116 can create multi-file patches that span file subtrees that grow out of
|
|
|
1117 any given directory.
|
|
|
1118
|
|
|
1119 In an @code{ediff-directories} session, it is enough to just mark the
|
|
|
1120 requisite sessions. In @code{ediff-directory-revisions} revisions, the
|
|
|
1121 marked sessions must also be active, or else Ediff will refuse to produce a
|
|
|
1122 multi-file patch. This is because, in the latter-style sessions, there are
|
|
|
1123 many ways to create diff output, and it is easier to handle by running
|
|
|
1124 Ediff on the inactive sessions.
|
|
|
1125
|
|
|
1126 Last, but not least, by typing @kbd{=}, you can quickly find out which
|
|
|
1127 sessions have identical files, so you won't have to run Ediff on those
|
|
|
1128 sessions. This, however, works only on local, uncompressed files.
|
|
|
1129 For compressed or remote files, this command won't report anything.
|
|
|
1130
|
|
|
1131
|
|
|
1132 @node Remote and Compressed Files, Customization, Session Groups, Top
|
|
|
1133 @chapter Remote and Compressed Files
|
|
|
1134
|
|
|
1135 Ediff works with remote, compressed, and encrypted files. Ediff
|
|
|
1136 supports @file{ange-ftp.el}, @file{jka-compr.el}, @file{uncompress.el}
|
|
|
1137 and @file{crypt++.el}, but it may work with other similar packages as
|
|
|
1138 well. This means that you can compare files residing on another
|
|
|
1139 machine, or you can apply a patch to a file on another machine. Even
|
|
|
1140 the patch itself can be a remote file!
|
|
|
1141
|
|
|
1142 When patching compressed or remote files, Ediff does not rename the source
|
|
|
1143 file (unlike what the @code{patch} utility would usually do). Instead, the
|
|
|
1144 source file retains its name and the result of applying the patch is placed
|
|
|
1145 in a temporary file that has the suffix @file{_patched} attached.
|
|
|
1146 Generally, this applies to files that are handled using black magic, such
|
|
|
1147 as special file handlers (ange-ftp and some compression and encryption
|
|
|
1148 packages also use this method).
|
|
|
1149
|
|
|
1150 Regular files are treated by the @code{patch} utility in the usual manner,
|
|
|
1151 i.e., the original is renamed into @file{source-name.orig} and the result
|
|
|
1152 of the patch is placed into the file source-name (@file{_orig} is used
|
|
|
1153 on systems like VMS, DOS, etc.)
|
|
|
1154
|
|
|
1155 @node Customization, Credits, Remote and Compressed Files, Top
|
|
|
1156 @chapter Customization
|
|
|
1157
|
|
|
1158 Ediff has a rather self-explanatory interface, and in most cases you
|
|
|
1159 won't need to change anything. However, should the need arise, there are
|
|
|
1160 extensive facilities for changing the default behavior.
|
|
|
1161
|
|
|
1162 Most of the customization can be done by setting various variables in the
|
|
|
1163 @file{.emacs} file. Some customization (mostly window-related
|
|
|
1164 customization and faces) can be done by putting appropriate lines in
|
|
|
1165 @file{.Xdefaults}, @file{.xrdb}, or whatever X resource file is in use.
|
|
|
1166
|
|
|
1167 With respect to the latter, please note that the X resource
|
|
|
1168 for Ediff customization is `Ediff', @emph{not} `emacs'.
|
|
|
1169 @xref{Window and Frame Configuration},
|
|
|
1170 @xref{Highlighting Difference Regions}, for further details. Please also
|
|
|
1171 refer to Emacs manual for the information on how to set Emacs X resources.
|
|
|
1172
|
|
|
1173 @menu
|
|
|
1174 * Hooks:: Customization via the hooks.
|
|
|
1175 * Quick Help Customization:: How to customize Ediff's quick help feature.
|
|
|
1176 * Window and Frame Configuration:: Controlling the way Ediff displays things.
|
|
|
1177 * Selective Browsing:: Advanced browsing through difference regions.
|
|
|
1178 * Highlighting Difference Regions:: Controlling highlighting.
|
|
|
1179 * Narrowing:: Comparing regions, windows, etc.
|
|
|
1180 * Refinement of Difference Regions:: How to control the refinement process.
|
|
|
1181 * Patch and Diff Programs:: Changing the utilities that compute differences
|
|
|
1182 and apply patches.
|
|
|
1183 * Merging and diff3:: How to customize Ediff in its Merge Mode.
|
|
|
1184 * Support for Version Control:: Changing the version control package.
|
|
|
1185 You are not likely to do that.
|
|
|
1186 * Customizing the Mode Line:: Changing the look of the mode line in Ediff.
|
|
|
1187 * Miscellaneous:: Other customization.
|
|
|
1188 * Notes on Heavy-duty Customization:: Customization for the gurus.
|
|
|
1189 @end menu
|
|
|
1190
|
|
|
1191 @node Hooks, Quick Help Customization, Customization, Customization
|
|
|
1192 @section Hooks
|
|
|
1193
|
|
|
1194 The bulk of customization can be done via the following hooks:
|
|
|
1195
|
|
|
1196 @table @code
|
|
|
1197 @item ediff-load-hook
|
|
|
1198 @vindex ediff-load-hook
|
|
|
1199 This hook can be used to change defaults after Ediff is loaded.
|
|
|
1200
|
|
33019
|
1201 @item ediff-before-setup-hook
|
|
|
1202 @vindex ediff-before-setup-hook
|
|
|
1203 Hook that is run just before Ediff rearranges windows to its liking.
|
|
|
1204 Can be used to save windows configuration.
|
|
|
1205
|
|
25829
|
1206 @item ediff-keymap-setup-hook
|
|
|
1207 @vindex ediff-keymap-setup-hook
|
|
|
1208 @vindex ediff-mode-map
|
|
|
1209 This hook can be used to alter bindings in Ediff's keymap,
|
|
|
1210 @code{ediff-mode-map}. These hooks are
|
|
|
1211 run right after the default bindings are set but before
|
|
|
1212 @code{ediff-load-hook}. The regular user needs not be concerned with this
|
|
|
1213 hook---it is provided for implementors of other Emacs packages built on top
|
|
|
1214 of Ediff.
|
|
|
1215
|
|
|
1216 @item ediff-before-setup-windows-hook
|
|
|
1217 @itemx ediff-after-setup-windows-hook
|
|
|
1218 @vindex ediff-before-setup-windows-hook
|
|
|
1219 @vindex ediff-after-setup-windows-hook
|
|
|
1220 These two hooks are called before and after Ediff sets up its window
|
|
33019
|
1221 configuration. These hooks are run each time Ediff rearranges windows to
|
|
|
1222 its liking. This happens whenever it detects that the user changed the
|
|
|
1223 windows setup.
|
|
25829
|
1224
|
|
|
1225 @item ediff-suspend-hook
|
|
|
1226 @itemx ediff-quit-hook
|
|
|
1227 @vindex ediff-suspend-hook
|
|
|
1228 @vindex ediff-quit-hook
|
|
|
1229 These two hooks are run when you suspend or quit Ediff. They can be
|
|
|
1230 used to set desired window configurations, delete files Ediff didn't
|
|
|
1231 want to clean up after exiting, etc.
|
|
|
1232
|
|
|
1233 By default, @code{ediff-quit-hook} holds one hook function,
|
|
|
1234 @code{ediff-cleanup-mess}, which cleans after Ediff, as appropriate in
|
|
|
1235 most cases. You probably won't want to change it, but you might
|
|
|
1236 want to add other hook functions.
|
|
|
1237
|
|
|
1238 Keep in mind that hooks executing before @code{ediff-cleanup-mess} start
|
|
|
1239 in @code{ediff-control-buffer;} they should also leave
|
|
|
1240 @code{ediff-control-buffer} as the current buffer when they finish.
|
|
|
1241 Hooks that are executed after @code{ediff-cleanup-mess} should expect
|
|
|
1242 the current buffer be either buffer A or buffer B.
|
|
|
1243 @code{ediff-cleanup-mess} doesn't kill the buffers being compared or
|
|
|
1244 merged (see @code{ediff-cleanup-hook}, below).
|
|
|
1245
|
|
|
1246 @item ediff-cleanup-hook
|
|
|
1247 @vindex ediff-cleanup-hook
|
|
|
1248 This hook is run just before @code{ediff-quit-hook}. This is a good
|
|
|
1249 place to do various cleanups, such as deleting the variant buffers.
|
|
|
1250 Ediff provides a function, @code{ediff-janitor}, as one such possible
|
|
|
1251 hook, which you can add to @code{ediff-cleanup-hook} with
|
|
|
1252 @code{add-hooks}.
|
|
|
1253
|
|
|
1254 @findex ediff-janitor
|
|
|
1255 This function kills buffers A, B, and, possibly, C, if these buffers aren't
|
|
|
1256 modified. In merge jobs, buffer C is never deleted. However, the side
|
|
|
1257 effect of using this function is that you may not be able to compare the
|
|
|
1258 same buffer in two separate Ediff sessions: quitting one of them will
|
|
|
1259 delete this buffer in another session as well.
|
|
|
1260
|
|
|
1261 @item ediff-quit-merge-hook
|
|
|
1262 @vindex ediff-quit-merge-hook
|
|
|
1263 @vindex ediff-autostore-merges
|
|
|
1264 @findex ediff-maybe-save-and-delete-merge
|
|
|
1265 This hook is called when Ediff quits a merge job. By default, the value is
|
|
|
1266 @code{ediff-maybe-save-and-delete-merge}, which is a function that attempts
|
|
|
1267 to save the merge buffer according to the value of
|
|
|
1268 @code{ediff-autostore-merges}, as described later.
|
|
|
1269
|
|
|
1270 @item ediff-before-setup-control-frame-hook
|
|
|
1271 @itemx ediff-after-setup-control-frame-hook
|
|
|
1272 @vindex ediff-before-setup-control-frame-hook
|
|
|
1273 @vindex ediff-after-setup-control-frame-hook
|
|
|
1274 These two hooks run before and after Ediff sets up the control frame.
|
|
|
1275 They can be used to relocate Ediff control frame when Ediff runs in a
|
|
|
1276 multiframe mode (i.e., when the control buffer is in its own dedicated
|
|
|
1277 frame). Be aware that many variables that drive Ediff are local to
|
|
|
1278 Ediff Control Panel (@code{ediff-control-buffer}), which requires
|
|
|
1279 special care in writing these hooks. Take a look at
|
|
|
1280 @code{ediff-default-suspend-hook} and @code{ediff-default-quit-hook} to
|
|
|
1281 see what's involved.
|
|
|
1282
|
|
|
1283 @item ediff-startup-hook
|
|
|
1284 @vindex ediff-startup-hook
|
|
|
1285 This hook is run at the end of Ediff startup.
|
|
|
1286
|
|
|
1287 @item ediff-select-hook
|
|
|
1288 @vindex ediff-select-hook
|
|
|
1289 This hook is run after Ediff selects the next difference region.
|
|
|
1290
|
|
|
1291 @item ediff-unselect-hook
|
|
|
1292 @vindex ediff-unselect-hook
|
|
|
1293 This hook is run after Ediff unselects the current difference region.
|
|
|
1294
|
|
|
1295 @item ediff-prepare-buffer-hook
|
|
|
1296 @vindex ediff-prepare-buffer-hook
|
|
|
1297 This hook is run for each Ediff buffer (A, B, C) right after the buffer
|
|
|
1298 is arranged.
|
|
|
1299
|
|
|
1300 @item ediff-display-help-hook
|
|
|
1301 @vindex ediff-display-help-hook
|
|
|
1302 Ediff runs this hook each time after setting up the help message. It
|
|
|
1303 can be used to alter the help message for custom packages that run on
|
|
|
1304 top of Ediff.
|
|
|
1305
|
|
|
1306 @item ediff-mode-hook
|
|
|
1307 @vindex ediff-mode-hook
|
|
|
1308 This hook is run just after Ediff mode is set up in the control
|
|
|
1309 buffer. This is done before any Ediff window is created. You can use it to
|
|
|
1310 set local variables that alter the look of the display.
|
|
|
1311
|
|
|
1312 @item ediff-registry-setup-hook
|
|
|
1313 @vindex ediff-registry-setup-hook
|
|
|
1314 Hooks run after setting up the registry for all active Ediff session.
|
|
|
1315 @xref{Session Groups}, for details.
|
|
33019
|
1316 @item ediff-before-session-group-setup-hook
|
|
|
1317 @vindex ediff-before-session-group-setup-hook
|
|
|
1318 Hooks run before setting up a control panel for a group of related Ediff
|
|
|
1319 sessions. Can be used, for example, to save window configuration to restore
|
|
|
1320 later.
|
|
|
1321 @item ediff-after-session-group-setup-hook
|
|
|
1322 @vindex ediff-after-session-group-setup-hook
|
|
25829
|
1323 Hooks run after setting up a control panel for a group of related Ediff
|
|
|
1324 sessions. @xref{Session Groups}, for details.
|
|
|
1325 @item ediff-quit-session-group-hook
|
|
|
1326 @vindex ediff-quit-session-group-hook
|
|
|
1327 Hooks run just before exiting a session group.
|
|
|
1328 @item ediff-meta-buffer-keymap-setup-hook
|
|
|
1329 @vindex ediff-meta-buffer-keymap-setup-hook
|
|
|
1330 @vindex ediff-meta-buffer-map
|
|
|
1331 Hooks run just after setting up the @code{ediff-meta-buffer-map} --- the
|
|
|
1332 map that controls key bindings in the meta buffer. Since
|
|
|
1333 @code{ediff-meta-buffer-map} is a local variable, you can set different
|
|
|
1334 bindings for different kinds of meta buffers.
|
|
|
1335 @end table
|
|
|
1336
|
|
|
1337 @node Quick Help Customization, Window and Frame Configuration, Hooks, Customization
|
|
|
1338 @section Quick Help Customization
|
|
|
1339 @vindex ediff-use-long-help-message
|
|
|
1340 @vindex ediff-control-buffer
|
|
|
1341 @vindex ediff-startup-hook
|
|
|
1342 @vindex ediff-help-message
|
|
|
1343
|
|
|
1344 Ediff provides quick help using its control panel window. Since this window
|
|
|
1345 takes a fair share of the screen real estate, you can toggle it off by
|
|
|
1346 typing @kbd{?}. The control window will then shrink to just one line and a
|
|
|
1347 mode line, displaying a short help message.
|
|
|
1348
|
|
|
1349 The variable @code{ediff-use-long-help-message} tells Ediff whether
|
|
|
1350 you use the short message or the long one. By default, it
|
|
|
1351 is set to @code{nil}, meaning that the short message is used.
|
|
|
1352 Set this to @code{t}, if you want Ediff to use the long
|
|
|
1353 message by default. This property can always be changed interactively, by
|
|
|
1354 typing @kbd{?} into Ediff Control Buffer.
|
|
|
1355
|
|
|
1356 If you want to change the appearance of the help message on a per-buffer
|
|
|
1357 basis, you must use @code{ediff-startup-hook} to change the value of
|
|
|
1358 the variable @code{ediff-help-message}, which is local to
|
|
|
1359 @code{ediff-control-buffer}.
|
|
|
1360
|
|
|
1361 @node Window and Frame Configuration, Selective Browsing, Quick Help Customization, Customization
|
|
|
1362 @section Window and Frame Configuration
|
|
|
1363
|
|
|
1364 On a non-windowing display, Ediff sets things up in one frame, splitting
|
|
|
1365 it between a small control window and the windows for buffers A, B, and C.
|
|
|
1366 The split between these windows can be horizontal or
|
|
|
1367 vertical, which can be changed interactively by typing @kbd{|} while the
|
|
|
1368 cursor is in the control window.
|
|
|
1369
|
|
|
1370 On a window display, Ediff sets up a dedicated frame for Ediff Control
|
|
|
1371 Panel and then it chooses windows as follows: If one of the buffers
|
|
|
1372 is invisible, it is displayed in the currently selected frame. If
|
|
|
1373 a buffer is visible, it is displayed in the frame where it is visible.
|
|
|
1374 If, according to the above criteria, the two buffers fall into the same
|
|
|
1375 frame, then so be it---the frame will be shared by the two. The same
|
|
|
1376 algorithm works when you type @kbd{C-l} (@code{ediff-recenter}), @kbd{p}
|
|
|
1377 (@code{ediff-previous-difference}), @kbd{n}
|
|
|
1378 (@code{ediff-next-difference}), etc.
|
|
|
1379
|
|
|
1380 The above behavior also depends on whether the current frame is splittable,
|
|
|
1381 dedicated, etc. Unfortunately, the margin of this book is too narrow to
|
|
|
1382 present the details of this remarkable algorithm.
|
|
|
1383
|
|
|
1384 The upshot of all this is that you can compare buffers in one frame or
|
|
|
1385 in different frames. The former is done by default, while the latter can
|
|
|
1386 be achieved by arranging buffers A, B (and C, if applicable) to be seen in
|
|
|
1387 different frames. Ediff respects these arrangements, automatically
|
|
|
1388 adapting itself to the multi-frame mode.
|
|
|
1389
|
|
|
1390 Ediff uses the following variables to set up its control panel
|
|
|
1391 (a.k.a.@: control buffer, a.k.a.@: quick help window):
|
|
|
1392
|
|
|
1393 @table @code
|
|
|
1394 @item ediff-control-frame-parameters
|
|
|
1395 @vindex ediff-control-frame-parameters
|
|
|
1396 You can change or augment this variable including the font, color,
|
|
|
1397 etc. The X resource name of Ediff Control Panel frames is @samp{Ediff}. Under
|
|
|
1398 X-windows, you can use this name to set up preferences in your
|
|
|
1399 @file{~/.Xdefaults}, @file{~/.xrdb}, or whatever X resource file is in
|
|
|
1400 use. Usually this is preferable to changing
|
|
|
1401 @code{ediff-control-frame-parameters} directly. For instance, you can
|
|
|
1402 specify in @file{~/.Xdefaults} the color of the control frame
|
|
|
1403 using the resource @samp{Ediff*background}.
|
|
|
1404
|
|
|
1405 In general, any X resource pertaining the control frame can be reached
|
|
|
1406 via the prefix @code{Ediff*}.
|
|
|
1407
|
|
|
1408 @item ediff-control-frame-position-function
|
|
|
1409 @vindex ediff-control-frame-position-function
|
|
|
1410 The preferred way of specifying the position of the control frame is by
|
|
|
1411 setting the variable @code{ediff-control-frame-position-function} to an
|
|
|
1412 appropriate function.
|
|
|
1413 The default value of this variable is
|
|
|
1414 @code{ediff-make-frame-position}. This function places the control frame in
|
|
|
1415 the vicinity of the North-East corner of the frame displaying buffer A.
|
|
|
1416
|
|
|
1417 @findex ediff-make-frame-position
|
|
|
1418 @end table
|
|
|
1419
|
|
|
1420 The following variables can be used to adjust the location produced by
|
|
|
1421 @code{ediff-make-frame-position} and for related customization.
|
|
|
1422
|
|
|
1423 @table @code
|
|
|
1424 @item ediff-narrow-control-frame-leftward-shift
|
|
|
1425 @vindex ediff-narrow-control-frame-leftward-shift
|
|
|
1426 Specifies the number of characters for shifting
|
|
|
1427 the control frame from the rightmost edge of frame A when the control
|
|
|
1428 frame is displayed as a small window.
|
|
|
1429
|
|
|
1430 @item ediff-wide-control-frame-rightward-shift
|
|
|
1431 @vindex ediff-wide-control-frame-rightward-shift
|
|
|
1432 Specifies the rightward shift of the control frame
|
|
|
1433 from the left edge of frame A when the control frame shows the full
|
|
|
1434 menu of options.
|
|
|
1435
|
|
|
1436 @item ediff-control-frame-upward-shift
|
|
|
1437 @vindex ediff-control-frame-upward-shift
|
|
|
1438 Specifies the number of pixels for the upward shift
|
|
|
1439 of the control frame.
|
|
|
1440
|
|
|
1441 @item ediff-prefer-iconified-control-frame
|
|
|
1442 @vindex ediff-prefer-iconified-control-frame
|
|
|
1443 If this variable is @code{t}, the control frame becomes iconified
|
|
|
1444 automatically when you toggle the quick help message off. This saves
|
|
|
1445 valuable real estate on the screen. Toggling help back will deiconify
|
|
|
1446 the control frame.
|
|
|
1447
|
|
|
1448 To start Ediff with an iconified Control Panel, you should set this
|
|
|
1449 variable to @code{t} and @code{ediff-prefer-long-help-message} to
|
|
|
1450 @code{nil} (@pxref{Quick Help Customization}). This behavior is useful
|
|
26263
|
1451 only if icons are allowed to accept keybord input (which depend on the
|
|
|
1452 window manager and other factors).
|
|
25829
|
1453 @end table
|
|
|
1454
|
|
|
1455 @findex ediff-setup-windows
|
|
|
1456 To make more creative changes in the way Ediff sets up windows, you can
|
|
|
1457 rewrite the function @code{ediff-setup-windows}. However, we believe
|
|
|
1458 that detaching Ediff Control Panel from the rest and making it into a
|
|
|
1459 separate frame offers an important opportunity by allowing you to
|
|
|
1460 iconify that frame. The icon will usually accept all of the Ediff
|
|
|
1461 commands, but will free up valuable real estate on your screen (this may
|
|
|
1462 depend on your window manager, though).
|
|
|
1463
|
|
|
1464 The following variable controls how windows are set up:
|
|
|
1465
|
|
|
1466 @table @code
|
|
|
1467 @item ediff-window-setup-function
|
|
|
1468 @vindex ediff-window-setup-function
|
|
|
1469 The multiframe setup is done by the
|
|
|
1470 @code{ediff-setup-windows-multiframe} function, which is the default on
|
|
|
1471 windowing displays. The plain setup, one where all windows are always
|
|
|
1472 in one frame, is done by @code{ediff-setup-windows-plain}, which is the
|
|
|
1473 default on a non-windowing display (or in an xterm window). In fact,
|
|
|
1474 under Emacs, you can switch freely between these two setups by executing
|
|
|
1475 the command @code{ediff-toggle-multiframe} using the Minibuffer of the
|
|
|
1476 Menubar.
|
|
|
1477 @findex ediff-setup-windows-multiframe
|
|
|
1478 @findex ediff-setup-windows-plain
|
|
|
1479 @findex ediff-toggle-multiframe
|
|
|
1480
|
|
|
1481 If you don't like any of these setups, write your own function. See the
|
|
|
1482 documentation for @code{ediff-window-setup-function} for the basic
|
|
|
1483 guidelines. However, writing window setups is not easy, so you should
|
|
|
1484 first take a close look at @code{ediff-setup-windows-plain} and
|
|
|
1485 @code{ediff-setup-windows-multiframe}.
|
|
|
1486 @end table
|
|
|
1487
|
|
|
1488 You can run multiple Ediff sessions at once, by invoking Ediff several
|
|
|
1489 times without exiting previous Ediff sessions. Different sessions
|
|
|
1490 may even operate on the same pair of files.
|
|
|
1491
|
|
|
1492 Each session has its own Ediff Control Panel and all the regarding a
|
|
|
1493 particular session is local to the associated control panel buffer. You
|
|
|
1494 can switch between sessions by suspending one session and then switching
|
|
|
1495 to another control panel. (Different control panel buffers are
|
|
|
1496 distinguished by a numerical suffix, e.g., @samp{Ediff Control Panel<3>}.)
|
|
|
1497
|
|
|
1498 @node Selective Browsing, Highlighting Difference Regions, Window and Frame Configuration, Customization
|
|
|
1499 @section Selective Browsing
|
|
|
1500
|
|
|
1501 Sometimes it is convenient to be able to step through only some difference
|
|
|
1502 regions, those that match certain regular expressions, and to ignore all
|
|
|
1503 others. On other occasions, you may want to ignore difference regions that
|
|
|
1504 match some regular expressions, and to look only at the rest.
|
|
|
1505
|
|
|
1506 The commands @kbd{#f} and @kbd{#h} let you do precisely this.
|
|
|
1507
|
|
|
1508 Typing @kbd{#f} lets you specify regular expressions that match difference
|
|
|
1509 regions you want to focus on.
|
|
|
1510 We shall call these regular expressions @var{regexp-A}, @var{regexp-B} and
|
|
|
1511 @var{regexp-C}.
|
|
|
1512 Ediff will then start stepping through only those difference regions
|
|
|
1513 where the region in buffer A matches @var{regexp-A} and/or the region in
|
|
|
1514 buffer B matches @var{regexp-B}, etc. Whether `and' or `or' will be used
|
|
|
1515 depends on how you respond to a question.
|
|
|
1516
|
|
|
1517 When scanning difference regions for the aforesaid regular expressions,
|
|
|
1518 Ediff narrows the buffers to those regions. This means that you can use
|
|
|
1519 the expressions @kbd{\`} and @kbd{\'} to tie search to the beginning or end
|
|
|
1520 of the difference regions.
|
|
|
1521
|
|
|
1522 On the other hand, typing @kbd{#h} lets you specify (hide) uninteresting
|
|
|
1523 regions. That is, if a difference region in buffer A matches
|
|
|
1524 @var{regexp-A}, the corresponding region in buffer B matches @var{regexp-B}
|
|
|
1525 and (if applicable) buffer C's region matches @var{regexp-C}, then the
|
|
|
1526 region will be ignored by the commands @kbd{n}/@key{SPC}
|
|
|
1527 (@code{ediff-next-difference}) and @kbd{p}/@key{DEL}
|
|
|
1528 (@code{ediff-previous-difference}) commands.
|
|
|
1529
|
|
|
1530 Typing @kbd{#f} and @kbd{#h} toggles selective browsing on and off.
|
|
|
1531
|
|
|
1532 Note that selective browsing affects only @code{ediff-next-difference}
|
|
|
1533 and @code{ediff-previous-difference}, i.e., the commands
|
|
|
1534 @kbd{n}/@key{SPC} and @kbd{p}/@key{DEL}. @kbd{#f} and @kbd{#h} do not
|
|
|
1535 change the position of the point in the buffers. And you can still jump
|
|
|
1536 directly (using @kbd{j}) to any numbered
|
|
|
1537 difference.
|
|
|
1538
|
|
|
1539 Users can supply their own functions to specify how Ediff should do
|
|
|
1540 selective browsing. To change the default Ediff function, add a function to
|
|
|
1541 @code{ediff-load-hook} which will do the following assignments:
|
|
|
1542
|
|
|
1543 @example
|
|
|
1544 (setq ediff-hide-regexp-matches-function 'your-hide-function)
|
|
|
1545 (setq ediff-focus-on-regexp-matches-function 'your-focus-function)
|
|
|
1546 @end example
|
|
|
1547
|
|
|
1548 @strong{Useful hint}: To specify a regexp that matches everything, don't
|
|
|
1549 simply type @key{RET} in response to a prompt. Typing @key{RET} tells Ediff
|
|
|
1550 to accept the default value, which may not be what you want. Instead, you
|
|
|
1551 should enter something like @key{^} or @key{$}. These match every
|
|
|
1552 line.
|
|
|
1553
|
|
|
1554 You can use the status command, @kbd{i}, to find out whether
|
|
|
1555 selective browsing is currently in effect.
|
|
|
1556
|
|
|
1557 The regular expressions you specified are kept in the local variables
|
|
|
1558 @code{ediff-regexp-focus-A}, @code{ediff-regexp-focus-B},
|
|
|
1559 @code{ediff-regexp-focus-C}, @code{ediff-regexp-hide-A},
|
|
|
1560 @code{ediff-regexp-hide-B}, @code{ediff-regexp-hide-C}. Their default value
|
|
|
1561 is the empty string (i.e., nothing is hidden or focused on). To change the
|
|
|
1562 default, set these variables in @file{.emacs} using @code{setq-default}.
|
|
|
1563
|
|
|
1564 In addition to the ability to ignore regions that match regular
|
|
|
1565 expressions, Ediff can be ordered to start skipping over certain
|
|
|
1566 ``uninteresting'' difference regions. This is controlled by the following
|
|
|
1567 variable:
|
|
|
1568
|
|
|
1569 @table @code
|
|
|
1570 @item ediff-ignore-similar-regions
|
|
|
1571 @vindex ediff-ignore-similar-regions
|
|
|
1572 If @code{t}, causes Ediff to skip over "uninteresting" difference regions,
|
|
|
1573 which are the regions where the variants differ only in the amount of the
|
|
|
1574 white space and newlines. This feature can be toggled on/off interactively,
|
|
|
1575 via the command @kbd{##}.
|
|
|
1576 @end table
|
|
|
1577
|
|
|
1578 @strong{Note:} In order for this feature to work, auto-refining of
|
|
|
1579 difference regions must be on, since otherwise Ediff won't know if there
|
|
|
1580 are fine differences between regions. On devices where Emacs can display
|
|
|
1581 faces, auto-refining is a default, but it is not turned on by default on
|
|
|
1582 text-only terminals. In that case, you must explicitly turn auto-refining
|
|
|
1583 on (such as, by typing @kbd{@@}).
|
|
|
1584
|
|
|
1585 @strong{Reassurance:} If many such uninteresting regions appear in a row,
|
|
|
1586 Ediff may take a long time to skip over them because it has to compute fine
|
|
|
1587 differences of all intermediate regions. This delay does not indicate any
|
|
|
1588 problem.
|
|
|
1589
|
|
|
1590 @node Highlighting Difference Regions, Narrowing, Selective Browsing, Customization
|
|
|
1591 @section Highlighting Difference Regions
|
|
|
1592
|
|
|
1593 The following variables control the way Ediff highlights difference
|
|
|
1594 regions:
|
|
|
1595
|
|
|
1596 @table @code
|
|
|
1597 @item ediff-before-flag-bol
|
|
|
1598 @itemx ediff-after-flag-eol
|
|
|
1599 @itemx ediff-before-flag-mol
|
|
|
1600 @itemx ediff-after-flag-mol
|
|
|
1601 @vindex ediff-before-flag-bol
|
|
|
1602 @vindex ediff-after-flag-eol
|
|
|
1603 @vindex ediff-before-flag-mol
|
|
|
1604 @vindex ediff-after-flag-mol
|
|
|
1605 These variables hold strings that Ediff uses to mark the beginning and the
|
|
|
1606 end of the differences found in files A, B, and C on devices where Emacs
|
|
|
1607 cannot display faces. Ediff uses different flags to highlight regions that
|
|
|
1608 begin/end at the beginning/end of a line or in a middle of a line.
|
|
|
1609
|
|
|
1610 @item ediff-current-diff-face-A
|
|
|
1611 @itemx ediff-current-diff-face-B
|
|
|
1612 @itemx ediff-current-diff-face-C
|
|
|
1613 @vindex ediff-current-diff-face-A
|
|
|
1614 @vindex ediff-current-diff-face-B
|
|
|
1615 @vindex ediff-current-diff-face-C
|
|
|
1616 Ediff uses these faces to highlight current differences on devices where
|
|
|
1617 Emacs can display faces. These and subsequently described faces can be set
|
|
|
1618 either in @file{.emacs} or in @file{.Xdefaults}. The X resource for Ediff
|
|
|
1619 is @samp{Ediff}, @emph{not} @samp{emacs}. Please refer to Emacs manual for
|
|
|
1620 the information on how to set X resources.
|
|
|
1621 @item ediff-fine-diff-face-A
|
|
|
1622 @itemx ediff-fine-diff-face-B
|
|
|
1623 @itemx ediff-fine-diff-face-C
|
|
|
1624 @vindex ediff-fine-diff-face-A
|
|
|
1625 @vindex ediff-fine-diff-face-B
|
|
|
1626 @vindex ediff-fine-diff-face-C
|
|
|
1627 Ediff uses these faces to show the fine differences between the current
|
|
|
1628 differences regions in buffers A, B, and C, respectively.
|
|
|
1629
|
|
|
1630 @item ediff-even-diff-face-A
|
|
|
1631 @itemx ediff-even-diff-face-B
|
|
|
1632 @itemx ediff-even-diff-face-C
|
|
|
1633 @itemx ediff-odd-diff-face-A
|
|
|
1634 @itemx ediff-odd-diff-face-B
|
|
|
1635 @itemx ediff-odd-diff-face-C
|
|
|
1636 @vindex ediff-even-diff-face-A
|
|
|
1637 @vindex ediff-even-diff-face-B
|
|
|
1638 @vindex ediff-even-diff-face-C
|
|
|
1639 @vindex ediff-odd-diff-face-A
|
|
|
1640 @vindex ediff-odd-diff-face-B
|
|
|
1641 @vindex ediff-odd-diff-face-C
|
|
|
1642 Non-current difference regions are displayed using these alternating
|
|
|
1643 faces. The odd and the even faces are actually identical on monochrome
|
|
|
1644 displays, because without colors options are limited.
|
|
|
1645 So, Ediff uses italics to highlight non-current differences.
|
|
|
1646
|
|
|
1647 @item ediff-force-faces
|
|
|
1648 @vindex ediff-force-faces
|
|
|
1649 Ediff generally can detect when Emacs is running on a device where it can
|
|
|
1650 use highlighting with faces. However, if it fails to determine that faces
|
|
|
1651 can be used, the user can set this variable to @code{t} to make sure that
|
|
|
1652 Ediff uses faces to highlight differences.
|
|
|
1653
|
|
|
1654 @item ediff-highlight-all-diffs
|
|
|
1655 @vindex ediff-highlight-all-diffs
|
|
|
1656 Indicates whether---on a windowind display---Ediff should highlight
|
|
|
1657 differences using inserted strings (as on text-only terminals) or using
|
|
|
1658 colors and highlighting. Normally, Ediff highlights all differences, but
|
|
|
1659 the selected difference is highlighted more visibly. One can cycle through
|
|
|
1660 various modes of highlighting by typing @kbd{h}. By default, Ediff starts
|
|
|
1661 in the mode where all difference regions are highlighted. If you prefer to
|
|
|
1662 start in the mode where unselected differences are not highlighted, you
|
|
|
1663 should set @code{ediff-highlight-all-diffs} to @code{nil}. Type @kbd{h} to
|
|
|
1664 restore highlighting for all differences.
|
|
|
1665
|
|
|
1666 Ediff lets you switch between the two modes of highlighting. That is,
|
|
|
1667 you can switch interactively from highlighting using faces to
|
|
|
1668 highlighting using string flags, and back. Of course, switching has
|
|
|
1669 effect only under a windowing system. On a text-only terminal or in an
|
|
|
1670 xterm window, the only available option is highlighting with strings.
|
|
|
1671 @end table
|
|
|
1672
|
|
|
1673 @noindent
|
|
|
1674 If you want to change the default settings for @code{ediff-force-faces} and
|
|
|
1675 @code{ediff-highlight-all-diffs}, you must do it @strong{before} Ediff is
|
|
|
1676 loaded.
|
|
|
1677
|
|
|
1678 You can also change the defaults for the faces used to highlight the
|
|
|
1679 difference regions. There are two ways to do this. The simplest and the
|
|
|
1680 preferred way is to use the customization widget accessible from the
|
|
|
1681 menubar. Ediff's customization group is located under "Tools", which in
|
|
|
1682 turn is under "Programming". The faces that are used to highlight
|
|
|
1683 difference regions are located in the "Highlighting" subgroup of the Ediff
|
|
|
1684 customization group.
|
|
|
1685
|
|
|
1686 The second, much more arcane, method to change default faces is to include
|
|
|
1687 some Lisp code in @file{~/.emacs}. For instance,
|
|
|
1688
|
|
|
1689 @example
|
|
|
1690 (setq ediff-current-diff-face-A
|
|
|
1691 (copy-face 'bold-italic 'ediff-current-diff-face-A))
|
|
|
1692 @end example
|
|
|
1693
|
|
|
1694 @noindent
|
|
|
1695 would use the pre-defined fase @code{bold-italic} to highlight the current
|
|
|
1696 difference region in buffer A (this face is not a good choice, by the way).
|
|
|
1697
|
|
|
1698 If you are unhappy with just @emph{some} of the aspects of the default
|
|
|
1699 faces, you can modify them when Ediff is being loaded using
|
|
|
1700 @code{ediff-load-hook}. For instance:
|
|
|
1701
|
|
|
1702 @smallexample
|
|
|
1703 (add-hook 'ediff-load-hook
|
|
28344
|
1704 (lambda ()
|
|
|
1705 (set-face-foreground
|
|
|
1706 ediff-current-diff-face-B "blue")
|
|
|
1707 (set-face-background
|
|
|
1708 ediff-current-diff-face-B "red")
|
|
|
1709 (make-face-italic
|
|
|
1710 ediff-current-diff-face-B)))
|
|
25829
|
1711 @end smallexample
|
|
|
1712
|
|
26263
|
1713 @strong{Note:} To set Ediff's faces, use only @code{copy-face} or
|
|
|
1714 @code{set/make-face-@dots{}} as shown above. Emacs' low-level
|
|
|
1715 face-manipulation functions should be avoided.
|
|
25829
|
1716
|
|
|
1717 @node Narrowing, Refinement of Difference Regions, Highlighting Difference Regions, Customization
|
|
|
1718 @section Narrowing
|
|
|
1719
|
|
|
1720 If buffers being compared are narrowed at the time of invocation of
|
|
|
1721 Ediff, @code{ediff-buffers} will preserve the narrowing range. However,
|
|
|
1722 if @code{ediff-files} is invoked on the files visited by these buffers,
|
|
|
1723 that would widen the buffers, since this command is defined to compare the
|
|
|
1724 entire files.
|
|
|
1725
|
|
|
1726 Calling @code{ediff-regions-linewise} or @code{ediff-windows-linewise}, or
|
|
|
1727 the corresponding @samp{-wordwise} commands, narrows the variants to the
|
|
|
1728 particular regions being compared. The original accessible ranges are
|
|
|
1729 restored when you quit Ediff. During the command, you can toggle this
|
|
|
1730 narrowing on and off with the @kbd{%} command.
|
|
|
1731
|
|
|
1732 These two variables control this narrowing behavior:
|
|
|
1733
|
|
|
1734 @table @code
|
|
|
1735 @item ediff-start-narrowed
|
|
|
1736 @vindex ediff-start-narrowed
|
|
|
1737 If @code{t}, Ediff narrows the display to the appropriate range when it
|
|
|
1738 is invoked with an @samp{ediff-regions@dots{}} or
|
|
|
1739 @samp{ediff-windows@dots{}} command. If @code{nil}, these commands do
|
|
|
1740 not automatically narrow, but you can still toggle narrowing on and off
|
|
|
1741 by typing @kbd{%}.
|
|
|
1742
|
|
|
1743 @item ediff-quit-widened
|
|
|
1744 @vindex ediff-quit-widened
|
|
|
1745 Controls whether on quitting Ediff should restore the accessible range
|
|
|
1746 that existed before the current invocation.
|
|
|
1747 @end table
|
|
|
1748
|
|
|
1749 @node Refinement of Difference Regions, Patch and Diff Programs, Narrowing, Customization
|
|
|
1750 @section Refinement of Difference Regions
|
|
|
1751
|
|
|
1752 Ediff has variables to control the way fine differences are
|
|
|
1753 highlighted. This feature gives you control over the process of refinement.
|
|
|
1754 Note that refinement ignores spaces, tabs, and newlines.
|
|
|
1755
|
|
|
1756 @table @code
|
|
|
1757 @item ediff-auto-refine
|
|
|
1758 @vindex ediff-auto-refine
|
|
|
1759 This variable controls whether fine differences within regions are
|
|
|
1760 highlighted automatically (``auto-refining''). The default is yes
|
|
|
1761 (@samp{on}).
|
|
|
1762
|
|
|
1763 On a slow machine, automatic refinement may be painful. In that case,
|
|
|
1764 you can turn auto-refining on or off interactively by typing
|
|
|
1765 @kbd{@@}. You can also turn off display of refining that has
|
|
|
1766 already been done.
|
|
|
1767
|
|
|
1768 When auto-refining is off, fine differences are shown only for regions
|
|
|
1769 for which these differences have been computed and saved before. If
|
|
|
1770 auto-refining and display of refining are both turned off, fine
|
|
|
1771 differences are not shown at all.
|
|
|
1772
|
|
|
1773 Typing @kbd{*} computes and displays fine differences for the current
|
|
|
1774 difference region, regardless of whether auto-refining is turned on.
|
|
|
1775
|
|
|
1776 @item ediff-auto-refine-limit
|
|
|
1777 @vindex ediff-auto-refine-limit
|
|
|
1778 If auto-refining is on, this variable limits the size of the regions to
|
|
|
1779 be auto-refined. This guards against the possible slowdown that may be
|
|
|
1780 caused by extraordinary large difference regions.
|
|
|
1781
|
|
|
1782 You can always refine the current region by typing @kbd{*}.
|
|
|
1783
|
|
|
1784 @item ediff-forward-word-function
|
|
|
1785 @vindex ediff-forward-word-function
|
|
|
1786 This variable controls how fine differences are computed. The
|
|
|
1787 value must be a Lisp function that determines how the current difference
|
|
|
1788 region should be split into words.
|
|
|
1789
|
|
|
1790 @vindex ediff-diff-program
|
|
|
1791 @vindex ediff-forward-word-function
|
|
|
1792 @findex ediff-forward-word
|
|
|
1793 Fine differences are computed by first splitting the current difference
|
|
|
1794 region into words and then passing the result to
|
|
|
1795 @code{ediff-diff-program}. For the default forward word function (which is
|
|
|
1796 @code{ediff-forward-word}), a word is a string consisting of letters,
|
|
|
1797 @samp{-}, or @samp{_}; a string of punctuation symbols; a string of digits,
|
|
|
1798 or a string consisting of symbols that are neither space, nor a letter.
|
|
|
1799
|
|
|
1800 This default behavior is controlled by four variables: @code{ediff-word-1},
|
|
|
1801 ..., @code{ediff-word-4}. See the on-line documentation for these variables
|
|
|
1802 and for the function @code{ediff-forward-word} for an explanation of how to
|
|
|
1803 modify these variables.
|
|
|
1804 @vindex ediff-word-1
|
|
|
1805 @vindex ediff-word-2
|
|
|
1806 @vindex ediff-word-3
|
|
|
1807 @vindex ediff-word-4
|
|
|
1808 @end table
|
|
|
1809
|
|
|
1810 Sometimes, when a region has too many differences between the variants,
|
|
|
1811 highlighting of fine differences is inconvenient, especially on
|
|
|
1812 color displays. If that is the case, type @kbd{*} with a negative
|
|
|
1813 prefix argument. This unhighlights fine differences for the current
|
|
|
1814 region.
|
|
|
1815
|
|
|
1816 To unhighlight fine differences in all difference regions, use the
|
|
|
1817 command @kbd{@@}. Repeated typing of this key cycles through three
|
|
|
1818 different states: auto-refining, no-auto-refining, and no-highlighting
|
|
|
1819 of fine differences.
|
|
|
1820
|
|
|
1821 @node Patch and Diff Programs, Merging and diff3, Refinement of Difference Regions, Customization
|
|
|
1822 @section Patch and Diff Programs
|
|
|
1823
|
|
|
1824 This section describes variables that specify the programs to be used for
|
|
|
1825 applying patches and for computing the main difference regions (not the
|
|
|
1826 fine difference regions):
|
|
|
1827
|
|
|
1828 @table @code
|
|
|
1829 @item ediff-diff-program
|
|
|
1830 @itemx ediff-diff3-program
|
|
|
1831 @vindex ediff-patch-program
|
|
|
1832 @vindex ediff-diff-program
|
|
|
1833 @vindex ediff-diff3-program
|
|
|
1834 These variables specify the programs to use to produce differences
|
|
|
1835 and do patching.
|
|
|
1836
|
|
|
1837 @item ediff-diff-options
|
|
|
1838 @itemx ediff-diff3-options
|
|
|
1839 @vindex ediff-patch-options
|
|
|
1840 @vindex ediff-diff-options
|
|
|
1841 @vindex ediff-diff3-options
|
|
|
1842 These variables specify the options to pass to the above utilities.
|
|
|
1843
|
|
|
1844 In @code{ediff-diff-options}, it may be useful to specify options
|
|
|
1845 such as @samp{-w} that ignore certain kinds of changes. However,
|
|
|
1846 Ediff does not let you use the option @samp{-c}, as it doesn't recognize this
|
|
|
1847 format yet.
|
|
|
1848
|
|
36043
|
1849 @item ediff-coding-system-for-read
|
|
|
1850 @vindex ediff-coding-system-for-read
|
|
|
1851 This variable specifies the coding system to use when reading the output
|
|
|
1852 that the programs @code{diff3} and @code{diff} send to Emacs. The default
|
|
42288
|
1853 is @code{raw-text}, and this should work fine in Unix and in most
|
|
|
1854 cases under Windows NT/95/98/2000. There are @code{diff} programs
|
|
36043
|
1855 for which the default option doesn't work under Windows. In such cases,
|
|
|
1856 @code{raw-text-dos} might work. If not, you will have to experiment with
|
|
|
1857 other coding systems or use GNU diff.
|
|
|
1858
|
|
25829
|
1859 @item ediff-patch-program
|
|
|
1860 The program to use to apply patches. Since there are certain
|
|
|
1861 incompatibilities between the different versions of the patch program, the
|
|
|
1862 best way to stay out of trouble is to use a GNU-compatible version.
|
|
|
1863 Otherwise, you may have to tune the values of the variables
|
|
|
1864 @code{ediff-patch-options}, @code{ediff-backup-specs}, and
|
|
|
1865 @code{ediff-backup-extension} as described below.
|
|
|
1866 @item ediff-patch-options
|
|
|
1867 Options to pass to @code{ediff-patch-program}.
|
|
|
1868
|
|
|
1869 Note: the `-b' and `-z' options should be specified in
|
|
|
1870 `ediff-backup-specs', not in @code{ediff-patch-options}.
|
|
|
1871
|
|
|
1872 It is recommended to pass the `-f' option to the patch program, so it won't
|
|
|
1873 ask questions. However, some implementations don't accept this option, in
|
|
|
1874 which case the default value of this variable should be changed.
|
|
|
1875
|
|
|
1876 @item ediff-backup-extension
|
|
|
1877 Backup extension used by the patch program. Must be specified, even if
|
|
|
1878 @code{ediff-backup-specs} is given.
|
|
|
1879 @item ediff-backup-specs
|
|
|
1880 Backup directives to pass to the patch program.
|
|
|
1881 Ediff requires that the old version of the file (before applying the patch)
|
|
|
1882 is saved in a file named @file{the-patch-file.extension}. Usually
|
|
|
1883 `extension' is `.orig', but this can be changed by the user, and may also be
|
|
|
1884 system-dependent. Therefore, Ediff needs to know the backup extension used
|
|
|
1885 by the patch program.
|
|
|
1886
|
|
|
1887 Some versions of the patch program let the user specify `-b backup-extension'.
|
|
|
1888 Other versions only permit `-b', which (usually) assumes the extension `.orig'.
|
|
|
1889 Yet others force you to use `-z<backup-extension>'.
|
|
|
1890
|
|
|
1891 Note that both `ediff-backup-extension' and `ediff-backup-specs' must be
|
|
|
1892 properly set. If your patch program takes the option `-b', but not
|
|
|
1893 `-b extension', the variable `ediff-backup-extension' must still
|
|
|
1894 be set so Ediff will know which extension to use.
|
|
|
1895
|
|
|
1896 @item ediff-custom-diff-program
|
|
|
1897 @itemx ediff-custom-diff-options
|
|
|
1898 @vindex ediff-custom-diff-program
|
|
|
1899 @vindex ediff-custom-diff-options
|
|
|
1900 @findex ediff-save-buffer
|
|
|
1901 Because Ediff limits the options you may want to pass to the @code{diff}
|
|
|
1902 program, it partially makes up for this drawback by letting you save the
|
|
|
1903 output from @code{diff} in your preferred format, which is specified via
|
|
|
1904 the above two variables.
|
|
|
1905
|
|
|
1906 The output generated by @code{ediff-custom-diff-program} (which doesn't
|
|
33021
|
1907 even have to be a standard-style @code{diff}!)@: is not used by Ediff. It is
|
|
25829
|
1908 provided exclusively so that you can
|
|
|
1909 refer to
|
|
|
1910 it later, send it over email, etc. For instance, after reviewing the
|
|
|
1911 differences, you may want to send context differences to a colleague.
|
|
|
1912 Since Ediff ignores the @samp{-c} option in
|
|
|
1913 @code{ediff-diff-program}, you would have to run @code{diff -c} separately
|
|
|
1914 just to produce the list of differences. Fortunately,
|
|
|
1915 @code{ediff-custom-diff-program} and @code{ediff-custom-diff-options}
|
|
|
1916 eliminate this nuisance by keeping a copy of a difference list in the
|
|
|
1917 desired format in a buffer that can be displayed via the command @kbd{D}.
|
|
|
1918
|
|
|
1919 @item ediff-patch-default-directory
|
|
|
1920 @vindex ediff-patch-default-directory
|
|
|
1921 Specifies the default directory to look for patches.
|
|
|
1922
|
|
|
1923 @end table
|
|
|
1924
|
|
|
1925 @noindent
|
|
|
1926 @strong{Warning:} Ediff does not support the output format of VMS
|
|
|
1927 @code{diff}. Instead, make sure you are using some implementation of POSIX
|
|
|
1928 @code{diff}, such as @code{gnudiff}.
|
|
|
1929
|
|
|
1930 @node Merging and diff3, Support for Version Control, Patch and Diff Programs, Customization
|
|
|
1931 @section Merging and diff3
|
|
|
1932
|
|
|
1933 Ediff supports three-way comparison via the functions @code{ediff-files3} and
|
|
|
1934 @code{ediff-buffers3}. The interface is the same as for two-way comparison.
|
|
|
1935 In three-way comparison and merging, Ediff reports if any two difference
|
|
|
1936 regions are identical. For instance, if the current region in buffer A
|
|
|
1937 is the same as the region in buffer C, then the mode line of buffer A will
|
|
|
1938 display @samp{[=diff(C)]} and the mode line of buffer C will display
|
|
|
1939 @samp{[=diff(A)]}.
|
|
|
1940
|
|
|
1941 Merging is done according to the following algorithm.
|
|
|
1942
|
|
|
1943 If a difference region in one of the buffers, say B, differs from the ancestor
|
|
|
1944 file while the region in the other buffer, A, doesn't, then the merge buffer,
|
|
|
1945 C, gets B's region. Similarly when buffer A's region differs from
|
|
|
1946 the ancestor and B's doesn't, A's region is used.
|
|
|
1947
|
|
|
1948 @vindex ediff-default-variant
|
|
|
1949 If both regions in buffers A and B differ from the ancestor file, Ediff
|
|
|
1950 chooses the region according to the value of the variable
|
|
|
1951 @code{ediff-default-variant}. If its value is @code{default-A} then A's
|
|
|
1952 region is chosen. If it is @code{default-B} then B's region is chosen.
|
|
|
1953 If it is @code{combined} then the region in buffer C will look like
|
|
|
1954 this:
|
|
|
1955
|
|
26639
|
1956 @comment Use @set to avoid triggering merge conflict detectors like CVS.
|
|
|
1957 @set seven-left <<<<<<<
|
|
|
1958 @set seven-right >>>>>>>
|
|
25829
|
1959 @example
|
|
26639
|
1960 @value{seven-left} variant A
|
|
26589
|
1961 the difference region from buffer A
|
|
26639
|
1962 @value{seven-right} variant B
|
|
26589
|
1963 the difference region from buffer B
|
|
|
1964 ####### Ancestor
|
|
|
1965 the difference region from the ancestor buffer, if available
|
|
|
1966 ======= end
|
|
25829
|
1967 @end example
|
|
|
1968
|
|
26589
|
1969 The above is the default template for the combined region. The user can
|
|
|
1970 customize this template using the variable
|
|
|
1971 @code{ediff-combination-pattern}.
|
|
|
1972
|
|
25829
|
1973 @vindex ediff-combination-pattern
|
|
26589
|
1974 The variable @code{ediff-combination-pattern} specifies the template that
|
|
|
1975 determines how the combined merged region looks like. The template is
|
|
|
1976 represented as a list of the form @code{(STRING1 Symbol1 STRING2 Symbol2
|
|
|
1977 STRING3 Symbol3 STRING4)}. The symbols here must be atoms of the form
|
|
|
1978 @code{A}, @code{B}, or @code{Ancestor}. They determine the order in which
|
|
|
1979 the corresponding difference regions (from buffers A, B, and the ancestor
|
|
|
1980 buffer) are displayed in the merged region of buffer C. The strings in the
|
|
|
1981 template determine the text that separates the aforesaid regions. The
|
|
|
1982 default template is
|
|
|
1983
|
|
37797
|
1984 @smallexample
|
|
|
1985 ("@value{seven-left} variant A" A "@value{seven-right} variant B" B
|
|
|
1986 "####### Ancestor" Ancestor "======= end")
|
|
|
1987 @end smallexample
|
|
26589
|
1988
|
|
37797
|
1989 @noindent
|
|
|
1990 (this is one long line) and the corresponding combined region is shown
|
|
|
1991 above. The order in which the regions are shown (and the separator
|
|
|
1992 strings) can be changed by changing the above template. It is even
|
|
|
1993 possible to add or delete region specifiers in this template (although
|
|
|
1994 the only possibly useful such modification seems to be the deletion of
|
|
|
1995 the ancestor).
|
|
25829
|
1996
|
|
|
1997 In addition to the state of the difference, Ediff displays the state of the
|
|
|
1998 merge for each region. If a difference came from buffer A by default
|
|
|
1999 (because both regions A and B were different from the ancestor and
|
|
|
2000 @code{ediff-default-variant} was set to @code{default-A}) then
|
|
|
2001 @samp{[=diff(A) default-A]} is displayed in the mode line. If the
|
|
|
2002 difference in buffer C came, say, from buffer B because the difference
|
|
|
2003 region in that buffer differs from the ancestor, but the region in buffer A
|
|
|
2004 does not (if merging with an ancestor) then @samp{[=diff(B) prefer-B]} is
|
|
|
2005 displayed. The indicators default-A/B and prefer-A/B are inspired by
|
|
|
2006 Emerge and have the same meaning.
|
|
|
2007
|
|
|
2008 Another indicator of the state of merge is @samp{combined}. It appears
|
|
|
2009 with any difference region in buffer C that was obtained by combining
|
|
|
2010 the difference regions in buffers A and B as explained above.
|
|
|
2011
|
|
|
2012 In addition to the state of merge and state of difference indicators, while
|
|
|
2013 merging with an ancestor file or buffer, Ediff informs the user when the
|
|
|
2014 current difference region in the (normally invisible) ancestor buffer is
|
|
|
2015 empty via the @emph{AncestorEmpty} indicator. This helps determine if the
|
|
|
2016 changes made to the original in variants A and B represent pure insertion
|
|
|
2017 or deletion of text: if the mode line shows @emph{AncestorEmpty} and the
|
|
|
2018 corresponding region in buffers A or B is not empty, this means that new
|
|
|
2019 text was inserted. If this indicator is not present and the difference
|
|
|
2020 regions in buffers A or B are non-empty, this means that text was
|
|
|
2021 modified. Otherwise, the original text was deleted.
|
|
|
2022
|
|
|
2023 Although the ancestor buffer is normally invisible, Ediff maintains
|
|
|
2024 difference regions there and advances the current difference region
|
|
|
2025 accordingly. All highlighting of difference regions is provided in the
|
|
|
2026 ancestor buffer, except for the fine differences. Therefore, if desired, the
|
|
|
2027 user can put the ancestor buffer in a separate frame and watch it
|
|
|
2028 there. However, on a TTY, only one frame can be visible at any given time,
|
|
|
2029 and Ediff doesn't support any single-frame window configuration where all
|
|
|
2030 buffers, including the ancestor buffer, would be visible. However, the
|
|
|
2031 ancestor buffer can be displayed by typing @kbd{/} to the control
|
|
|
2032 window. (Type @kbd{C-l} to hide it again.)
|
|
|
2033
|
|
|
2034 Note that the state-of-difference indicators @samp{=diff(A)} and
|
|
|
2035 @samp{=diff(B)} above are not redundant, even in the presence of a
|
|
|
2036 state-of-merge indicator. In fact, the two serve different purposes.
|
|
|
2037
|
|
|
2038 For instance, if the mode line displays @samp{=diff(B) prefer(B)} and
|
|
|
2039 you copy a difference region from buffer A to buffer C then
|
|
|
2040 @samp{=diff(B)} will change to @samp{diff-A} and the mode line will
|
|
|
2041 display @samp{=diff(A) prefer-B}. This indicates that the difference
|
|
|
2042 region in buffer C is identical to that in buffer A, but originally
|
|
|
2043 buffer C's region came from buffer B. This is useful to know because
|
|
|
2044 you can recover the original difference region in buffer C by typing
|
|
|
2045 @kbd{r}.
|
|
|
2046
|
|
|
2047
|
|
|
2048 Ediff never changes the state-of-merge indicator, except in response to
|
|
|
2049 the @kbd{!} command (see below), in which case the indicator is lost.
|
|
|
2050 On the other hand, the state-of-difference indicator is changed
|
|
|
2051 automatically by the copying/recovery commands, @kbd{a}, @kbd{b}, @kbd{r},
|
|
|
2052 @kbd{+}.
|
|
|
2053
|
|
|
2054 The @kbd{!} command loses the information about origins of the regions
|
|
|
2055 in the merge buffer (default-A, prefer-B, or combined). This is because
|
|
|
2056 recomputing differences in this case means running @code{diff3} on
|
|
|
2057 buffers A, B, and the merge buffer, not on the ancestor buffer. (It
|
|
|
2058 makes no sense to recompute differences using the ancestor file, since
|
|
|
2059 in the merging mode Ediff assumes that you have not edited buffers A and
|
|
|
2060 B, but that you may have edited buffer C, and these changes are to be
|
|
|
2061 preserved.) Since some difference regions may disappear as a result of
|
|
|
2062 editing buffer C and others may arise, there is generally no simple way
|
|
|
2063 to tell where the various regions in the merge buffer came from.
|
|
|
2064
|
|
|
2065 In three-way comparison, Ediff tries to disregard regions that consist
|
|
|
2066 entirely of white space. For instance, if, say, the current region in
|
|
|
2067 buffer A consists of the white space only (or if it is empty), Ediff will
|
|
|
2068 not take it into account for the purpose of computing fine differences. The
|
|
|
2069 result is that Ediff can provide a better visual information regarding the
|
|
|
2070 actual fine differences in the non-white regions in buffers B and
|
|
|
2071 C. Moreover, if the regions in buffers B and C differ in the white space
|
|
|
2072 only, then a message to this effect will be displayed.
|
|
|
2073
|
|
|
2074 @vindex ediff-merge-window-share
|
|
|
2075 In the merge mode, the share of the split between window C (the window
|
|
|
2076 displaying the merge-buffer) and the windows displaying buffers A and B
|
|
|
2077 is controlled by the variable @code{ediff-merge-window-share}. Its
|
|
|
2078 default value is 0.5. To make the merge-buffer window smaller, reduce
|
|
|
2079 this amount.
|
|
|
2080
|
|
|
2081 We don't recommend increasing the size of the merge-window to more than
|
|
|
2082 half the frame (i.e., to increase the value of
|
|
|
2083 @code{ediff-merge-window-share}) to more than 0.5, since it would be
|
|
|
2084 hard to see the contents of buffers A and B.
|
|
|
2085
|
|
|
2086 You can temporarily shrink the merge window to just one line by
|
|
|
2087 typing @kbd{s}. This change is temporary, until Ediff finds a reason to
|
|
|
2088 redraw the screen. Typing @kbd{s} again restores the original window size.
|
|
|
2089
|
|
|
2090 With a positive prefix argument, the @kbd{s} command will make the merge
|
|
|
2091 window slightly taller. This change is persistent. With `@kbd{-}' or
|
|
|
2092 with a negative prefix argument, the command @kbd{s} makes the merge
|
|
|
2093 window slightly shorter. This change also persistent.
|
|
|
2094
|
|
|
2095 @vindex ediff-show-clashes-only
|
|
|
2096 Ediff lets you automatically ignore the regions where only one of the
|
|
|
2097 buffers A and B disagrees with the ancestor. To do this, set the
|
|
|
2098 variable @code{ediff-show-clashes-only} to non-@code{nil}.
|
|
|
2099
|
|
26263
|
2100 You can toggle this feature interactively by typing @kbd{$$}.
|
|
25829
|
2101
|
|
|
2102 Note that this variable affects only the show next/previous difference
|
|
|
2103 commands. You can still jump directly to any difference region directly
|
|
|
2104 using the command @kbd{j} (with a prefix argument specifying the difference
|
|
|
2105 number).
|
|
|
2106
|
|
|
2107 @vindex ediff-autostore-merges
|
|
|
2108 @vindex ediff-quit-merge-hook
|
|
|
2109 @findex ediff-maybe-save-and-delete-merge
|
|
|
2110 The variable @code{ediff-autostore-merges} controls what happens to the
|
|
|
2111 merge buffer when Ediff quits. If the value is @code{nil}, nothing is done
|
|
|
2112 to the merge buffer---it will be the user's responsibility to save it.
|
|
|
2113 If the value is @code{t}, the user will be asked where to save the buffer
|
|
|
2114 and whether to delete it afterwards. It the value is neither @code{nil} nor
|
|
|
2115 @code{t}, the merge buffer is saved @emph{only} if this merge session was
|
|
|
2116 invoked from a group of related Ediff session, such as those that result
|
|
|
2117 from @code{ediff-merge-directories},
|
|
|
2118 @code{ediff-merge-directory-revisions}, etc.
|
|
|
2119 @xref{Session Groups}. This behavior is implemented in the function
|
|
|
2120 @code{ediff-maybe-save-and-delete-merge}, which is a hook in
|
|
|
2121 @code{ediff-quit-merge-hook}. The user can supply a different hook, if
|
|
|
2122 necessary.
|
|
|
2123
|
|
|
2124 The variable @code{ediff-autostore-merges} is buffer-local, so it can be
|
|
|
2125 set in a per-buffer manner. Therefore, use @code{setq-default} to globally
|
|
|
2126 change this variable.
|
|
|
2127
|
|
29165
|
2128 @vindex ediff-merge-filename-prefix
|
|
|
2129 When merge buffers are saved automatically as directed by
|
|
|
2130 @code{ediff-autostore-merges}, Ediff attaches a prefix to each file, as
|
|
|
2131 specified by the variable @code{ediff-merge-filename-prefix}. The default
|
|
|
2132 is @code{merge_}, but this can be changed by the user.
|
|
|
2133
|
|
25829
|
2134 @node Support for Version Control, Customizing the Mode Line, Merging and diff3, Customization
|
|
|
2135 @section Support for Version Control
|
|
|
2136
|
|
|
2137
|
|
|
2138 Ediff supports version control and lets you compare versions of files
|
|
|
2139 visited by Emacs buffers via the function @code{ediff-revision}. This
|
|
|
2140 feature is controlled by the following variables:
|
|
|
2141
|
|
|
2142 @table @code
|
|
|
2143 @item ediff-version-control-package
|
|
|
2144 @vindex ediff-version-control-package
|
|
|
2145 A symbol. The default is @samp{vc}.
|
|
|
2146
|
|
|
2147 If you are like most Emacs users, Ediff will use VC as the version control
|
|
|
2148 package. This is the standard Emacs interface to RCS, CVS, and SCCS.
|
|
|
2149
|
|
|
2150 However, if your needs are better served by other interfaces, you will
|
|
|
2151 have to tell Ediff which version control package you are using, e.g.,
|
|
|
2152 @example
|
|
|
2153 (setq ediff-version-control-package 'rcs)
|
|
|
2154 @end example
|
|
|
2155
|
|
|
2156 Apart from the standard @file{vc.el}, Ediff supports three other interfaces
|
|
33019
|
2157 to version control: @file{rcs.el}, @file{pcl-cvs.el} (recently renamed
|
|
|
2158 pcvs.el), and @file{generic-sc.el}. The package @file{rcs.el} is written
|
|
|
2159 by Sebastian Kremer <sk@@thp.Uni-Koeln.DE> and is available as
|
|
25829
|
2160 @example
|
|
|
2161 @file{ftp.cs.buffalo.edu:pub/Emacs/rcs.tar.Z}
|
|
|
2162 @file{ftp.uni-koeln.de:/pub/gnu/emacs/rcs.tar.Z}
|
|
|
2163 @end example
|
|
|
2164 @pindex @file{vc.el}
|
|
|
2165 @pindex @file{rcs.el}
|
|
|
2166 @pindex @file{pcl-cvs.el}
|
|
|
2167 @pindex @file{generic-sc.el}
|
|
|
2168 @end table
|
|
|
2169
|
|
|
2170 Ediff's interface to the above packages allows the user to compare the
|
|
|
2171 versions of the current buffer or to merge them (with or without an
|
|
|
2172 ancestor-version). These operations can also be performed on directories
|
|
|
2173 containing files under version control.
|
|
|
2174
|
|
|
2175 In case of @file{pcl-cvs.el}, Ediff can also be invoked via the function
|
|
|
2176 @code{run-ediff-from-cvs-buffer}---see the documentation string for this
|
|
|
2177 function.
|
|
|
2178
|
|
|
2179 @node Customizing the Mode Line, Miscellaneous, Support for Version Control, Customization
|
|
|
2180 @section Customizing the Mode Line
|
|
|
2181
|
|
|
2182 When Ediff is running, the mode line of @samp{Ediff Control Panel}
|
|
|
2183 buffer shows the current difference number and the total number of
|
|
|
2184 difference regions in the two files.
|
|
|
2185
|
|
|
2186 The mode line of the buffers being compared displays the type of the
|
|
|
2187 buffer (@samp{A:}, @samp{B:}, or @samp{C:}) and (usually) the file name.
|
|
|
2188 Ediff tries to be intelligent in choosing the mode line buffer
|
|
|
2189 identification. In particular, it works well with the
|
|
|
2190 @file{uniquify.el} and @file{mode-line.el} packages (which improve on
|
|
|
2191 the default way in which Emacs displays buffer identification). If you
|
|
|
2192 don't like the way Ediff changes the mode line, you can use
|
|
|
2193 @code{ediff-prepare-buffer-hook} to modify the mode line.
|
|
|
2194 @vindex ediff-prepare-buffer-hook
|
|
|
2195 @pindex @file{uniquify.el}
|
|
|
2196 @pindex @file{mode-line.el}
|
|
|
2197
|
|
|
2198 @node Miscellaneous, Notes on Heavy-duty Customization, Customizing the Mode Line, Customization
|
|
|
2199 @section Miscellaneous
|
|
|
2200
|
|
|
2201 Here are a few other variables for customizing Ediff:
|
|
|
2202
|
|
|
2203 @table @code
|
|
|
2204 @item ediff-split-window-function
|
|
|
2205 @vindex ediff-split-window-function
|
|
|
2206 Controls the way you want the window be split between file-A and file-B
|
|
|
2207 (and file-C, if applicable). It defaults to the vertical split
|
|
|
2208 (@code{split-window-vertically}, but you can set it to
|
|
|
2209 @code{split-window-horizontally}, if you so wish.
|
|
|
2210 Ediff also lets you switch from vertical to horizontal split and back
|
|
|
2211 interactively.
|
|
|
2212
|
|
|
2213 Note that if Ediff detects that all the buffers it compares are displayed in
|
|
|
2214 separate frames, it assumes that the user wants them to be so displayed
|
|
|
2215 and stops splitting windows. Instead, it arranges for each buffer to
|
|
|
2216 be displayed in a separate frame. You can switch to the one-frame mode
|
|
|
2217 by hiding one of the buffers A/B/C.
|
|
|
2218
|
|
|
2219 You can also swap the windows where buffers are displayed by typing
|
|
|
2220 @kbd{~}.
|
|
|
2221
|
|
|
2222 @item ediff-merge-split-window-function
|
|
|
2223 @vindex ediff-merge-split-window-function
|
|
|
2224 Controls how windows are
|
|
|
2225 split between buffers A and B in the merge mode.
|
|
|
2226 This variable is like @code{ediff-split-window-function}, but it defaults
|
|
|
2227 to @code{split-window-horizontally} instead of
|
|
|
2228 @code{split-window-vertically}.
|
|
|
2229
|
|
|
2230 @item ediff-make-wide-display-function
|
|
|
2231 @vindex ediff-make-wide-display-function
|
|
|
2232 The value is a function to be called to widen the frame for displaying
|
|
|
2233 the Ediff buffers. See the on-line documentation for
|
|
|
2234 @code{ediff-make-wide-display-function} for details. It is also
|
|
|
2235 recommended to look into the source of the default function
|
|
|
2236 @code{ediff-make-wide-display}.
|
|
|
2237
|
|
|
2238 You can toggle wide/regular display by typing @kbd{m}. In the wide
|
|
|
2239 display mode, buffers A, B (and C, when applicable) are displayed in a
|
|
|
2240 single frame that is as wide as the entire workstation screen. This is
|
|
|
2241 useful when files are compared side-by-side. By default, the display is
|
|
|
2242 widened without changing its height.
|
|
|
2243
|
|
|
2244 @item ediff-use-last-dir
|
|
|
2245 @vindex ediff-use-last-dir
|
|
|
2246 Controls the way Ediff presents the
|
|
|
2247 default directory when it prompts the user for files to compare. If
|
|
|
2248 @code{nil},
|
|
|
2249 Ediff uses the default directory of the current buffer when it
|
|
|
2250 prompts the user for file names. Otherwise, it will use the
|
|
|
2251 directories it had previously used for files A, B, or C, respectively.
|
|
|
2252
|
|
|
2253 @item ediff-no-emacs-help-in-control-buffer
|
|
|
2254 @vindex ediff-no-emacs-help-in-control-buffer
|
|
|
2255 If @code{t}, makes @kbd{C-h}
|
|
|
2256 behave like the @key{DEL} key, i.e., it will move you back to the previous
|
|
|
2257 difference rather than invoking help. This is useful when, in an xterm
|
|
|
2258 window or a text-only terminal, the Backspace key is bound to @kbd{C-h} and is
|
|
|
2259 positioned more conveniently than the @key{DEL} key.
|
|
|
2260
|
|
|
2261 @item ediff-toggle-read-only-function
|
|
|
2262 @vindex ediff-toggle-read-only-function
|
|
|
2263 This variable's value is a function that Ediff uses to toggle
|
|
|
2264 the read-only property in its buffers.
|
|
|
2265
|
|
|
2266 The default function that Ediff uses simply toggles the read-only property,
|
|
|
2267 unless the file is under version control. For a checked-in file under
|
|
|
2268 version control, Ediff first tries to check the file out.
|
|
|
2269
|
|
|
2270 @item ediff-make-buffers-readonly-at-startup nil
|
|
|
2271 @vindex ediff-make-buffers-readonly-at-startup
|
|
|
2272 If t, all variant buffers are made read-only at Ediff startup.
|
|
|
2273
|
|
|
2274 @item ediff-keep-variants
|
|
|
2275 @vindex @code{ediff-keep-variants}
|
|
|
2276 The default is @code{t}, meaning that the buffers being compared or merged will
|
|
|
2277 be preserved when Ediff quits. Setting this to @code{nil} causes Ediff to
|
|
|
2278 offer the user a chance to delete these buffers (if they are not modified).
|
|
|
2279 Supplying a prefix argument to the quit command (@code{q}) temporarily
|
|
|
2280 reverses the meaning of this variable. This is convenient when the user
|
|
|
2281 prefers one of the behaviors most of the time, but occasionally needs the
|
|
|
2282 other behavior.
|
|
|
2283
|
|
|
2284 However, Ediff temporarily resets this variable to @code{t} if it is
|
|
|
2285 invoked via one of the "buffer" jobs, such as @code{ediff-buffers}.
|
|
|
2286 This is because it is all too easy to loose day's work otherwise.
|
|
|
2287 Besides, in a "buffer" job, the variant buffers have already been loaded
|
|
|
2288 prior to starting Ediff, so Ediff just preserves status quo here.
|
|
|
2289
|
|
|
2290 Using @code{ediff-cleanup-hook}, one can make Ediff delete the variants
|
|
|
2291 unconditionally (e.g., by making @code{ediff-janitor} into one of these hooks).
|
|
|
2292 @item ediff-grab-mouse
|
|
|
2293 @vindex @code{ediff-grab-mouse}
|
|
|
2294 Default is @code{t}. Normally, Ediff grabs mouse and puts it in its
|
|
|
2295 control frame. This is useful since the user can be sure that when he
|
|
|
2296 needs to type an Ediff command the focus will be in an appropriate Ediff's
|
|
|
2297 frame. However, some users prefer to move the mouse by themselves. The
|
|
|
2298 above variable, if set to @code{maybe}, will prevent Ediff from grabbing
|
|
|
2299 the mouse in many situations, usually after commands that may take more
|
|
|
2300 time than usual. In other situation, Ediff will continue grabbing the mouse
|
|
|
2301 and putting it where it believes is appropriate. If the value is
|
|
|
2302 @code{nil}, then mouse is entirely user's responsibility.
|
|
|
2303 Try different settings and see which one is for you.
|
|
|
2304 @end table
|
|
|
2305
|
|
|
2306
|
|
|
2307 @node Notes on Heavy-duty Customization, , Miscellaneous, Customization
|
|
|
2308 @section Notes on Heavy-duty Customization
|
|
|
2309
|
|
|
2310 Some users need to customize Ediff in rather sophisticated ways, which
|
|
|
2311 requires different defaults for different kinds of files (e.g., SGML,
|
|
|
2312 etc.). Ediff supports this kind of customization in several ways. First,
|
|
|
2313 most customization variables are buffer-local. Those that aren't are
|
|
|
2314 usually accessible from within Ediff Control Panel, so one can make them
|
|
|
2315 local to the panel by calling make-local-variable from within
|
|
|
2316 @code{ediff-startup-hook}.
|
|
|
2317
|
|
|
2318 Second, the function @code{ediff-setup} accepts an optional sixth
|
|
|
2319 argument which has the form @code{((@var{var-name-1} .@: @var{val-1})
|
|
|
2320 (@var{var-name-2} .@: @var{val-2}) @dots{})}. The function
|
|
|
2321 @code{ediff-setup} sets the variables in the list to the respective
|
|
|
2322 values, locally in the Ediff control buffer. This is an easy way to
|
|
|
2323 throw in custom variables (which usually should be buffer-local) that
|
|
|
2324 can then be tested in various hooks.
|
|
|
2325
|
|
|
2326 Make sure the variable @code{ediff-job-name} and @code{ediff-word-mode} are set
|
|
|
2327 properly in this case, as some things in Ediff depend on this.
|
|
|
2328
|
|
|
2329 Finally, if you want custom-tailored help messages, you can set the
|
|
|
2330 variables @code{ediff-brief-help-message-function} and
|
|
|
2331 @code{ediff-long-help-message-function}
|
|
|
2332 to functions that return help strings.
|
|
|
2333 @vindex ediff-startup-hook
|
|
|
2334 @findex ediff-setup
|
|
|
2335 @vindex ediff-job-name
|
|
|
2336 @vindex ediff-word-mode
|
|
|
2337 @vindex ediff-brief-help-message-function
|
|
|
2338 @vindex ediff-long-help-message-function
|
|
|
2339
|
|
|
2340 When customizing Ediff, some other variables are useful, although they are
|
|
|
2341 not user-definable. They are local to the Ediff control buffer, so this
|
|
|
2342 buffer must be current when you access these variables. The control buffer
|
|
|
2343 is accessible via the variable @code{ediff-control-buffer}, which is also
|
|
|
2344 local to that buffer. It is usually used for checking if the current buffer
|
|
|
2345 is also the control buffer.
|
|
|
2346
|
|
|
2347 Other variables of interest are:
|
|
|
2348 @table @code
|
|
|
2349 @item ediff-buffer-A
|
|
|
2350 The first of the data buffers being compared.
|
|
|
2351
|
|
|
2352 @item ediff-buffer-B
|
|
|
2353 The second of the data buffers being compared.
|
|
|
2354
|
|
|
2355 @item ediff-buffer-C
|
|
|
2356 In three-way comparisons, this is the third buffer being compared.
|
|
|
2357 In merging, this is the merge buffer.
|
|
|
2358 In two-way comparison, this variable is nil.
|
|
|
2359
|
|
|
2360 @item ediff-window-A
|
|
|
2361 The window displaying buffer A. If buffer A is not visible, this variable
|
|
|
2362 is nil or it may be a dead window.
|
|
|
2363
|
|
|
2364 @item ediff-window-B
|
|
|
2365 The window displaying buffer B.
|
|
|
2366
|
|
|
2367 @item ediff-window-C
|
|
|
2368 The window displaying buffer C, if any.
|
|
|
2369
|
|
|
2370 @item ediff-control-frame
|
|
|
2371 A dedicated frame displaying the control buffer, if it exists.
|
|
|
2372 It is non-nil only if Ediff uses the multiframe display, i.e., when the
|
|
|
2373 control buffer is in its own frame.
|
|
|
2374 @end table
|
|
|
2375
|
|
|
2376 @node Credits, Index, Customization, Top
|
|
|
2377 @chapter Credits
|
|
|
2378
|
|
42602
|
2379 Ediff was written by Michael Kifer <kifer@@cs.stonybrook.edu>. It was inspired
|
|
25829
|
2380 by emerge.el written by Dale R.@: Worley <drw@@math.mit.edu>. An idea due to
|
|
|
2381 Boris Goldowsky <boris@@cs.rochester.edu> made it possible to highlight
|
|
|
2382 fine differences in Ediff buffers. Alastair Burt <burt@@dfki.uni-kl.de>
|
|
|
2383 ported Ediff to XEmacs, Eric Freudenthal <freudent@@jan.ultra.nyu.edu>
|
|
|
2384 made it work with VC, Marc Paquette <marcpa@@cam.org> wrote the
|
|
26639
|
2385 toolbar support package for Ediff, and Hrvoje Niksic <hniksic@@xemacs.org>
|
|
25829
|
2386 adapted it to the Emacs customization package.
|
|
|
2387
|
|
|
2388 Many people provided help with bug reports, patches, and advice.
|
|
|
2389 Without them, Ediff would not be nearly as useful as it is today.
|
|
|
2390 Here is a full list of contributors (I hope I didn't miss anyone):
|
|
|
2391
|
|
|
2392 @example
|
|
26263
|
2393 Adrian Aichner (aichner@@ecf.teradyne.com),
|
|
25829
|
2394 Steve Baur (steve@@xemacs.org),
|
|
|
2395 Neal Becker (neal@@ctd.comsat.com),
|
|
|
2396 E.@: Jay Berkenbilt (ejb@@ql.org),
|
|
|
2397 Alastair Burt (burt@@dfki.uni-kl.de),
|
|
|
2398 Paul Bibilo (peb@@delcam.co.uk),
|
|
|
2399 Kevin Broadey (KevinB@@bartley.demon.co.uk),
|
|
|
2400 Harald Boegeholz (hwb@@machnix.mathematik.uni-stuttgart.de),
|
|
|
2401 Bradley A.@: Bosch (brad@@lachman.com),
|
|
|
2402 Michael D.@: Carney (carney@@ltx-tr.com),
|
|
|
2403 Jin S.@: Choi (jin@@atype.com),
|
|
|
2404 Scott Cummings (cummings@@adc.com),
|
|
|
2405 Albert Dvornik (bert@@mit.edu),
|
|
|
2406 Eric Eide (eeide@@asylum.cs.utah.edu),
|
|
|
2407 Paul Eggert (eggert@@twinsun.com),
|
|
26263
|
2408 Urban Engberg (ue@@cci.dk),
|
|
25829
|
2409 Kevin Esler (esler@@ch.hp.com),
|
|
|
2410 Robert Estes (estes@@ece.ucdavis.edu),
|
|
|
2411 Jay Finger (jayf@@microsoft.com),
|
|
|
2412 Xavier Fornari (xavier@@europe.cma.fr),
|
|
|
2413 Eric Freudenthal (freudent@@jan.ultra.nyu.edu),
|
|
|
2414 Job Ganzevoort (Job.Ganzevoort@@cwi.nl),
|
|
|
2415 Boris Goldowsky (boris@@cs.rochester.edu),
|
|
|
2416 Allan Gottlieb (gottlieb@@allan.ultra.nyu.edu),
|
|
26263
|
2417 Aaron Gross (aaron@@bfr.co.il),
|
|
25829
|
2418 Thorbjoern Hansen (thorbjoern.hansen@@mchp.siemens.de),
|
|
|
2419 Xiaoli Huang (hxl@@epic.com),
|
|
26263
|
2420 Andreas Jaeger (aj@@suse.de),
|
|
25829
|
2421 Lars Magne Ingebrigtsen (larsi@@ifi.uio.no),
|
|
|
2422 Larry Gouge (larry@@itginc.com),
|
|
|
2423 Karl Heuer (kwzh@@gnu.org),
|
|
|
2424 (irvine@@lks.csi.com),
|
|
|
2425 (jaffe@@chipmunk.cita.utoronto.ca),
|
|
|
2426 David Karr (dkarr@@nmo.gtegsc.com),
|
|
|
2427 Norbert Kiesel (norbert@@i3.informatik.rwth-aachen.de),
|
|
|
2428 Leigh L Klotz (klotz@@adoc.xerox.com),
|
|
|
2429 Fritz Knabe (Fritz.Knabe@@ecrc.de),
|
|
|
2430 Heinz Knutzen (hk@@informatik.uni-kiel.d400.de),
|
|
|
2431 Andrew Koenig (ark@@research.att.com),
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
2432 Hannu Koivisto (azure@@iki.fi),
|
|
25829
|
2433 Ken Laprade (laprade@@dw3f.ess.harris.com),
|
|
|
2434 Will C Lauer (wcl@@cadre.com),
|
|
|
2435 Richard Levitte (levitte@@e.kth.se),
|
|
|
2436 Mike Long (mike.long@@analog.com),
|
|
42602
|
2437 Dave Love (d.love@@dl.ac.uk),
|
|
25829
|
2438 Martin Maechler (maechler@@stat.math.ethz.ch),
|
|
|
2439 Simon Marshall (simon@@gnu.org),
|
38514
10482dd382e7
* viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
diff
changeset
|
2440 Paul C. Meuse (pmeuse@@delcomsys.com),
|
|
25829
|
2441 Richard Mlynarik (mly@@adoc.xerox.com),
|
|
33019
|
2442 Stefan Monnier (monnier@@cs.yale.edu),
|
|
25829
|
2443 Chris Murphy (murphycm@@sun.aston.ac.uk),
|
|
|
2444 Erik Naggum (erik@@naggum.no),
|
|
|
2445 Eyvind Ness (Eyvind.Ness@@hrp.no),
|
|
|
2446 Ray Nickson (nickson@@cs.uq.oz.au),
|
|
|
2447 David Petchey (petchey_david@@jpmorgan.com),
|
|
|
2448 Benjamin Pierce (benjamin.pierce@@cl.cam.ac.uk),
|
|
26263
|
2449 Francois Pinard (pinard@@iro.umontreal.ca),
|
|
25829
|
2450 Tibor Polgar (tlp00@@spg.amdahl.com),
|
|
|
2451 David Prince (dave0d@@fegs.co.uk),
|
|
|
2452 Paul Raines (raines@@slac.stanford.edu),
|
|
43715
|
2453 Stefan Reicher (xsteve@@riic.at),
|
|
25829
|
2454 Bill Richter (richter@@math.nwu.edu),
|
|
|
2455 C.S.@: Roberson (roberson@@aur.alcatel.com),
|
|
|
2456 Kevin Rodgers (kevin.rodgers@@ihs.com),
|
|
|
2457 Sandy Rutherford (sandy@@ibm550.sissa.it),
|
|
|
2458 Heribert Schuetz (schuetz@@ecrc.de),
|
|
|
2459 Andy Scott (ascott@@pcocd2.intel.com),
|
|
|
2460 Axel Seibert (axel@@tumbolia.ppp.informatik.uni-muenchen.de),
|
|
35411
|
2461 Vin Shelton (acs@@xemacs.org),
|
|
|
2462 Scott O. Sherman (Scott.Sherman@@mci.com),
|
|
25829
|
2463 Richard Stallman (rms@@gnu.org),
|
|
|
2464 Richard Stanton (stanton@@haas.berkeley.edu),
|
|
42602
|
2465 Sam Steingold (sds@@goems.com),
|
|
25829
|
2466 Ake Stenhoff (etxaksf@@aom.ericsson.se),
|
|
|
2467 Stig (stig@@hackvan.com),
|
|
|
2468 Peter Stout (Peter_Stout@@cs.cmu.edu),
|
|
|
2469 Chuck Thompson (cthomp@@cs.uiuc.edu),
|
|
|
2470 Ray Tomlinson (tomlinso@@bbn.com),
|
|
|
2471 Raymond Toy (toy@@rtp.ericsson.se),
|
|
43220
|
2472 Stephen J. Turnbull (stephen@@xemacs.org),
|
|
25829
|
2473 Jan Vroonhof (vroonhof@@math.ethz.ch),
|
|
35411
|
2474 Colin Walters (walters@@cis.ohio-state.edu),
|
|
25829
|
2475 Philippe Waroquiers (philippe.waroquiers@@eurocontrol.be),
|
|
|
2476 Klaus Weber (gizmo@@zork.north.de),
|
|
26639
|
2477 Ben Wing (ben@@xemacs.org),
|
|
33019
|
2478 Tom Wurgler (twurgler@@goodyear.com),
|
|
35411
|
2479 Steve Youngs (youngs@@xemacs.org),
|
|
25829
|
2480 Ilya Zakharevich (ilya@@math.ohio-state.edu),
|
|
|
2481 Eli Zaretskii (eliz@@is.elta.co.il)
|
|
|
2482 @end example
|
|
|
2483
|
|
|
2484 @node Index, , Credits, Top
|
|
|
2485 @unnumbered Index
|
|
|
2486 @printindex cp
|
|
|
2487
|
|
29713
|
2488 @setchapternewpage odd
|
|
25829
|
2489 @contents
|
|
|
2490 @bye
|
