Mercurial > vim-gutentags

comparison doc/gutentags.txt @ 89:8bf96f9f649c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add support for project types.
author Ludovic Chabant <ludovic@chabant.com>
date Tue, 01 Dec 2015 22:04:45 -0800
parents 073e63cc0456
children 54355724204b
comparison
equal deleted inserted replaced
88:073e63cc0456 89:8bf96f9f649c
222 g:gutentags_ctags_executable 222 g:gutentags_ctags_executable
223 Specifies the ctags executable to launch. 223 Specifies the ctags executable to launch.
224 Defaults to `ctags`. 224 Defaults to `ctags`.
225 225
226 *gutentags_ctags_executable_{filetype}* 226 *gutentags_ctags_executable_{filetype}*
227 g:gutentags_ctags_executable_{filetype} 227 g:gutentags_ctags_executable_{type}
228 Specifies the ctags executable to launch for 228 Specifies the ctags executable to launch for a project
229 {filetype} files. It has precedence over 229 of type {type}. See |gutentags_project_info| for more
230 g:gutentags_ctags_executable. 230 information.
231 Example: > 231 Example: >
232 let g:gutentags_ctags_executable_ruby = 'ripper-tags' 232 let g:gutentags_ctags_executable_ruby = 'ripper-tags'
233 < 233 <
234 234
235 *gutentags_tagfile* 235 *gutentags_tagfile*
352 *gutentags_define_advanced_commands* 352 *gutentags_define_advanced_commands*
353 g:gutentags_define_advanced_commands 353 g:gutentags_define_advanced_commands
354 Defines some advanced commands like 354 Defines some advanced commands like
355 |GutentagsToggleEnabled| and |GutentagsUnlock|. 355 |GutentagsToggleEnabled| and |GutentagsUnlock|.
356 356
357 *gutentags_project_info*
358 g:gutentags_project_info
359 Defines ways for Gutentags to figure out what kind of
360 project any given file belongs to. This should be
361 a list of dictionaries:
362
363 let g:gutentags_project_info = []
364 call add(g:gutentags_project_info, {...})
365
366 Each dictionary item must contain at least a `type`
367 key, indicating the type of project:
368
369 {"type": "python"}
370
371 Other items will be used to figure out if a project is
372 of the given type.
373
374 "file": any existing file with this path (relative to
375 the project root) will make the current project match
376 the given info.
377
378 "glob": any result found with this glob pattern
379 (relative to the project root) will make the current
380 project match the given info. See |glob()| for more
381 information.
382
383 Gutentags adds by default the following definitions:
384
385 call add(g:gutentags_project_info, {'type': 'python', 'file': 'setup.py'})
386 call add(g:gutentags_project_info, {'type': 'ruby', 'file': 'Gemfile'})
387
388 This means, for example, that you can use
389 `g:gutentags_ctags_executable_ruby` out of the box.
390 See |gutentags_ctags_executable_{filetype}| for more
391 information.
392
357 393
358 ============================================================================= 394 =============================================================================
359 5. Project Settings *gutentags-project-settings* 395 5. Project Settings *gutentags-project-settings*
360 396
361 Gutentags can be customized to some extent on a per-project basis with the 397 Gutentags can be customized to some extent on a per-project basis with the