From a339a8c4409f547e3e2bfd1e1c48975536935b46 Mon Sep 17 00:00:00 2001 From: Peter Odding Date: Tue, 14 Apr 2015 22:18:52 +0200 Subject: 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 --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'README.md') 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 -- cgit v1.2.3