comparison doc/gutentags.txt @ 47:7b419abf7fba

Add ability to disable Gutentags if a `.notags` file is at the root.
author Ludovic Chabant <ludovic@chabant.com>
date Thu, 09 Apr 2015 21:14:18 -0700
parents c0f56e4d52bd
children 70423c2202c5
comparison
equal deleted inserted replaced
46:c0f56e4d52bd 47:7b419abf7fba
100 |gutentags_project_root| for how Gutentags figures out the project a file 100 |gutentags_project_root| for how Gutentags figures out the project a file
101 belongs to. When not project is found (i.e. the file is not under any of the 101 belongs to. When not project is found (i.e. the file is not under any of the
102 known project markers), Gutentags is disabled for that buffer, and the 102 known project markers), Gutentags is disabled for that buffer, and the
103 following commands and remarks don't apply. 103 following commands and remarks don't apply.
104 104
105 If you want to force-disable Gutentags for a given project even though it does
106 match one of the items in |gutentags_project_root|, create a file named
107 "`.notags`" at the root of the project.
108
105 The tag file that Gutentags creates and manages will be named after 109 The tag file that Gutentags creates and manages will be named after
106 |gutentags_tagfile|, relative to the project's root directory. When Gutentags 110 |gutentags_tagfile|, relative to the project's root directory. When Gutentags
107 finds a valid project root, it will prepend the tag file's path to 'tags', 111 finds a valid project root, it will prepend the tag file's path to 'tags',
108 unless |gutentags_auto_set_tags| is set to 0. This is to make sure Vim will use 112 unless |gutentags_auto_set_tags| is set to 0. This is to make sure Vim will use
109 that file first. 113 that file first.