diff doc/gutentags.txt @ 128:e673026faa56

Add option to not append the default project root markers.
author Ludovic Chabant <ludovic@chabant.com>
date Mon, 13 Jun 2016 19:25:52 -0700
parents e2a43c03da79
children 48045d81f25a
line wrap: on
line diff
--- a/doc/gutentags.txt	Mon Jun 13 19:15:17 2016 -0700
+++ b/doc/gutentags.txt	Mon Jun 13 19:25:52 2016 -0700
@@ -239,9 +239,18 @@
                         file named after |gutentags_tagfile| will be created at
                         the project root.
                         Defaults to `[]` (an empty |List|).
-                        A list of default markers will always be appended to
-                        the user-defined ones: ['.git', '.hg', '.bzr',
-                        '_darcs'].
+                        A list of default markers will be appended to the
+                        user-defined ones unless
+                        |gutentags_add_default_project_roots| is set to 0.
+                        
+                                            *gutentags_add_default_project_roots*
+g:gutentags_add_default_project_roots
+                        Defines whether Gutentags should always define some
+                        default project roots (see |gutentags_project_root|).
+                        This can be useful to prevent unnecessary disk access
+                        when Gutentags searches for a project root.
+                        The default markers are:
+                        `['.git', '.hg', '.bzr', '_darcs', '_darcs', '_FOSSIL_', '.fslckout']`
 
                                                 *gutentags_exclude_project_root*
 g:gutentags_exclude_project_root