Mercurial > vim-gutentags

comparison doc/gutentags.txt @ 165:cbc1ebe23ef1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Rename all ctags-related options to have "ctags" in their name. Add some stuff to handle old options so it doesn't break everybody.
author Ludovic Chabant <ludovic@chabant.com>
date Sat, 18 Feb 2017 18:21:35 -0800
parents f915393ff68d
children 2489b4b54d5c
comparison
equal deleted inserted replaced
164:28d4dae03f2a 165:cbc1ebe23ef1
115 If you want to force-disable Gutentags for a given project even though it does 115 If you want to force-disable Gutentags for a given project even though it does
116 match one of the items in |gutentags_project_root|, create a file named 116 match one of the items in |gutentags_project_root|, create a file named
117 "`.notags`" at the root of the project. 117 "`.notags`" at the root of the project.
118 118
119 The tag file that Gutentags creates and manages will be named after 119 The tag file that Gutentags creates and manages will be named after
120 |gutentags_tagfile|, relative to the project's root directory. When Gutentags 120 |gutentags_ctags_tagfile|, relative to the project's root directory. When
121 finds a valid project root, it will prepend the tag file's path to 'tags', 121 Gutentags finds a valid project root, it will prepend the tag file's path to
122 unless |gutentags_auto_set_tags| is set to 0. This is to make sure Vim will use 122 'tags', unless |gutentags_ctags_auto_set_tags| is set to 0. This is to make
123 that file first. 123 sure Vim will use that file first.
124 124
125 If a file managed by Gutentags is opened and no tag file already exists, 125 If a file managed by Gutentags is opened and no tag file already exists,
126 Gutentags will start generating it right away in the background, unless 126 Gutentags will start generating it right away in the background, unless
127 |gutentags_generate_on_missing| is set to 0. If you have a large project, you 127 |gutentags_generate_on_missing| is set to 0. If you have a large project, you
128 may want to know when Gutentags is generating tags: see 128 may want to know when Gutentags is generating tags: see
252 IMPORTANT: please see |gutentags-ctags-requirements|. 252 IMPORTANT: please see |gutentags-ctags-requirements|.
253 Example: > 253 Example: >
254 let g:gutentags_ctags_executable_ruby = 'foobar' 254 let g:gutentags_ctags_executable_ruby = 'foobar'
255 < 255 <
256 256
257 *gutentags_tagfile* 257 *gutentags_ctags_tagfile*
258 g:gutentags_tagfile 258 g:gutentags_ctags_tagfile
259 Specifies the name of the tag file to create. This 259 Specifies the name of the tag file to create. This
260 will be appended to the project's root. See 260 will be appended to the project's root. See
261 |gutentags_project_root| for how Gutentags locates the 261 |gutentags_project_root| for how Gutentags locates the
262 project. 262 project.
263 Defaults to `tags`. 263 Defaults to `tags`.
268 it's part of a project that should have tags managed 268 it's part of a project that should have tags managed
269 automatically. To do this, it looks for "root markers" 269 automatically. To do this, it looks for "root markers"
270 in the current file's directory and its parent 270 in the current file's directory and its parent
271 directories. If it finds any of those markers, 271 directories. If it finds any of those markers,
272 Gutentags will be enabled for the project, and a tags 272 Gutentags will be enabled for the project, and a tags
273 file named after |gutentags_tagfile| will be created at 273 file named after |gutentags_ctags_tagfile| will be
274 the project root. 274 created at the project root.
275 Defaults to `[]` (an empty |List|). 275 Defaults to `[]` (an empty |List|).
276 A list of default markers will be appended to the 276 A list of default markers will be appended to the
277 user-defined ones unless 277 user-defined ones unless
278 |gutentags_add_default_project_roots| is set to 0. 278 |gutentags_add_default_project_roots| is set to 0.
279 279
312 returns a string value (the project's root directory). 312 returns a string value (the project's root directory).
313 Defaults to `''`. 313 Defaults to `''`.
314 Note: when set, the called implementation will most 314 Note: when set, the called implementation will most
315 likely ignore |g:gutentags_project_root|. 315 likely ignore |g:gutentags_project_root|.
316 316
317 *gutentags_exclude* 317 *gutentags_ctags_exclude*
318 g:gutentags_exclude 318 g:gutentags_ctags_exclude
319 A list of file patterns to pass to the 319 A list of file patterns to pass to the
320 |gutentags_ctags_executable| so that they will be 320 |gutentags_ctags_executable| so that they will be
321 excluded from parsing for the tags generation. 321 excluded from parsing for the tags generation.
322 Defaults to `[]` (an empty |List|). Patterns defined 322 See also |gutentags_ctags_exclude_wildignore|.
323 in 'wildignore' will also be given as exclude patterns 323 Defaults to `[]` (an empty |List|).
324 to the `ctags` executable. 324
325 325 *gutentags_ctags_exclude_wildignore*
326 *gutentags_auto_set_tags* 326 g:gutentags_ctags_exclude_wildignore
327 g:gutentags_auto_set_tags 327 When 1, Gutentags will automatically pass your
328 'wildignore' file patterns to the
329 |gutentags_ctags_executable| so that they are ignored.
330 Set also |gutentags_ctags_exclude| to pass custom
331 patterns.
332 Defaults to 1.
333
334 *gutentags_ctags_auto_set_tags*
335 g:gutentags_ctags_auto_set_tags
328 If set to 1, Gutentags will automatically prepend 336 If set to 1, Gutentags will automatically prepend
329 'tags' with the exact path to the tag file for the 337 'tags' with the exact path to the tag file for the
330 current project. See |gutentags_project_root| for how 338 current project. See |gutentags_project_root| for how
331 Gutentags locates the project. 339 Gutentags locates the project.
332 When set to 0, Gutentags doesn't change 'tags', and 340 When set to 0, Gutentags doesn't change 'tags', and
408 be enabled for that file. 416 be enabled for that file.
409 417
410 You can use this to manually set buffer-local 418 You can use this to manually set buffer-local
411 settings: 419 settings:
412 420
413 * `b:gutentags_tagfile` (see |gutentags_tagfile|). 421 * `b:gutentags_ctags_tagfile` (see |gutentags_ctags_tagfile|).
414 422
415 This setting was previously called 423 This setting was previously called
416 `gutentags_enabled_user_func`. The old setting is 424 `gutentags_enabled_user_func`. The old setting is
417 still used as a fallback. 425 still used as a fallback.
418 426