diff options
| author | Peter Odding <peter@peterodding.com> | 2015-04-02 21:21:52 +0200 |
|---|---|---|
| committer | Peter Odding <peter@peterodding.com> | 2015-04-02 21:21:52 +0200 |
| commit | b05ac67b8bac71b47d6cae9d19fd12a69dd4ea92 (patch) | |
| tree | df3e91d79b159598be47ccd301d63fb0a2cb0e93 /doc | |
| parent | 188b40b8de49d09735e55be00359e4c664b6ea74 (diff) | |
| download | vim-easytags-b05ac67b8bac71b47d6cae9d19fd12a69dd4ea92.tar.gz | |
Improve easytags_auto_{update,highlight} option documentation
Try to prevent confusion like in issue #92 on GitHub by @oryband:
I had to comment out the auto_update/highlight lines in order for
easytags to create the local .tags file. I thought that these
options were meant only for on_cursorhold. The documentation
regarding this is quite ambiguous: If on_cursorhold is off,
why does auto_update/highlight also apply to events?
Events aren't auto - I set them manually.
For details: https://github.com/xolox/vim-easytags/issues/92
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/easytags.txt | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/easytags.txt b/doc/easytags.txt index afb0c59..b904e86 100644 --- a/doc/easytags.txt +++ b/doc/easytags.txt @@ -399,6 +399,9 @@ keeping automatic highlighting enabled you can set this option to false: > :let g:easytags_auto_update = 0 < +This disables all _automatic_ tags file updates (regardless of how they were +enabled) where automatic means _initiated by a Vim automatic command_. + ------------------------------------------------------------------------------- The *g:easytags_auto_highlight* option @@ -408,6 +411,9 @@ keeping automatic updating enabled you can set this option to false: > :let g:easytags_auto_highlight = 0 < +This disables all _automatic_ tags highlighting (regardless of how it was +enabled) where automatic means _initiated by a Vim automatic command_. + ------------------------------------------------------------------------------- The *g:easytags_autorecurse* option |