aboutsummaryrefslogblamecommitdiff
path: root/doc/undofileskip.txt
blob: f0d612ebef9802e6ef3bf96712704e4b290aff3f (plain) (tree)
1
2
3
4
5
6
7
8
9
                                                                       
 
                                                      




                                                                              
                                                                   




                                                                          
                                                              
 

                                                                              




                                                                        
                              








                                                     
                                                             


                                                          
                                                              



                                                                             
*undofileskip.txt*	For Vim version 8.0	Last change: 2020 May 6

DESCRIPTION				*undofileskip*

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				*undofileskip-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					*undofileskip-options*

					*g:undofileskip*
Set `g:undofileskip` 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:undofileskip = [
	      \ '/tmp/*',
	      \ '/dev/shm/*',
	      \ '/usr/tmp/*',
	      \ '/var/tmp/*',
	      \ '*.git/*_EDITMSG',
	      \ '*.git/ADD_EDIT.patch',
	      \ '*.git/rebase-merge/git-rebase-todo',
	      \]
<
AUTHOR					*undofileskip-author*

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

LICENSE					*undofileskip-license*

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

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