Browse Source

Improve documentation of `easytags_dynamic_files' option

See also issue 92 and issue 116 on GitHub:
 - https://github.com/xolox/vim-easytags/issues/92
 - https://github.com/xolox/vim-easytags/issues/116
tags/3.10.1
Peter Odding 5 years ago
parent
commit
a339a8c440
3 changed files with 13 additions and 5 deletions
  1. +4
    -1
      README.md
  2. +2
    -2
      autoload/xolox/easytags.vim
  3. +7
    -2
      doc/easytags.txt

+ 4
- 1
README.md View File

@@ -121,7 +121,9 @@ By default `:UpdateTags` only writes to the global tags file, but it can be conf

You can change the name of the tags file, the important thing is that it's relative to your working directory or the buffer (using a leading `./`). When `g:easytags_dynamic_files` is set to 1 the easytags plug-in will write to the first existing tags file seen by Vim (based on the ['tags' option] [tags_opt]). In other words: If a project specific tags file is found it will be used, otherwise the plug-in falls back to the global tags file (or a file type specific tags file).

If you set `g:easytags_dynamic_files` to 2 the easytags plug-in will automatically create a project specific tags file based on the first name in the 'tags' option. In this mode the global tags file and/or file type specific tags files are only used for directories where you don't have write permissions.
If you set `g:easytags_dynamic_files` to 2 the easytags plug-in will automatically create a project specific tags file based on the first name in the ['tags' option] [tags_opt]. In this mode the global tags file and/or file type specific tags files are only used for directories where you don't have write permissions.

When you set `g:easytags_dynamic_files` to 2 new tags files are created in the same directory as the file you're editing. If you want the tags files to be created in your working directory instead then change Vim's ['cpoptions' option] [cpoptions] to include the lowercase letter 'd'.

The ['tags' option] [tags_opt] is reevaluated each time the plug-in runs, so which tags file is selected can differ depending on the buffer and working directory.

@@ -360,6 +362,7 @@ Thanks go out to everyone who has helped to improve the vim-easytags plug-in (wh
[98]: https://github.com/xolox/vim-easytags/issues/98
[canon]: http://en.wikipedia.org/wiki/Canonicalization
[code_complete]: http://www.vim.org/scripts/script.php?script_id=1764
[cpoptions]: http://vimdoc.sourceforge.net/htmldoc/options.html#'cpoptions'
[ctags]: http://en.wikipedia.org/wiki/Ctags
[ctags_cfg]: http://ctags.sourceforge.net/ctags.html#FILES
[ctags_fts]: http://ctags.sourceforge.net/languages.html


+ 2
- 2
autoload/xolox/easytags.vim View File

@@ -1,9 +1,9 @@
" Vim script
" Author: Peter Odding <peter@peterodding.com>
" Last Change: March 15, 2015
" Last Change: April 14, 2015
" URL: http://peterodding.com/code/vim/easytags/

let g:xolox#easytags#version = '3.10'
let g:xolox#easytags#version = '3.10.1'
let g:xolox#easytags#default_pattern_prefix = '\C\<'
let g:xolox#easytags#default_pattern_suffix = '\>'



+ 7
- 2
doc/easytags.txt View File

@@ -292,10 +292,15 @@ plug-in falls back to the global tags file (or a file type specific tags file).

If you set |g:easytags_dynamic_files| to 2 the easytags plug-in will
automatically create a project specific tags file based on the first name in
the 'tags' option. In this mode the global tags file and/or file type specific
tags files are only used for directories where you don't have write
the |'tags'| option. In this mode the global tags file and/or file type
specific tags files are only used for directories where you don't have write
permissions.

When you set |g:easytags_dynamic_files| to 2 new tags files are created in the
same directory as the file you're editing. If you want the tags files to be
created in your working directory instead then change Vim's |'cpoptions'|
option to include the lowercase letter 'd'.

The |'tags'| option is reevaluated each time the plug-in runs, so which tags
file is selected can differ depending on the buffer and working directory.



Loading…
Cancel
Save