Mercurial > vim-gutentags

comparison doc/gutentags.txt @ 140:95092f4fbc4b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add some cross-referencing to the help file.
author Ludovic Chabant <ludovic@chabant.com>
date Thu, 22 Sep 2016 21:06:58 -0700
parents ed43e3a87ffd
children 7bc4df0225d1 d4c09aa41e80
comparison
equal deleted inserted replaced
139:ed43e3a87ffd 140:95092f4fbc4b
62 multiple ctags processes if you save files too fast, or if your project is 62 multiple ctags processes if you save files too fast, or if your project is
63 really big. 63 really big.
64 64
65 65
66 1.1 Requirements 66 1.1 Requirements
67 *gutentags-ctags-requirements*
67 68
68 If you're using the `ctags` modules (which is the default and only working one 69 If you're using the `ctags` modules (which is the default and only working one
69 at this point, really), you will need a `tags` generator that supports the 70 at this point, really), you will need a `tags` generator that supports the
70 following arguments: 71 following arguments:
71 72
78 old BSD Ctags WON'T WORK. Other language-specific versions may or may not 79 old BSD Ctags WON'T WORK. Other language-specific versions may or may not
79 work. Check with their help or man page. 80 work. Check with their help or man page.
80 81
81 82
82 1.2 Similar Plugins 83 1.2 Similar Plugins
84 *gutentags-similar-plugins*
83 85
84 There are some similar Vim plugins out there ("vim-tags", "vim-autotag", 86 There are some similar Vim plugins out there ("vim-tags", "vim-autotag",
85 "vim-automatic-ctags", etc.). They all fail on one or more of the requirements 87 "vim-automatic-ctags", etc.). They all fail on one or more of the requirements
86 I set for myself with Gutentags: 88 I set for myself with Gutentags:
87 89
233 *gutentags_ctags_executable_{filetype}* 235 *gutentags_ctags_executable_{filetype}*
234 g:gutentags_ctags_executable_{type} 236 g:gutentags_ctags_executable_{type}
235 Specifies the ctags executable to launch for a project 237 Specifies the ctags executable to launch for a project
236 of type {type}. See |gutentags_project_info| for more 238 of type {type}. See |gutentags_project_info| for more
237 information. 239 information.
240 IMPORTANT: piease see |gutentags-ctags-requirements|.
238 Example: > 241 Example: >
239 let g:gutentags_ctags_executable_ruby = 'ripper-tags' 242 let g:gutentags_ctags_executable_ruby = 'foobar'
240 < 243 <
241 244
242 *gutentags_tagfile* 245 *gutentags_tagfile*
243 g:gutentags_tagfile 246 g:gutentags_tagfile
244 Specifies the name of the tag file to create. This 247 Specifies the name of the tag file to create. This