Mercurial > vim-gutentags
diff 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 |
line wrap: on
line diff
--- a/doc/gutentags.txt Wed Jul 20 12:11:13 2016 +0200 +++ b/doc/gutentags.txt Wed Jul 20 12:22:51 2016 +0200 @@ -260,10 +260,26 @@ a `.notags` file in the root of those projects, but can be useful when you don't want to, or can't, place such a file there. - Defaults to ['/usr/local'], which is the folder where + Defaults to `['/usr/local']`, which is the folder where Homebrew is known to create a Git directory by default on MacOS. + *gutentags_project_root_finder* +g:gutentags_project_root_finder + When a buffer is loaded, Gutentags uses a default + (internal) implementation to find that file's + project's root directory, using settings like + |g:gutentags_project_root|. When you specify + |g:gutentags_project_root_finder|, you can tell + Gutentags to use a custom implementation, such as + `vim-projectroot`. The value of this setting must be + the name of a function that takes a single string + argument (the path to the current buffer's file) and + returns a string value (the project's root directory). + Defaults to `''`. + Note: when set, the called implementation will most + likely ignore |g:gutentags_project_root|. + *gutentags_exclude* g:gutentags_exclude A list of file patterns to pass to the