changeset 140:95092f4fbc4b

Add some cross-referencing to the help file.
author Ludovic Chabant <ludovic@chabant.com>
date Thu, 22 Sep 2016 21:06:58 -0700
parents ed43e3a87ffd
children 7bc4df0225d1 d4c09aa41e80 e59321cbaff7
files doc/gutentags.txt
diffstat 1 files changed, 4 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/doc/gutentags.txt	Thu Sep 22 20:58:46 2016 -0700
+++ b/doc/gutentags.txt	Thu Sep 22 21:06:58 2016 -0700
@@ -64,6 +64,7 @@
 
 
 1.1 Requirements
+                                                *gutentags-ctags-requirements*
 
 If you're using the `ctags` modules (which is the default and only working one
 at this point, really), you will need a `tags` generator that supports the
@@ -80,6 +81,7 @@
 
 
 1.2 Similar Plugins
+                                                *gutentags-similar-plugins*
 
 There are some similar Vim plugins out there ("vim-tags", "vim-autotag",
 "vim-automatic-ctags", etc.). They all fail on one or more of the requirements
@@ -235,8 +237,9 @@
                         Specifies the ctags executable to launch for a project
                         of type {type}. See |gutentags_project_info| for more
                         information.
+                        IMPORTANT: piease see |gutentags-ctags-requirements|.
                         Example: >
-                         let g:gutentags_ctags_executable_ruby = 'ripper-tags'
+                         let g:gutentags_ctags_executable_ruby = 'foobar'
 <
 
                                                 *gutentags_tagfile*