diff doc/gutentags.txt @ 74:cb1cf815052e

Fix the documentation about the project settings file.
author Ludovic Chabant <ludovic@chabant.com>
date Sat, 18 Jul 2015 08:52:14 -0700
parents 6900302dae0b
children 0424970d81f8
line wrap: on
line diff
--- a/doc/gutentags.txt	Thu Jul 16 21:55:28 2015 -0700
+++ b/doc/gutentags.txt	Sat Jul 18 08:52:14 2015 -0700
@@ -341,14 +341,18 @@
 Gutentags can be customized to some extent on a per-project basis with the
 following files present in the project root directory:
 
-                                                *gutentags-.ctags*
-`.ctags`: if this file exists, Ctags will be told to load additional
+                                                *gutentags-.gutctags*
+`.gutctags`: if this file exists, Ctags will be told to load additional
 command-line parameters by reading it line by line (see the Ctags
 documentation for more information).
 
-Note that for complex reasons, Gutentags can't always run `ctags` from the
-project root, so if the `.ctags` file exists, its path will actually be passed
-through the `--options=` parameter.
+Note that for complex reasons, Gutentags can't run `ctags` from the project
+root if you're using |gutentags_cache_dir|, so if the `.gutctags` file exists,
+it will be pre-processed in order to make all `--exclude=` clauses into
+absolute paths (by prepending the project root). The resulting file will be
+saved into the cache directory, and passed to `ctags` via the `--options=`
+parameter. If you're _not_ using |gutentags_cache_dir|, the `.gutctags` file
+is _not_ pre-processed, and is passed as-is via the `--options=` parameter.
 
                                                 *gutentags-.notags*
 `.notags`: if this file exists, Gutentags will be disabled completely for that