Mercurial > vim
annotate runtime/doc/diff.txt @ 6583:b0a227941705
Update runtime files.
| author | Bram Moolenaar <bram@vim.org> |
|---|---|
| date | Tue, 03 Feb 2015 19:13:34 +0100 |
| parents | 4abac79c0b7a |
| children | 2def7b25de60 |
| rev | line source |
|---|---|
| 6583 | 1 *diff.txt* For Vim version 7.4. Last change: 2015 Feb 03 |
| 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 |
|
5161
f7add3891e95
Updated runtime files. Fix NL translations.
Bram Moolenaar <bram@vim.org>
parents:
5146
diff
changeset
|
135 The ":diffoff" command resets the relevant options to the values they had when |
|
f7add3891e95
Updated runtime files. Fix NL translations.
Bram Moolenaar <bram@vim.org>
parents:
5146
diff
changeset
|
136 using |:diffsplit|, |:diffpatch| , |:diffthis|. or starting Vim in diff mode. |
|
f7add3891e95
Updated runtime files. Fix NL translations.
Bram Moolenaar <bram@vim.org>
parents:
5146
diff
changeset
|
137 Otherwise they are set to their default value: |
| 16 | 138 |
| 139 'diff' off | |
| 140 'scrollbind' off | |
|
2445
04dae202d316
Fixes for coverity warnings.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
141 'cursorbind' off |
| 16 | 142 'scrollopt' without "hor" |
| 143 'wrap' on | |
| 144 'foldmethod' "manual" | |
| 145 'foldcolumn' 0 | |
| 7 | 146 |
| 147 ============================================================================== | |
| 148 2. Viewing diffs *view-diffs* | |
| 149 | |
| 150 The effect is that the diff windows show the same text, with the differences | |
| 151 highlighted. When scrolling the text, the 'scrollbind' option will make the | |
| 152 text in other windows to be scrolled as well. With vertical splits the text | |
| 153 should be aligned properly. | |
| 154 | |
| 155 The alignment of text will go wrong when: | |
| 156 - 'wrap' is on, some lines will be wrapped and occupy two or more screen | |
| 157 lines | |
| 158 - folds are open in one window but not another | |
| 159 - 'scrollbind' is off | |
| 160 - changes have been made to the text | |
| 161 - "filler" is not present in 'diffopt', deleted/inserted lines makes the | |
| 162 alignment go wrong | |
| 163 | |
| 164 All the buffers edited in a window where the 'diff' option is set will join in | |
| 165 the diff. This is also possible for hidden buffers. They must have been | |
| 166 edited in a window first for this to be possible. | |
| 167 | |
| 1121 | 168 *:DiffOrig* *diff-original-file* |
| 7 | 169 Since 'diff' is a window-local option, it's possible to view the same buffer |
| 170 in diff mode in one window and "normal" in another window. It is also | |
| 1121 | 171 possible to view the changes you have made to a buffer since the file was |
| 172 loaded. Since Vim doesn't allow having two buffers for the same file, you | |
| 173 need another buffer. This command is useful: > | |
| 2788 | 174 command DiffOrig vert new | set bt=nofile | r ++edit # | 0d_ |
| 175 \ | diffthis | wincmd p | diffthis | |
| 1121 | 176 (this is in |vimrc_example.vim|). Use ":DiffOrig" to see the differences |
| 177 between the current buffer and the file it was loaded from. | |
| 7 | 178 |
| 179 A buffer that is unloaded cannot be used for the diff. But it does work for | |
| 180 hidden buffers. You can use ":hide" to close a window without unloading the | |
| 195 | 181 buffer. If you don't want a buffer to remain used for the diff do ":set |
| 182 nodiff" before hiding it. | |
| 7 | 183 |
| 184 *:diffu* *:diffupdate* | |
| 3524 | 185 :diffu[pdate][!] Update the diff highlighting and folds. |
| 270 | 186 |
| 7 | 187 Vim attempts to keep the differences updated when you make changes to the |
| 188 text. This mostly takes care of inserted and deleted lines. Changes within a | |
| 189 line and more complicated changes do not cause the differences to be updated. | |
| 190 To force the differences to be updated use: > | |
| 191 | |
| 192 :diffupdate | |
| 193 | |
| 3524 | 194 If the ! is included Vim will check if the file was changed externally and |
| 195 needs to be reloaded. It will prompt for each changed file, like `:checktime` | |
| 196 was used. | |
| 7 | 197 |
| 198 Vim will show filler lines for lines that are missing in one window but are | |
| 199 present in another. These lines were inserted in another file or deleted in | |
| 200 this file. Removing "filler" from the 'diffopt' option will make Vim not | |
| 201 display these filler lines. | |
| 202 | |
| 203 | |
| 204 Folds are used to hide the text that wasn't changed. See |folding| for all | |
| 205 the commands that can be used with folds. | |
| 206 | |
| 207 The context of lines above a difference that are not included in the fold can | |
| 208 be set with the 'diffopt' option. For example, to set the context to three | |
| 209 lines: > | |
| 210 | |
| 211 :set diffopt=filler,context:3 | |
| 212 | |
| 213 | |
| 214 The diffs are highlighted with these groups: | |
| 215 | |
| 216 |hl-DiffAdd| DiffAdd Added (inserted) lines. These lines exist in | |
| 217 this buffer but not in another. | |
| 218 |hl-DiffChange| DiffChange Changed lines. | |
| 219 |hl-DiffText| DiffText Changed text inside a Changed line. Vim | |
| 220 finds the first character that is different, | |
| 221 and the last character that is different | |
| 222 (searching from the end of the line). The | |
| 223 text in between is highlighted. This means | |
| 224 that parts in the middle that are still the | |
| 829 | 225 same are highlighted anyway. Only "iwhite" of |
| 226 'diffopt' is used here. | |
| 4098 | 227 |hl-DiffDelete| DiffDelete Deleted lines. Also called filler lines, |
| 7 | 228 because they don't really exist in this |
| 229 buffer. | |
| 230 | |
| 231 ============================================================================== | |
| 232 3. Jumping to diffs *jumpto-diffs* | |
| 233 | |
| 234 Two commands can be used to jump to diffs: | |
| 235 *[c* | |
| 236 [c Jump backwards to the previous start of a change. | |
| 237 When a count is used, do it that many times. | |
| 238 *]c* | |
| 239 ]c Jump forwards to the next start of a change. | |
| 240 When a count is used, do it that many times. | |
| 241 | |
| 242 It is an error if there is no change for the cursor to move to. | |
| 243 | |
| 244 ============================================================================== | |
| 245 4. Diff copying *copy-diffs* *E99* *E100* *E101* *E102* *E103* | |
| 532 | 246 *merge* |
| 7 | 247 There are two commands to copy text from one buffer to another. The result is |
| 248 that the buffers will be equal within the specified range. | |
| 249 | |
| 250 *:diffg* *:diffget* | |
| 251 :[range]diffg[et] [bufspec] | |
| 252 Modify the current buffer to undo difference with another | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
253 buffer. If [bufspec] is given, that buffer is used. If |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
254 [bufspec] refers to the current buffer then nothing happens. |
| 7 | 255 Otherwise this only works if there is one other buffer in diff |
| 256 mode. | |
| 257 See below for [range]. | |
| 258 | |
| 1121 | 259 *:diffpu* *:diffput* *E793* |
| 7 | 260 :[range]diffpu[t] [bufspec] |
| 261 Modify another buffer to undo difference with the current | |
| 262 buffer. Just like ":diffget" but the other buffer is modified | |
| 263 instead of the current one. | |
| 532 | 264 When [bufspec] is omitted and there is more than one other |
| 265 buffer in diff mode where 'modifiable' is set this fails. | |
| 7 | 266 See below for [range]. |
| 267 | |
| 268 *do* | |
| 6336 | 269 [count]do Same as ":diffget" without range. The "o" stands for "obtain" |
| 270 ("dg" can't be used, it could be the start of "dgg"!). Note: | |
| 271 this doesn't work in Visual mode. | |
| 272 If you give a [count], it is used as the [bufspec] argument | |
| 273 for ":diffget". | |
| 7 | 274 |
| 275 *dp* | |
| 6336 | 276 [count]dp Same as ":diffput" without range. Note: this doesn't work in |
| 277 Visual mode. | |
| 278 If you give a [count], it is used as the [bufspec] argument | |
| 279 for ":diffput". | |
| 2596 | 280 |
| 7 | 281 |
| 282 When no [range] is given, the diff at the cursor position or just above it is | |
| 283 affected. When [range] is used, Vim tries to only put or get the specified | |
| 284 lines. When there are deleted lines, this may not always be possible. | |
| 285 | |
| 286 There can be deleted lines below the last line of the buffer. When the cursor | |
| 287 is on the last line in the buffer and there is no diff above this line, the | |
| 288 ":diffget" and "do" commands will obtain lines from the other buffer. | |
| 289 | |
| 290 To be able to get those lines from another buffer in a [range] it's allowed to | |
| 291 use the last line number plus one. This command gets all diffs from the other | |
| 292 buffer: > | |
| 293 | |
| 294 :1,$+1diffget | |
| 295 | |
| 296 Note that deleted lines are displayed, but not counted as text lines. You | |
| 297 can't move the cursor into them. To fill the deleted lines with the lines | |
| 298 from another buffer use ":diffget" on the line below them. | |
| 819 | 299 *E787* |
| 300 When the buffer that is about to be modified is read-only and the autocommand | |
| 301 that is triggered by |FileChangedRO| changes buffers the command will fail. | |
| 302 The autocommand must not change buffers. | |
| 7 | 303 |
| 304 The [bufspec] argument above can be a buffer number, a pattern for a buffer | |
| 305 name or a part of a buffer name. Examples: | |
| 306 | |
| 307 :diffget Use the other buffer which is in diff mode | |
| 308 :diffget 3 Use buffer 3 | |
| 309 :diffget v2 Use the buffer which matches "v2" and is in | |
| 310 diff mode (e.g., "file.c.v2") | |
| 311 | |
| 312 ============================================================================== | |
| 313 5. Diff options *diff-options* | |
| 314 | |
| 315 Also see |'diffopt'| and the "diff" item of |'fillchars'|. | |
| 316 | |
| 6583 | 317 *diff-slow* *diff_translations* |
| 318 For very long lines, the diff syntax highlighting might be slow, especially | |
| 319 since it tries to match all different kind of localisations. To disable | |
| 320 localisations and speed up the syntax highlighting, set the global variable | |
| 321 g:diff_translations to zero: > | |
| 322 | |
| 323 let g:diff_translations = 0 | |
| 324 < | |
| 325 After setting this variable, Reload the syntax script: > | |
| 326 | |
| 327 set syntax=diff | |
| 328 < | |
| 329 | |
| 7 | 330 |
| 331 FINDING THE DIFFERENCES *diff-diffexpr* | |
| 332 | |
| 333 The 'diffexpr' option can be set to use something else than the standard | |
| 334 "diff" program to compare two files and find the differences. | |
| 335 | |
| 336 When 'diffexpr' is empty, Vim uses this command to find the differences | |
| 337 between file1 and file2: > | |
| 338 | |
| 339 diff file1 file2 > outfile | |
| 340 | |
| 341 The ">" is replaced with the value of 'shellredir'. | |
| 342 | |
| 343 The output of "diff" must be a normal "ed" style diff. Do NOT use a context | |
| 344 diff. This example explains the format that Vim expects: > | |
| 345 | |
| 346 1a2 | |
| 347 > bbb | |
| 348 4d4 | |
| 349 < 111 | |
| 350 7c7 | |
| 351 < GGG | |
| 352 --- | |
| 353 > ggg | |
| 354 | |
| 355 The "1a2" item appends the line "bbb". | |
| 356 The "4d4" item deletes the line "111". | |
| 3750 | 357 The "7c7" item replaces the line "GGG" with "ggg". |
| 7 | 358 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
359 When 'diffexpr' is not empty, Vim evaluates it to obtain a diff file in the |
| 7 | 360 format mentioned. These variables are set to the file names used: |
| 361 | |
| 362 v:fname_in original file | |
| 363 v:fname_new new version of the same file | |
| 364 v:fname_out resulting diff file | |
| 365 | |
| 366 Additionally, 'diffexpr' should take care of "icase" and "iwhite" in the | |
| 367 'diffopt' option. 'diffexpr' cannot change the value of 'lines' and | |
| 368 'columns'. | |
| 369 | |
| 370 Example (this does almost the same as 'diffexpr' being empty): > | |
| 371 | |
| 372 set diffexpr=MyDiff() | |
| 373 function MyDiff() | |
| 374 let opt = "" | |
| 375 if &diffopt =~ "icase" | |
| 376 let opt = opt . "-i " | |
| 377 endif | |
| 378 if &diffopt =~ "iwhite" | |
| 379 let opt = opt . "-b " | |
| 380 endif | |
| 381 silent execute "!diff -a --binary " . opt . v:fname_in . " " . v:fname_new . | |
| 382 \ " > " . v:fname_out | |
| 383 endfunction | |
| 384 | |
| 385 The "-a" argument is used to force comparing the files as text, comparing as | |
| 386 binaries isn't useful. The "--binary" argument makes the files read in binary | |
| 387 mode, so that a CTRL-Z doesn't end the text on DOS. | |
| 388 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
389 *E810* *E97* |
| 7 | 390 Vim will do a test if the diff output looks alright. If it doesn't, you will |
| 391 get an error message. Possible causes: | |
| 392 - The "diff" program cannot be executed. | |
| 393 - The "diff" program doesn't produce normal "ed" style diffs (see above). | |
| 394 - The 'shell' and associated options are not set correctly. Try if filtering | |
| 395 works with a command like ":!sort". | |
| 396 - You are using 'diffexpr' and it doesn't work. | |
| 639 | 397 If it's not clear what the problem is set the 'verbose' option to one or more |
| 398 to see more messages. | |
| 7 | 399 |
| 2642 | 400 The self-installing Vim for MS-Windows includes a diff program. If you don't |
| 401 have it you might want to download a diff.exe. For example from | |
| 2662 | 402 http://gnuwin32.sourceforge.net/packages/diffutils.htm. |
| 20 | 403 |
| 7 | 404 |
| 405 USING PATCHES *diff-patchexpr* | |
| 406 | |
| 407 The 'patchexpr' option can be set to use something else than the standard | |
| 408 "patch" program. | |
| 409 | |
| 410 When 'patchexpr' is empty, Vim will call the "patch" program like this: > | |
| 411 | |
| 412 patch -o outfile origfile < patchfile | |
| 413 | |
| 414 This should work fine with most versions of the "patch" program. Note that a | |
| 415 CR in the middle of a line may cause problems, it is seen as a line break. | |
| 416 | |
| 417 If the default doesn't work for you, set the 'patchexpr' to an expression that | |
| 418 will have the same effect. These variables are set to the file names used: | |
| 419 | |
| 420 v:fname_in original file | |
| 421 v:fname_diff patch file | |
| 422 v:fname_out resulting patched file | |
| 423 | |
| 424 Example (this does the same as 'patchexpr' being empty): > | |
| 425 | |
| 766 | 426 set patchexpr=MyPatch() |
| 427 function MyPatch() | |
| 7 | 428 :call system("patch -o " . v:fname_out . " " . v:fname_in . |
| 429 \ " < " . v:fname_diff) | |
| 430 endfunction | |
| 431 | |
| 432 Make sure that using the "patch" program doesn't have unwanted side effects. | |
| 433 For example, watch out for additionally generated files, which should be | |
| 434 deleted. It should just patch the file and nothing else. | |
| 435 Vim will change directory to "/tmp" or another temp directory before | |
| 436 evaluating 'patchexpr'. This hopefully avoids that files in the current | |
| 437 directory are accidentally patched. Vim will also delete files starting with | |
| 438 v:fname_in and ending in ".rej" and ".orig". | |
| 439 | |
| 440 vim:tw=78:ts=8:ft=help:norl: |