Skip to content

Commit a339a8c

Browse files
committed
Improve documentation of `easytags_dynamic_files' option
See also issue 92 and issue 116 on GitHub: - #92 - #116
1 parent da53e3b commit a339a8c

File tree

3 files changed

+13
-5
lines changed

3 files changed

+13
-5
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,9 @@ By default `:UpdateTags` only writes to the global tags file, but it can be conf
121121

122122
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).
123123

124-
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.
124+
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.
125+
126+
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'.
125127

126128
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.
127129

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

autoload/xolox/easytags.vim

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
" Vim script
22
" Author: Peter Odding <peter@peterodding.com>
3-
" Last Change: March 15, 2015
3+
" Last Change: April 14, 2015
44
" URL: http://peterodding.com/code/vim/easytags/
55

6-
let g:xolox#easytags#version = '3.10'
6+
let g:xolox#easytags#version = '3.10.1'
77
let g:xolox#easytags#default_pattern_prefix = '\C\<'
88
let g:xolox#easytags#default_pattern_suffix = '\>'
99

doc/easytags.txt

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -292,10 +292,15 @@ plug-in falls back to the global tags file (or a file type specific tags file).
292292

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

299+
When you set |g:easytags_dynamic_files| to 2 new tags files are created in the
300+
same directory as the file you're editing. If you want the tags files to be
301+
created in your working directory instead then change Vim's |'cpoptions'|
302+
option to include the lowercase letter 'd'.
303+
299304
The |'tags'| option is reevaluated each time the plug-in runs, so which tags
300305
file is selected can differ depending on the buffer and working directory.
301306

0 commit comments

Comments
 (0)