changeset 222:34aa86c552db

Add documentation about `gutentags_trace`.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 04 Nov 2018 00:36:56 -0700
parents 93c492ed3d62
children a746af898281
files doc/gutentags.txt
diffstat 1 files changed, 15 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/doc/gutentags.txt	Sat Nov 03 23:56:50 2018 -0700
+++ b/doc/gutentags.txt	Sun Nov 04 00:36:56 2018 -0700
@@ -266,7 +266,21 @@
                         re-enable Gutentags, you won't have some buffers
                         mysteriously working while others (those open last)
                         don't.
-                        Defaults to 1.
+                        Defaults to `1`.
+
+                                                *gutentags_trace*
+g:gutentags_trace
+                        When true, Gutentags will spit out debugging
+                        information as Vim messages (which you can later read
+                        with |:messages|). It also runs its background scripts
+                        with extra parameters to log activity to a `tags.log`
+                        file that you can also inspect for more information.
+
+                        Note: you can run `:verbose GutentagsUpdate` to
+                        temporarily set |g:gutentags_trace| to `1` for that
+                        update only.
+
+                        Defaults to `0`.
 
                                                 *gutentags_dont_load*
 g:gutentags_dont_load