Mercurial > vim-gutentags
comparison doc/gutentags.txt @ 132:a6ef1c860d07
Add support for custom root finders like `vim-projectroot`.
| author | Ludovic Chabant <ludovic@chabant.com> |
|---|---|
| date | Wed, 20 Jul 2016 12:22:51 +0200 |
| parents | 48045d81f25a |
| children | 286e5b3095d0 |
comparison
equal
deleted
inserted
replaced
| 131:ec57d6a14486 | 132:a6ef1c860d07 |
|---|---|
| 258 is opened inside one of those projects, Gutentags | 258 is opened inside one of those projects, Gutentags |
| 259 won't be activated. This is similar to placing | 259 won't be activated. This is similar to placing |
| 260 a `.notags` file in the root of those projects, but | 260 a `.notags` file in the root of those projects, but |
| 261 can be useful when you don't want to, or can't, place | 261 can be useful when you don't want to, or can't, place |
| 262 such a file there. | 262 such a file there. |
| 263 Defaults to ['/usr/local'], which is the folder where | 263 Defaults to `['/usr/local']`, which is the folder where |
| 264 Homebrew is known to create a Git directory by default | 264 Homebrew is known to create a Git directory by default |
| 265 on MacOS. | 265 on MacOS. |
| 266 | |
| 267 *gutentags_project_root_finder* | |
| 268 g:gutentags_project_root_finder | |
| 269 When a buffer is loaded, Gutentags uses a default | |
| 270 (internal) implementation to find that file's | |
| 271 project's root directory, using settings like | |
| 272 |g:gutentags_project_root|. When you specify | |
| 273 |g:gutentags_project_root_finder|, you can tell | |
| 274 Gutentags to use a custom implementation, such as | |
| 275 `vim-projectroot`. The value of this setting must be | |
| 276 the name of a function that takes a single string | |
| 277 argument (the path to the current buffer's file) and | |
| 278 returns a string value (the project's root directory). | |
| 279 Defaults to `''`. | |
| 280 Note: when set, the called implementation will most | |
| 281 likely ignore |g:gutentags_project_root|. | |
| 266 | 282 |
| 267 *gutentags_exclude* | 283 *gutentags_exclude* |
| 268 g:gutentags_exclude | 284 g:gutentags_exclude |
| 269 A list of file patterns to pass to the | 285 A list of file patterns to pass to the |
| 270 |gutentags_ctags_executable| so that they will be | 286 |gutentags_ctags_executable| so that they will be |