comparison doc/gutentags.txt @ 278:abc91c5fb795

Include override warning in docs for `.gutctags`
author Michael van der Kamp <40647401+mvanderkamp@users.noreply.github.com>
date Sun, 09 Apr 2023 10:38:14 -0700
parents edd757c1e28d
children 4353f0dc8d99
comparison
equal deleted inserted replaced
277:f75a8cddf174 278:abc91c5fb795
728 following files present in the project root directory: 728 following files present in the project root directory:
729 729
730 *gutentags-.gutctags* 730 *gutentags-.gutctags*
731 `.gutctags`: if this file exists, Ctags will be told to load additional 731 `.gutctags`: if this file exists, Ctags will be told to load additional
732 command-line parameters by reading it line by line (see the Ctags 732 command-line parameters by reading it line by line (see the Ctags
733 documentation for more information). 733 documentation for more information). This will override the default options
734 file, which adds `--recurse=yes`, so unless you are using
735 |gutentags_file_list_command| you will want to include `--recurse=yes` in your
736 `.gutctags` file.
734 737
735 Note that for complex reasons, Gutentags can't run `ctags` from the project 738 Note that for complex reasons, Gutentags can't run `ctags` from the project
736 root if you're using |gutentags_cache_dir|, so if the `.gutctags` file exists, 739 root if you're using |gutentags_cache_dir|, so if the `.gutctags` file exists,
737 it will be pre-processed in order to make all `--exclude=` clauses into 740 it will be pre-processed in order to make all `--exclude=` clauses into
738 absolute paths (by prepending the project root). The resulting file will be 741 absolute paths (by prepending the project root). The resulting file will be