Mercurial > vim-gutentags

comparison doc/gutentags.txt @ 74:cb1cf815052e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix the documentation about the project settings file.
author Ludovic Chabant <ludovic@chabant.com>
date Sat, 18 Jul 2015 08:52:14 -0700
parents 6900302dae0b
children 0424970d81f8
comparison
equal deleted inserted replaced
73:130905a7fb9a 74:cb1cf815052e
339 5. Project Settings *gutentags-project-settings* 339 5. Project Settings *gutentags-project-settings*
340 340
341 Gutentags can be customized to some extent on a per-project basis with the 341 Gutentags can be customized to some extent on a per-project basis with the
342 following files present in the project root directory: 342 following files present in the project root directory:
343 343
344 *gutentags-.ctags* 344 *gutentags-.gutctags*
345 `.ctags`: if this file exists, Ctags will be told to load additional 345 `.gutctags`: if this file exists, Ctags will be told to load additional
346 command-line parameters by reading it line by line (see the Ctags 346 command-line parameters by reading it line by line (see the Ctags
347 documentation for more information). 347 documentation for more information).
348 348
349 Note that for complex reasons, Gutentags can't always run `ctags` from the 349 Note that for complex reasons, Gutentags can't run `ctags` from the project
350 project root, so if the `.ctags` file exists, its path will actually be passed 350 root if you're using |gutentags_cache_dir|, so if the `.gutctags` file exists,
351 through the `--options=` parameter. 351 it will be pre-processed in order to make all `--exclude=` clauses into
352 absolute paths (by prepending the project root). The resulting file will be
353 saved into the cache directory, and passed to `ctags` via the `--options=`
354 parameter. If you're _not_ using |gutentags_cache_dir|, the `.gutctags` file
355 is _not_ pre-processed, and is passed as-is via the `--options=` parameter.
352 356
353 *gutentags-.notags* 357 *gutentags-.notags*
354 `.notags`: if this file exists, Gutentags will be disabled completely for that 358 `.notags`: if this file exists, Gutentags will be disabled completely for that
355 project. 359 project.
356 360