Mercurial > vim
annotate runtime/doc/diff.txt @ 7382:58958b8c9881 v7.4.996
commit https://github.com/vim/vim/commit/e292d80bede5cb0b9b1ca95176ad6c3fbaae2e0a
Author: Bram Moolenaar <Bram@vim.org>
Date: Tue Dec 29 19:03:21 2015 +0100
patch 7.4.996
Problem: New GDK files and testdir/Make_all.mak missing from distribution.
PC build instructions are outdated.
Solution: Add the file to the list. Update PC build instructions.
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Tue, 29 Dec 2015 19:15:05 +0100 |
parents | 873eae260c97 |
children | f52b263fb3f0 |
rev | line source |
---|---|
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
1 *diff.txt* For Vim version 7.4. Last change: 2015 Nov 01 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 *diff* *vimdiff* *gvimdiff* *diff-mode* | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8 This file describes the |+diff| feature: Showing differences between two, |
1698 | 9 three or four versions of the same file. |
7 | 10 |
11 The basics are explained in section |08.7| of the user manual. | |
12 | |
13 1. Starting diff mode |vimdiff| | |
14 2. Viewing diffs |view-diffs| | |
15 3. Jumping to diffs |jumpto-diffs| | |
16 4. Copying diffs |copy-diffs| | |
17 5. Diff options |diff-options| | |
18 | |
19 {not in Vi} | |
20 | |
21 ============================================================================== | |
22 1. Starting diff mode | |
23 | |
24 The easiest way to start editing in diff mode is with the "vimdiff" command. | |
25 This starts Vim as usual, and additionally sets up for viewing the differences | |
26 between the arguments. > | |
27 | |
28 vimdiff file1 file2 [file3 [file4]] | |
29 | |
30 This is equivalent to: > | |
31 | |
32 vim -d file1 file2 [file3 [file4]] | |
33 | |
34 You may also use "gvimdiff" or "vim -d -g". The GUI is started then. | |
35 You may also use "viewdiff" or "gviewdiff". Vim starts in readonly mode then. | |
36 "r" may be prepended for restricted mode (see |-Z|). | |
37 | |
38 The second and following arguments may also be a directory name. Vim will | |
39 then append the file name of the first argument to the directory name to find | |
40 the file. | |
41 | |
42 This only works when a standard "diff" command is available. See 'diffexpr'. | |
43 | |
674 | 44 Diffs are local to the current tab page |tab-page|. You can't see diffs with |
45 a window in another tab page. This does make it possible to have several | |
46 diffs at the same time, each in their own tab page. | |
47 | |
7 | 48 What happens is that Vim opens a window for each of the files. This is like |
49 using the |-O| argument. This uses vertical splits. If you prefer horizontal | |
50 splits add the |-o| argument: > | |
51 | |
1698 | 52 vimdiff -o file1 file2 [file3 [file4]] |
7 | 53 |
766 | 54 If you always prefer horizontal splits include "horizontal" in 'diffopt'. |
55 | |
7 | 56 In each of the edited files these options are set: |
57 | |
58 'diff' on | |
59 'scrollbind' on | |
2445
04dae202d316
Fixes for coverity warnings.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
60 'cursorbind' on |
7 | 61 'scrollopt' includes "hor" |
62 'wrap' off | |
63 'foldmethod' "diff" | |
766 | 64 'foldcolumn' value from 'diffopt', default is 2 |
7 | 65 |
66 These options are set local to the window. When editing another file they are | |
67 reset to the global value. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
68 The options can still be overruled from a modeline when re-editing the file. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
69 However, 'foldmethod' and 'wrap' won't be set from a modeline when 'diff' is |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
70 set. |
7 | 71 |
72 The differences shown are actually the differences in the buffer. Thus if you | |
73 make changes after loading a file, these will be included in the displayed | |
74 diffs. You might have to do ":diffupdate" now and then, not all changes are | |
75 immediately taken into account. | |
76 | |
77 In your .vimrc file you could do something special when Vim was started in | |
78 diff mode. You could use a construct like this: > | |
79 | |
80 if &diff | |
81 setup for diff mode | |
82 else | |
83 setup for non-diff mode | |
84 endif | |
85 | |
86 While already in Vim you can start diff mode in three ways. | |
87 | |
88 *E98* | |
3830 | 89 :diffs[plit] {filename} *:diffs* *:diffsplit* |
7 | 90 Open a new window on the file {filename}. The options are set |
91 as for "vimdiff" for the current and the newly opened window. | |
92 Also see 'diffexpr'. | |
93 | |
94 *:difft* *:diffthis* | |
3830 | 95 :difft[his] Make the current window part of the diff windows. This sets |
16 | 96 the options like for "vimdiff". |
7 | 97 |
5929 | 98 :diffp[atch] {patchfile} *E816* *:diffp* *:diffpatch* |
7 | 99 Use the current buffer, patch it with the diff found in |
100 {patchfile} and open a buffer on the result. The options are | |
101 set as for "vimdiff". | |
102 {patchfile} can be in any format that the "patch" program | |
103 understands or 'patchexpr' can handle. | |
104 Note that {patchfile} should only contain a diff for one file, | |
105 the current file. If {patchfile} contains diffs for other | |
106 files as well, the results are unpredictable. Vim changes | |
107 directory to /tmp to avoid files in the current directory | |
108 accidentally being patched. But it may still result in | |
109 various ".rej" files to be created. And when absolute path | |
110 names are present these files may get patched anyway. | |
111 | |
112 To make these commands use a vertical split, prepend |:vertical|. Examples: > | |
113 | |
114 :vert diffsplit main.c~ | |
115 :vert diffpatch /tmp/diff | |
766 | 116 |
117 If you always prefer a vertical split include "vertical" in 'diffopt'. | |
118 | |
7 | 119 *E96* |
120 There can be up to four buffers with 'diff' set. | |
121 | |
122 Since the option values are remembered with the buffer, you can edit another | |
123 file for a moment and come back to the same file and be in diff mode again. | |
16 | 124 |
125 *:diffo* *:diffoff* | |
5362
ab1508486b12
Update runtime files. Add support for J.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
126 :diffo[ff] Switch off diff mode for the current window. Resets related |
ab1508486b12
Update runtime files. Add support for J.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
127 options also when 'diff' was not set. |
16 | 128 |
3830 | 129 :diffo[ff]! Switch off diff mode for the current window and in all windows |
5362
ab1508486b12
Update runtime files. Add support for J.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
130 in the current tab page where 'diff' is set. Resetting |
ab1508486b12
Update runtime files. Add support for J.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
131 related options only happens in a window that has 'diff' set, |
ab1508486b12
Update runtime files. Add support for J.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
132 if the current window does not have 'diff' set then no options |
ab1508486b12
Update runtime files. Add support for J.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
133 in it are changed. |
7 | 134 |
6918 | 135 The `:diffoff` command resets the relevant options to the values they had when |
136 using `:diffsplit`, `:diffpatch` , `:diffthis`. or starting Vim in diff mode. | |
137 When using `:diffoff` twice the last saved values are restored. | |
5161
f7add3891e95
Updated runtime files. Fix NL translations.
Bram Moolenaar <bram@vim.org>
parents:
5146
diff
changeset
|
138 Otherwise they are set to their default value: |
16 | 139 |
140 'diff' off | |
141 'scrollbind' off | |
2445
04dae202d316
Fixes for coverity warnings.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
142 'cursorbind' off |
16 | 143 'scrollopt' without "hor" |
144 'wrap' on | |
145 'foldmethod' "manual" | |
146 'foldcolumn' 0 | |
7 | 147 |
148 ============================================================================== | |
149 2. Viewing diffs *view-diffs* | |
150 | |
151 The effect is that the diff windows show the same text, with the differences | |
152 highlighted. When scrolling the text, the 'scrollbind' option will make the | |
153 text in other windows to be scrolled as well. With vertical splits the text | |
154 should be aligned properly. | |
155 | |
156 The alignment of text will go wrong when: | |
157 - 'wrap' is on, some lines will be wrapped and occupy two or more screen | |
158 lines | |
159 - folds are open in one window but not another | |
160 - 'scrollbind' is off | |
161 - changes have been made to the text | |
162 - "filler" is not present in 'diffopt', deleted/inserted lines makes the | |
163 alignment go wrong | |
164 | |
165 All the buffers edited in a window where the 'diff' option is set will join in | |
166 the diff. This is also possible for hidden buffers. They must have been | |
167 edited in a window first for this to be possible. | |
168 | |
1121 | 169 *:DiffOrig* *diff-original-file* |
7 | 170 Since 'diff' is a window-local option, it's possible to view the same buffer |
171 in diff mode in one window and "normal" in another window. It is also | |
1121 | 172 possible to view the changes you have made to a buffer since the file was |
173 loaded. Since Vim doesn't allow having two buffers for the same file, you | |
174 need another buffer. This command is useful: > | |
2788 | 175 command DiffOrig vert new | set bt=nofile | r ++edit # | 0d_ |
176 \ | diffthis | wincmd p | diffthis | |
1121 | 177 (this is in |vimrc_example.vim|). Use ":DiffOrig" to see the differences |
178 between the current buffer and the file it was loaded from. | |
7 | 179 |
180 A buffer that is unloaded cannot be used for the diff. But it does work for | |
181 hidden buffers. You can use ":hide" to close a window without unloading the | |
195 | 182 buffer. If you don't want a buffer to remain used for the diff do ":set |
183 nodiff" before hiding it. | |
7 | 184 |
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
185 *:dif* *:diffupdate* |
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
186 :dif[fupdate][!] Update the diff highlighting and folds. |
270 | 187 |
7 | 188 Vim attempts to keep the differences updated when you make changes to the |
189 text. This mostly takes care of inserted and deleted lines. Changes within a | |
190 line and more complicated changes do not cause the differences to be updated. | |
191 To force the differences to be updated use: > | |
192 | |
193 :diffupdate | |
194 | |
3524 | 195 If the ! is included Vim will check if the file was changed externally and |
196 needs to be reloaded. It will prompt for each changed file, like `:checktime` | |
197 was used. | |
7 | 198 |
199 Vim will show filler lines for lines that are missing in one window but are | |
200 present in another. These lines were inserted in another file or deleted in | |
201 this file. Removing "filler" from the 'diffopt' option will make Vim not | |
202 display these filler lines. | |
203 | |
204 | |
205 Folds are used to hide the text that wasn't changed. See |folding| for all | |
206 the commands that can be used with folds. | |
207 | |
208 The context of lines above a difference that are not included in the fold can | |
209 be set with the 'diffopt' option. For example, to set the context to three | |
210 lines: > | |
211 | |
212 :set diffopt=filler,context:3 | |
213 | |
214 | |
215 The diffs are highlighted with these groups: | |
216 | |
217 |hl-DiffAdd| DiffAdd Added (inserted) lines. These lines exist in | |
218 this buffer but not in another. | |
219 |hl-DiffChange| DiffChange Changed lines. | |
220 |hl-DiffText| DiffText Changed text inside a Changed line. Vim | |
221 finds the first character that is different, | |
222 and the last character that is different | |
223 (searching from the end of the line). The | |
224 text in between is highlighted. This means | |
225 that parts in the middle that are still the | |
829 | 226 same are highlighted anyway. Only "iwhite" of |
227 'diffopt' is used here. | |
4098 | 228 |hl-DiffDelete| DiffDelete Deleted lines. Also called filler lines, |
7 | 229 because they don't really exist in this |
230 buffer. | |
231 | |
232 ============================================================================== | |
233 3. Jumping to diffs *jumpto-diffs* | |
234 | |
235 Two commands can be used to jump to diffs: | |
236 *[c* | |
237 [c Jump backwards to the previous start of a change. | |
238 When a count is used, do it that many times. | |
239 *]c* | |
240 ]c Jump forwards to the next start of a change. | |
241 When a count is used, do it that many times. | |
242 | |
243 It is an error if there is no change for the cursor to move to. | |
244 | |
245 ============================================================================== | |
246 4. Diff copying *copy-diffs* *E99* *E100* *E101* *E102* *E103* | |
532 | 247 *merge* |
7 | 248 There are two commands to copy text from one buffer to another. The result is |
249 that the buffers will be equal within the specified range. | |
250 | |
251 *:diffg* *:diffget* | |
252 :[range]diffg[et] [bufspec] | |
253 Modify the current buffer to undo difference with another | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
254 buffer. If [bufspec] is given, that buffer is used. If |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
255 [bufspec] refers to the current buffer then nothing happens. |
7 | 256 Otherwise this only works if there is one other buffer in diff |
257 mode. | |
258 See below for [range]. | |
259 | |
1121 | 260 *:diffpu* *:diffput* *E793* |
7 | 261 :[range]diffpu[t] [bufspec] |
262 Modify another buffer to undo difference with the current | |
263 buffer. Just like ":diffget" but the other buffer is modified | |
264 instead of the current one. | |
532 | 265 When [bufspec] is omitted and there is more than one other |
266 buffer in diff mode where 'modifiable' is set this fails. | |
7 | 267 See below for [range]. |
268 | |
269 *do* | |
6336 | 270 [count]do Same as ":diffget" without range. The "o" stands for "obtain" |
271 ("dg" can't be used, it could be the start of "dgg"!). Note: | |
272 this doesn't work in Visual mode. | |
273 If you give a [count], it is used as the [bufspec] argument | |
274 for ":diffget". | |
7 | 275 |
276 *dp* | |
6336 | 277 [count]dp Same as ":diffput" without range. Note: this doesn't work in |
278 Visual mode. | |
279 If you give a [count], it is used as the [bufspec] argument | |
280 for ":diffput". | |
2596 | 281 |
7 | 282 |
283 When no [range] is given, the diff at the cursor position or just above it is | |
284 affected. When [range] is used, Vim tries to only put or get the specified | |
285 lines. When there are deleted lines, this may not always be possible. | |
286 | |
287 There can be deleted lines below the last line of the buffer. When the cursor | |
288 is on the last line in the buffer and there is no diff above this line, the | |
289 ":diffget" and "do" commands will obtain lines from the other buffer. | |
290 | |
291 To be able to get those lines from another buffer in a [range] it's allowed to | |
292 use the last line number plus one. This command gets all diffs from the other | |
293 buffer: > | |
294 | |
295 :1,$+1diffget | |
296 | |
297 Note that deleted lines are displayed, but not counted as text lines. You | |
298 can't move the cursor into them. To fill the deleted lines with the lines | |
299 from another buffer use ":diffget" on the line below them. | |
819 | 300 *E787* |
301 When the buffer that is about to be modified is read-only and the autocommand | |
302 that is triggered by |FileChangedRO| changes buffers the command will fail. | |
303 The autocommand must not change buffers. | |
7 | 304 |
305 The [bufspec] argument above can be a buffer number, a pattern for a buffer | |
306 name or a part of a buffer name. Examples: | |
307 | |
308 :diffget Use the other buffer which is in diff mode | |
309 :diffget 3 Use buffer 3 | |
310 :diffget v2 Use the buffer which matches "v2" and is in | |
311 diff mode (e.g., "file.c.v2") | |
312 | |
313 ============================================================================== | |
314 5. Diff options *diff-options* | |
315 | |
316 Also see |'diffopt'| and the "diff" item of |'fillchars'|. | |
317 | |
6583 | 318 *diff-slow* *diff_translations* |
319 For very long lines, the diff syntax highlighting might be slow, especially | |
320 since it tries to match all different kind of localisations. To disable | |
321 localisations and speed up the syntax highlighting, set the global variable | |
322 g:diff_translations to zero: > | |
323 | |
324 let g:diff_translations = 0 | |
325 < | |
326 After setting this variable, Reload the syntax script: > | |
327 | |
328 set syntax=diff | |
329 < | |
330 | |
7 | 331 |
332 FINDING THE DIFFERENCES *diff-diffexpr* | |
333 | |
334 The 'diffexpr' option can be set to use something else than the standard | |
335 "diff" program to compare two files and find the differences. | |
336 | |
337 When 'diffexpr' is empty, Vim uses this command to find the differences | |
338 between file1 and file2: > | |
339 | |
340 diff file1 file2 > outfile | |
341 | |
342 The ">" is replaced with the value of 'shellredir'. | |
343 | |
344 The output of "diff" must be a normal "ed" style diff. Do NOT use a context | |
345 diff. This example explains the format that Vim expects: > | |
346 | |
347 1a2 | |
348 > bbb | |
349 4d4 | |
350 < 111 | |
351 7c7 | |
352 < GGG | |
353 --- | |
354 > ggg | |
355 | |
356 The "1a2" item appends the line "bbb". | |
357 The "4d4" item deletes the line "111". | |
3750 | 358 The "7c7" item replaces the line "GGG" with "ggg". |
7 | 359 |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
360 When 'diffexpr' is not empty, Vim evaluates it to obtain a diff file in the |
7 | 361 format mentioned. These variables are set to the file names used: |
362 | |
363 v:fname_in original file | |
364 v:fname_new new version of the same file | |
365 v:fname_out resulting diff file | |
366 | |
367 Additionally, 'diffexpr' should take care of "icase" and "iwhite" in the | |
368 'diffopt' option. 'diffexpr' cannot change the value of 'lines' and | |
369 'columns'. | |
370 | |
371 Example (this does almost the same as 'diffexpr' being empty): > | |
372 | |
373 set diffexpr=MyDiff() | |
374 function MyDiff() | |
375 let opt = "" | |
376 if &diffopt =~ "icase" | |
377 let opt = opt . "-i " | |
378 endif | |
379 if &diffopt =~ "iwhite" | |
380 let opt = opt . "-b " | |
381 endif | |
382 silent execute "!diff -a --binary " . opt . v:fname_in . " " . v:fname_new . | |
383 \ " > " . v:fname_out | |
384 endfunction | |
385 | |
386 The "-a" argument is used to force comparing the files as text, comparing as | |
387 binaries isn't useful. The "--binary" argument makes the files read in binary | |
388 mode, so that a CTRL-Z doesn't end the text on DOS. | |
389 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
390 *E810* *E97* |
7 | 391 Vim will do a test if the diff output looks alright. If it doesn't, you will |
392 get an error message. Possible causes: | |
393 - The "diff" program cannot be executed. | |
394 - The "diff" program doesn't produce normal "ed" style diffs (see above). | |
395 - The 'shell' and associated options are not set correctly. Try if filtering | |
396 works with a command like ":!sort". | |
397 - You are using 'diffexpr' and it doesn't work. | |
639 | 398 If it's not clear what the problem is set the 'verbose' option to one or more |
399 to see more messages. | |
7 | 400 |
2642 | 401 The self-installing Vim for MS-Windows includes a diff program. If you don't |
402 have it you might want to download a diff.exe. For example from | |
2662 | 403 http://gnuwin32.sourceforge.net/packages/diffutils.htm. |
20 | 404 |
7 | 405 |
406 USING PATCHES *diff-patchexpr* | |
407 | |
408 The 'patchexpr' option can be set to use something else than the standard | |
409 "patch" program. | |
410 | |
411 When 'patchexpr' is empty, Vim will call the "patch" program like this: > | |
412 | |
413 patch -o outfile origfile < patchfile | |
414 | |
415 This should work fine with most versions of the "patch" program. Note that a | |
416 CR in the middle of a line may cause problems, it is seen as a line break. | |
417 | |
418 If the default doesn't work for you, set the 'patchexpr' to an expression that | |
419 will have the same effect. These variables are set to the file names used: | |
420 | |
421 v:fname_in original file | |
422 v:fname_diff patch file | |
423 v:fname_out resulting patched file | |
424 | |
425 Example (this does the same as 'patchexpr' being empty): > | |
426 | |
766 | 427 set patchexpr=MyPatch() |
428 function MyPatch() | |
7 | 429 :call system("patch -o " . v:fname_out . " " . v:fname_in . |
430 \ " < " . v:fname_diff) | |
431 endfunction | |
432 | |
433 Make sure that using the "patch" program doesn't have unwanted side effects. | |
434 For example, watch out for additionally generated files, which should be | |
435 deleted. It should just patch the file and nothing else. | |
436 Vim will change directory to "/tmp" or another temp directory before | |
437 evaluating 'patchexpr'. This hopefully avoids that files in the current | |
438 directory are accidentally patched. Vim will also delete files starting with | |
439 v:fname_in and ending in ".rej" and ".orig". | |
440 | |
441 vim:tw=78:ts=8:ft=help:norl: |