aboutsummaryrefslogtreecommitdiff
path: root/doc/undofileskip.txt
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2020-05-06 21:16:56 +1200
committerTom Ryder <tom@sanctum.geek.nz>2020-05-06 21:16:56 +1200
commit288978a011ce1515431ae58b4759722207a7739c (patch)
tree2dc9d862d955fb81c9f02dfec11a5c773c14bd45 /doc/undofileskip.txt
parentMerge branch 'hotfix/v0.1.1' into develop (diff)
downloadvim-undofileskip-288978a011ce1515431ae58b4759722207a7739c.tar.gz
vim-undofileskip-288978a011ce1515431ae58b4759722207a7739c.zip
Rename plugin
In order to better reflect 'backupskip', the name should be 'undofileskip', not 'undoskip'. After all, the undo feature isn't removed, only its persistence.
Diffstat (limited to 'doc/undofileskip.txt')
-rw-r--r--doc/undofileskip.txt42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/undofileskip.txt b/doc/undofileskip.txt
new file mode 100644
index 0000000..dcad260
--- /dev/null
+++ b/doc/undofileskip.txt
@@ -0,0 +1,42 @@
+*undofileskip.txt* For Vim version 8.0 Last change: 2020 May 5
+
+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: