aboutsummaryrefslogtreecommitdiff
path: root/doc/undoskip.txt
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2020-05-06 21:01:02 +1200
committerTom Ryder <tom@sanctum.geek.nz>2020-05-06 21:01:02 +1200
commit2edd5da6257d3deeb0157cd7152f8b04e37d94c4 (patch)
treedb0dbfe2f74cde00b34dbc978955b9e5da1b0d53 /doc/undoskip.txt
parentFirst version, spun out from tejr dotfiles v8.29.1 (diff)
parentBump VERSION (diff)
downloadvim-undofileskip-2edd5da6257d3deeb0157cd7152f8b04e37d94c4.tar.gz
vim-undofileskip-2edd5da6257d3deeb0157cd7152f8b04e37d94c4.zip
Merge branch 'hotfix/v0.1.1'v0.1.1
* hotfix/v0.1.1: Give correct extension to documentation
Diffstat (limited to 'doc/undoskip.txt')
-rw-r--r--doc/undoskip.txt42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/undoskip.txt b/doc/undoskip.txt
new file mode 100644
index 0000000..c0dbbe5
--- /dev/null
+++ b/doc/undoskip.txt
@@ -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: