diff options
Diffstat (limited to 'doc/undoskip.vim')
-rw-r--r-- | doc/undoskip.vim | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/undoskip.vim b/doc/undoskip.vim new file mode 100644 index 0000000..c0dbbe5 --- /dev/null +++ b/doc/undoskip.vim @@ -0,0 +1,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: |