diff doc/gutentags.txt @ 269:e60f685c560d

pycscope
author Oliver Harley <oliver.r.harley@gmail.com>
date Mon, 04 Feb 2019 10:08:25 +0100
parents 2d634600fd6e
children edd757c1e28d
line wrap: on
line diff
--- a/doc/gutentags.txt	Tue Oct 06 19:29:37 2020 +0800
+++ b/doc/gutentags.txt	Mon Feb 04 10:08:25 2019 +0100
@@ -314,6 +314,9 @@
                         - `cscope`: generates a code database file using
                           `cscope`.
 
+                        - `pycscope`: generates a code database file using
+                          `pycscope`.
+
                         - `gtags_cscope`: same as `cscope` but uses GNU's
                           `gtags` executable and database.
 
@@ -661,6 +664,22 @@
                         Defaults to 0.
 
 
+The following settings are valid for the `pycscope` module.
+
+                                                *gutentags_pycscope_executable*
+g:gutentags_pycscope_executable
+                        Specifies the name or path of the `pycscope` executable
+                        to use to generate the code database.
+                        Defaults to `"pycscope"`.
+
+                                                *gutentags_auto_add_pycscope*
+g:gutentags_auto_add_pycscope
+                        If set to 1, Gutentags will automatically add the
+                        generated code database to Vim by running `:cs add`
+                        (see |:pycscope|).
+                        Defaults to 1.
+
+
 The following settings are valid for the `gtags_cscope` module.
 
                                                 *gutentags_gtags_executable*
@@ -696,7 +715,8 @@
                         (see |:cscope|).
                         Defaults to 1.
 
-People using `cscope` or `gtags_cscope` across multiple projects in the same
+
+People using `cscope`, `pycscope` or `gtags_cscope` across multiple projects in the same
 Vim instance might be interested in the `gutentags_plus` plugin, which handles
 switching databases automatically before performing a query.
 See https://github.com/skywind3000/gutentags_plus.