aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPeter Odding <peter@peterodding.com>2015-04-14 22:18:52 +0200
committerPeter Odding <peter@peterodding.com>2015-04-14 22:18:52 +0200
commita339a8c4409f547e3e2bfd1e1c48975536935b46 (patch)
tree85a94b114340c9d8deee1809f846ac80c317ebdf
parentda53e3b70c2e1a98d04ab548997e1b882c8cf41a (diff)
downloadvim-easytags-a339a8c4409f547e3e2bfd1e1c48975536935b46.tar.gz
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
-rw-r--r--README.md5
-rw-r--r--autoload/xolox/easytags.vim4
-rw-r--r--doc/easytags.txt9
3 files changed, 13 insertions, 5 deletions
diff --git a/README.md b/README.md
index 4c80ace..a2e0e1f 100644
--- a/README.md
+++ b/README.md
@@ -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
diff --git a/autoload/xolox/easytags.vim b/autoload/xolox/easytags.vim
index b328e19..1f535ca 100644
--- a/autoload/xolox/easytags.vim
+++ b/autoload/xolox/easytags.vim
@@ -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 = '\>'
diff --git a/doc/easytags.txt b/doc/easytags.txt
index 0b1af2b..1aa71ee 100644
--- a/doc/easytags.txt
+++ b/doc/easytags.txt
@@ -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.