aboutsummaryrefslogtreecommitdiff
path: root/doc/undoskip.txt
blob: c0dbbe5abb3b15297a51afb3e2cf7716e44503e0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
*undoskip.txt*		For Vim version 8.0	Last change: 2020 May 5

DESCRIPTION				*undoskip*

This plugin emulates the `'backupskip'` option's functionality for the
|+persistent_undo| feature, checking buffer file paths against a list of
globs, and switching the `'undofile'` option off locally if any of them match.

REQUIREMENTS				*undoskip-requirements*

This plugin only loads if 'compatible' is not set.  If requires both the
|+persistent_undo| feature and the |glob2regpat()| function.  The earliest
full release of Vim with both of these was v8.0.

OPTIONS					*undoskip-options*

					*g:undoskip*
Set `g:undoskip` to a list of globs to match against file buffer paths and
switch 'undofile' on or off accordingly.  Defaults to the same values as
'backupskip' (or tries to).

Some possibly useful values:
>
	let g:undoskip = [
	      \ '/tmp/*',
	      \ '/dev/shm/*',
	      \ '/usr/tmp/*',
	      \ '/var/tmp/*',
	      \ '*.git/*_EDITMSG',
	      \ '*.git/ADD_EDIT.patch',
	      \ '*.git/rebase-merge/git-rebase-todo',
	      \]
<
AUTHOR					*undoskip-author*

Written and maintained by Tom Ryder <tom@sanctum.geek.nz>.

LICENSE					*undoskip-license*

Licensed for distribution under the same terms as Vim itself (see |license|).

 vim:tw=78:ts=8:ft=help:norl: