aboutsummaryrefslogtreecommitdiff
path: root/doc/undoskip.vim
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2020-05-05 22:06:46 +1200
committerTom Ryder <tom@sanctum.geek.nz>2020-05-05 22:06:46 +1200
commitd0e9d6b498a7a98951e6ad7717ea77d749e30f7c (patch)
treefb576ec38c7f0704700b5a6df28eeb0ed3e2ab33 /doc/undoskip.vim
downloadvim-undofileskip-d0e9d6b498a7a98951e6ad7717ea77d749e30f7c.tar.gz
vim-undofileskip-d0e9d6b498a7a98951e6ad7717ea77d749e30f7c.zip
First version, spun out from tejr dotfiles v8.29.1v0.1.0
Diffstat (limited to 'doc/undoskip.vim')
-rw-r--r--doc/undoskip.vim42
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: