Mercurial > vim-gutentags

comparison doc/gutentags.txt @ 232:39df368aaf2a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve docs concerning gtags_cscope module Add missing parameters, fix typos and remove some whitespaces.
author janEbert <jebert@techfak.uni-bielefeld.de>
date Wed, 28 Nov 2018 01:35:38 +0100
parents 34bee0477b51
children 62e21302c221
comparison
equal deleted inserted replaced
231:740cd9065423 232:39df368aaf2a
331 created at the project root. 331 created at the project root.
332 Defaults to `[]` (an empty |List|). 332 Defaults to `[]` (an empty |List|).
333 A list of default markers will be appended to the 333 A list of default markers will be appended to the
334 user-defined ones unless 334 user-defined ones unless
335 |gutentags_add_default_project_roots| is set to 0. 335 |gutentags_add_default_project_roots| is set to 0.
336 336
337 *gutentags_add_default_project_roots* 337 *gutentags_add_default_project_roots*
338 g:gutentags_add_default_project_roots 338 g:gutentags_add_default_project_roots
339 Defines whether Gutentags should always define some 339 Defines whether Gutentags should always define some
340 default project roots (see |gutentags_project_root|). 340 default project roots (see |gutentags_project_root|).
341 This can be useful to prevent unnecessary disk access 341 This can be useful to prevent unnecessary disk access
640 640
641 *gutentags_gtags_executable* 641 *gutentags_gtags_executable*
642 g:gutentags_gtags_executable 642 g:gutentags_gtags_executable
643 Specifies the name or path of the `gtags` executable 643 Specifies the name or path of the `gtags` executable
644 to use to generate the code database. 644 to use to generate the code database.
645 Default to `"gtags"`. 645 Defaults to `"gtags"`.
646
647 *gutentags_gtags_cscope_executable*
648 g:gutentags_gtags_cscope_executable
649 Specifies the name or path of the `gtags-cscope`
650 executable to use to generate the code database.
651 Defaults to `"gtags-cscope"`.
652
653 *gutentags_gtags_dbpath*
654 g:gutentags_gtags_dbpath
655 Path from the cache directory (|gutentags_cache_dir|
656 or project root) to the folder containing the
657 definition database file (usually called `GTAGS`).
658 Defaults to `""`.
646 659
647 *gutentags_gtags_options_file* 660 *gutentags_gtags_options_file*
648 g:gutentags_gtags_options_file 661 g:gutentags_gtags_options_file
649 The name of a file that will be looked for in 662 The name of a file that will be looked for in
650 a project root directory. The file is expected to 663 a project root directory. The file is expected to
658 (see |:cscope|). 671 (see |:cscope|).
659 Defaults to 1. 672 Defaults to 1.
660 673
661 People using `cscope` or `gtags_cscope` across multiple projects in the same 674 People using `cscope` or `gtags_cscope` across multiple projects in the same
662 Vim instance might be interested in the `gutentags_plus` plugin, which handles 675 Vim instance might be interested in the `gutentags_plus` plugin, which handles
663 switching databases automatically before performing a query. 676 switching databases automatically before performing a query.
664 See https://github.com/skywind3000/gutentags_plus. 677 See https://github.com/skywind3000/gutentags_plus.
665 678
666 ============================================================================= 679 =============================================================================
667 5. Project Settings *gutentags-project-settings* 680 5. Project Settings *gutentags-project-settings*
668 681
669 Gutentags can be customized to some extent on a per-project basis with the 682 Gutentags can be customized to some extent on a per-project basis with the
670 following files present in the project root directory: 683 following files present in the project root directory: