vim-gutentags: doc/gutentags.txt annotate

annotate doc/gutentags.txt @ 222:34aa86c552db

Add documentation about `gutentags_trace`.

author	Ludovic Chabant <ludovic@chabant.com>
date	Sun, 04 Nov 2018 00:36:56 -0700
parents	d7fdcb1c6a65
children	a746af898281

rev	line source
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	1 gutentags.txt Automatic ctags management for VIM
188 676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	2 ___ ___ ___ ___ ___
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	3 /\__\ /\ \ /\__\ /\__\ /\ \
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	4 /:/ _/_ \:\ \ /:/ / /:/ _/_ \:\ \
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	5 /:/ /\ \ \:\ \ /:/__/ /:/ /\__\ \:\ \
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	6 /:/ /::\ \ ___ \:\ \ /::\ \ /:/ /:/ _/_ _____\:\ \
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	7 /:/__\/\:\__\ /\ \ \:\__\ /:/\:\ \ /:/_/:/ /\__\ /::::::::\__\
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	8 \:\ \ /:/ / \:\ \ /:/ / \/__\:\ \ \:\/:/ /:/ / \:\~~\~~\/__/
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	9 \:\ /:/ / \:\ /:/ / \:\__\ \::/_/:/ / \:\ \
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	10 \:\/:/ / \:\/:/ / \/__/ \:\/:/ / \:\ \
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	11 \::/ / \::/ / \::/ / \:\__\
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	12 \/__/ \/__/ \/__/ \/__/
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	13 ___ ___ ___ ___
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	14 /\__\ /\ \ /\__\ /\__\
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	15 /:/ / /::\ \ /:/ _/_ /:/ _/_
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	16 /:/__/ /:/\:\ \ /:/ /\ \ /:/ /\ \
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	17 /::\ \ /:/ /::\ \ /:/ /::\ \ /:/ /::\ \
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	18 /:/\:\ \ /:/_/:/\:\__\ /:/__\/\:\__\ /:/_/:/\:\__\
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	19 \/__\:\ \ \:\/:/ \/__/ \:\ \ /:/ / \:\/:/ /:/ /
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	20 \:\__\ \::/__/ \:\ /:/ / \::/ /:/ /
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	21 \/__/ \:\ \ \:\/:/ / \/_/:/ /
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	22 \:\__\ \::/ / /:/ /
676fe2ea919f Move T's in the ASCII art up a bit. Toni Kunic <tkunic@rocketmail.com> parents: 182 diff changeset	23 \/__/ \/__/ \/__/
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	24
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	25
24 bab5f37faa1e More renaming. Ludovic Chabant <ludovic@chabant.com> parents: 22 diff changeset	26 GUTENTAGS REFERENCE MANUAL
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	27 by Ludovic Chabant
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	28
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	29 gutentags
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	30
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	31 1. Introduction \|gutentags-intro\|
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	32 2. Commands \|gutentags-commands\|
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	33 3. Status Line \|gutentags-status-line\|
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	34 4. Global Settings \|gutentags-settings\|
49 70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	35 5. Project Settings \|gutentags-project-settings\|
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	36
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	37 =============================================================================
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	38 1. Introduction gutentags-intro
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	39
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	40 Gutentags is a plugin that takes care of the much needed management of tags
7 49e3cb99ab27 Small edits. Ludovic Chabant <ludovic@chabant.com> parents: 4 diff changeset	41 files in Vim. It will (re)generate tag files as you work while staying
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	42 completely out of your way. It will even do its best to keep those tag files
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	43 out of your way too. It has no dependencies and just works.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	44
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	45 In order to generate tag files, Gutentags will have to figure out what's in
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	46 your project. To do this, it will locate well-known project root markers like
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	47 SCM folders (.git, .hg, etc.), any custom tags you define (with
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	48 \|gutentags_project_root\|), and even things you may have defined already with
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	49 other plugins, like CtrlP.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	50
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	51 If the current file you're editing is found to be in such a project, Gutentags
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	52 will make sure the tag file for that project is up to date. Then, as you work
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	53 in files in that project, it will partially re-generate the tag file. Every
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	54 time you save, it will silently, in the background, update the tags for that
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	55 file.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	56
129 48045d81f25a Fix some typos in the docs. Ludovic Chabant <ludovic@chabant.com> parents: 128 diff changeset	57 Usually, `ctags` can only append tags to an existing tag file, so Gutentags
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	58 removes the tags for the current file first, to make sure the tag file is
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	59 always consistent with the source code.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	60
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	61 Also, Gutentags is clever enough to not stumble upon itself by triggering
139 ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	62 multiple ctags processes if you save files too fast, or if your project is
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	63 really big.
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	64
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	65
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	66 1.1 Requirements
140 95092f4fbc4b Add some cross-referencing to the help file. Ludovic Chabant <ludovic@chabant.com> parents: 139 diff changeset	67 gutentags-ctags-requirements
139 ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	68
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	69 If you're using the `ctags` modules (which is the default and only working one
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	70 at this point, really), you will need a `tags` generator that supports the
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	71 following arguments:
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	72
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	73 * `-f` (to specify the output file)
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	74 * `--append` (to append to an existing file while keeping it sorted)
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	75 * `--exclude` (to exclude file patterns)
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	76 * `--options` (to specify an options file)
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	77
190 6dc4bb6c53ba minor typos minusf <minusf@gmail.com> parents: 188 diff changeset	78 This means you probably want Exuberant Ctags or Universal Ctags. The basic
139 ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	79 old BSD Ctags WON'T WORK. Other language-specific versions may or may not
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	80 work. Check with their help or man page.
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	81
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	82
ed43e3a87ffd Add `ctags` executable requirements to the documentation page. Ludovic Chabant <ludovic@chabant.com> parents: 138 diff changeset	83 1.2 Similar Plugins
140 95092f4fbc4b Add some cross-referencing to the help file. Ludovic Chabant <ludovic@chabant.com> parents: 139 diff changeset	84 gutentags-similar-plugins
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	85
7 49e3cb99ab27 Small edits. Ludovic Chabant <ludovic@chabant.com> parents: 4 diff changeset	86 There are some similar Vim plugins out there ("vim-tags", "vim-autotag",
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	87 "vim-automatic-ctags", etc.). They all fail on one or more of the requirements
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	88 I set for myself with Gutentags:
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	89
7 49e3cb99ab27 Small edits. Ludovic Chabant <ludovic@chabant.com> parents: 4 diff changeset	90 * No other dependency than running Vim: no Python, Ruby, or whatever.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	91 * Cross-platform: should work on at least Mac and Windows.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	92 * Incremental tags generation: don't re-generate the whole project all the
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	93 time. This may be fine for small projects, but it doesn't scale.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	94 * External process management: if the ctags process is taking a long time,
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	95 don't run another one because I saved the file again.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	96 * Keep the tag file consistent: don't just append the current file's tags to
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	97 the tag file, otherwise you will still "see" tags for deleted or renamed
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	98 classes and functions.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	99 * Automatically create the tag file: you open something from a freshly forked
129 48045d81f25a Fix some typos in the docs. Ludovic Chabant <ludovic@chabant.com> parents: 128 diff changeset	100 project, it should start indexing it automatically, just like in Sublime Text
48045d81f25a Fix some typos in the docs. Ludovic Chabant <ludovic@chabant.com> parents: 128 diff changeset	101 or Visual Studio or any other IDE.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	102
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	103
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	104 =============================================================================
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	105 2. Commands gutentags-commands
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	106
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	107 gutentags-project-commands
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	108 The following commands are only available in buffers that have been found to
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	109 belong to a project that should be managed by Gutentags. See
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	110 \|gutentags_project_root\| for how Gutentags figures out the project a file
142 d4c09aa41e80 Typo nblock <nblock@users.noreply.github.com> parents: 140 diff changeset	111 belongs to. When no project is found (i.e. the file is not under any of the
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	112 known project markers), Gutentags is disabled for that buffer, and the
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	113 following commands and remarks don't apply.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	114
47 7b419abf7fba Add ability to disable Gutentags if a `.notags` file is at the root. Ludovic Chabant <ludovic@chabant.com> parents: 46 diff changeset	115 If you want to force-disable Gutentags for a given project even though it does
7b419abf7fba Add ability to disable Gutentags if a `.notags` file is at the root. Ludovic Chabant <ludovic@chabant.com> parents: 46 diff changeset	116 match one of the items in \|gutentags_project_root\|, create a file named
7b419abf7fba Add ability to disable Gutentags if a `.notags` file is at the root. Ludovic Chabant <ludovic@chabant.com> parents: 46 diff changeset	117 "`.notags`" at the root of the project.
7b419abf7fba Add ability to disable Gutentags if a `.notags` file is at the root. Ludovic Chabant <ludovic@chabant.com> parents: 46 diff changeset	118
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	119 The tag file that Gutentags creates and manages will be named after
165 cbc1ebe23ef1 Rename all ctags-related options to have "ctags" in their name. Ludovic Chabant <ludovic@chabant.com> parents: 149 diff changeset	120 \|gutentags_ctags_tagfile\|, relative to the project's root directory. When
cbc1ebe23ef1 Rename all ctags-related options to have "ctags" in their name. Ludovic Chabant <ludovic@chabant.com> parents: 149 diff changeset	121 Gutentags finds a valid project root, it will prepend the tag file's path to
cbc1ebe23ef1 Rename all ctags-related options to have "ctags" in their name. Ludovic Chabant <ludovic@chabant.com> parents: 149 diff changeset	122 'tags', unless \|gutentags_ctags_auto_set_tags\| is set to 0. This is to make
cbc1ebe23ef1 Rename all ctags-related options to have "ctags" in their name. Ludovic Chabant <ludovic@chabant.com> parents: 149 diff changeset	123 sure Vim will use that file first.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	124
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	125 If a file managed by Gutentags is opened and no tag file already exists,
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	126 Gutentags will start generating it right away in the background, unless
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	127 \|gutentags_generate_on_missing\| is set to 0. If you have a large project, you
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	128 may want to know when Gutentags is generating tags: see
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	129 \|gutentags-status-line\| to display an indicator in your status line.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	130
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	131 When a file managed by Gutentags is saved, the tag file will be incrementally
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	132 updated, i.e. references to the recently saved file are removed, and that file
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	133 is re-parsed for tags, with the result being merged into the tag file. This
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	134 makes the tag file 100% consistent with the latest changes. This doesn't
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	135 happen however if \|gutentags_generate_on_write\| is set to 0, in which case you
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	136 have to run \|GutentagsUpdate\| manually.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	137
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	138
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	139 :GutentagsUpdate
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	140 :GutentagsUpdate
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	141 Forces an update of the current tag file with the
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	142 current buffer. If tags are already being generated,
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	143 you will be notified and the command will abort.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	144
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	145 :GutentagsUpdate!
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	146 Like \|GutentagsUpdate\|, but updates the current tags
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	147 file with the whole project instead of just the
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	148 current buffer.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	149
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	150
46 c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 43 diff changeset	151 Some debugging/troubleshooting commands are also available if the
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 43 diff changeset	152 \|gutentags_define_advanced_commands\| global setting is set to 1.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	153
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	154 :GutentagsToggleEnabled
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	155 :GutentagsToggleEnabled
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	156 Disables and re-enables Gutentags.
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	157 When Gutentags is disabled, it won't update your tag
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	158 file when you save a buffer. It will however still
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	159 look for project markers as you open new buffers so
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	160 that they can start working again when you re-enable
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	161 Gutentags.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	162
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	163 GutentagsToggleTrace
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	164 :GutentagsToggleTrace
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	165 If you want to keep an eye on what Gutentags is doing,
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	166 you can enable tracing. This will show messages every
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	167 time Gutentags does something. It can get annoying
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	168 quickly, since it will require you to press a key to
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	169 dismiss those messages, but it can be useful to
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	170 troubleshoot a problem.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	171 In addition to messages in Vim, it will also make
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	172 Gutentags redirect the output of the tag generation
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	173 script to a `.log` file in the project root.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	174
49 70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	175
191 22cd3334cf43 Add documentation on the `GutentagsUpdated` auto-command. Ludovic Chabant <ludovic@chabant.com> parents: 190 diff changeset	176 Gutentags also has some user auto-commands (see \|User\| and \|:doautocmd\|):
22cd3334cf43 Add documentation on the `GutentagsUpdated` auto-command. Ludovic Chabant <ludovic@chabant.com> parents: 190 diff changeset	177
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	178 GutentagsUpdating
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	179 GutentagsUpdating
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	180 This auto-command is triggered when a background
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	181 update job has started.
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	182
191 22cd3334cf43 Add documentation on the `GutentagsUpdated` auto-command. Ludovic Chabant <ludovic@chabant.com> parents: 190 diff changeset	183 GutentagsUpdated
22cd3334cf43 Add documentation on the `GutentagsUpdated` auto-command. Ludovic Chabant <ludovic@chabant.com> parents: 190 diff changeset	184 GutentagsUpdated
22cd3334cf43 Add documentation on the `GutentagsUpdated` auto-command. Ludovic Chabant <ludovic@chabant.com> parents: 190 diff changeset	185 This auto-command is triggered when a background
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	186 update job has finished.
191 22cd3334cf43 Add documentation on the `GutentagsUpdated` auto-command. Ludovic Chabant <ludovic@chabant.com> parents: 190 diff changeset	187
22cd3334cf43 Add documentation on the `GutentagsUpdated` auto-command. Ludovic Chabant <ludovic@chabant.com> parents: 190 diff changeset	188
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	189 =============================================================================
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	190 3. Status Line gutentags-status-line
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	191
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	192 Tag file generation can take a while if you're working on a project big
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	193 enough. In that case, you may want to know when `ctags` is running, so you
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	194 have a heads up if some of the tags aren't recognized yet.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	195
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	196 gutentags#statusline()
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	197 You can display an indicator of tag generation progress in your \|status-line\|
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	198 with the following function: >
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	199 :set statusline+=%{gutentags#statusline()}
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	200
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	201 The function will, by default, print a list of modules in the status line. So
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	202 if the `ctags` module (see \|g:gutentags_modules\|) is currently generating
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	203 a tags file, you will see "ctags" printed in the status line. If nothing is
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	204 happening, nothing will be printed in the status line.
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	205
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	206 You can pass some parameters to customize this:
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	207
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	208 1. A prefix string (defaults to `""`).
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	209 2. A suffix string (defaults to `""`).
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	210 3. The text to print (defaults to the names of modules currently generating
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	211 something).
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	212
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	213 So using `gutentags#statusline('[', ']')` would print `"[ctags]"` instead of
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	214 `"ctags"`.
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	215
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	216 Because Gutentags runs the tag generation in the background, the statusline
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	217 indicator might stay there even after the background process has ended. It
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	218 would only go away when Vim decides to refresh the statusline. You can force
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	219 refresh it in a callback on \|GutentagsUpdating\| and \|GutentagsUpdated\|.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	220
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	221 For instance, with the `lightline` plugin:
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	222
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	223 augroup MyGutentagsStatusLineRefresher
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	224 autocmd!
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	225 autocmd User GutentagsUpdating call lightline#update()
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	226 autocmd User GutentagsUpdated call lightline#update()
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 191 diff changeset	227 augroup END
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	228
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	229 gutentags#statusline_cb
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	230 As an alternative to the previous function, `gutentags#statusline_cb` takes
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	231 a single parameter which should be a \|Funcref\| or a function name. This
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	232 function should take a list of active module names, and return a string. This
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	233 lets you completely control what the status line will print.
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	234
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	235 For instance:
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	236 function! s:get_gutentags_status(mods) abort
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	237 let l:msg = ''
217 fcb0415dceac fixed status callback in docs Vitaly Kushner <vitalyk@gmail.com> parents: 207 diff changeset	238 if index(a:mods, 'ctags') >= 0
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	239 let l:msg .= '♨'
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	240 endif
217 fcb0415dceac fixed status callback in docs Vitaly Kushner <vitalyk@gmail.com> parents: 207 diff changeset	241 if index(a:mods, 'cscope') >= 0
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	242 let l:msg .= '♺'
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	243 endif
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	244 return l:msg
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	245 endfunction
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	246
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	247 :set statusline+=%{gutentags#statusline_cb(
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	248 \function('<SID>get_gutentags_status'))}
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	249
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	250 By default, the callback function doesn't get called if no tags generation is
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	251 currently happening. You can pass `1` as a second argument so that the
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	252 callback function is always called.
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 204 diff changeset	253
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	254
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	255 =============================================================================
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	256 4. Global Settings gutentags-settings
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	257
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	258 The following settings can be defined in your \|vimrc\| to change the default
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	259 behaviour of Gutentags.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	260
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	261 gutentags_enabled
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	262 g:gutentags_enabled
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	263 Defines whether Gutentags should be enabled. When
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	264 disabled, Gutentags will still scan for project root
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	265 markers when opening buffers. This is so that when you
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	266 re-enable Gutentags, you won't have some buffers
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	267 mysteriously working while others (those open last)
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	268 don't.
222 34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	269 Defaults to `1`.
34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	270
34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	271 gutentags_trace
34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	272 g:gutentags_trace
34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	273 When true, Gutentags will spit out debugging
34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	274 information as Vim messages (which you can later read
34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	275 with \|:messages\|). It also runs its background scripts
34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	276 with extra parameters to log activity to a `tags.log`
34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	277 file that you can also inspect for more information.
34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	278
34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	279 Note: you can run `:verbose GutentagsUpdate` to
34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	280 temporarily set \|g:gutentags_trace\| to `1` for that
34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	281 update only.
34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	282
34aa86c552db Add documentation about `gutentags_trace`. Ludovic Chabant <ludovic@chabant.com> parents: 218 diff changeset	283 Defaults to `0`.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	284
149 f915393ff68d Add `g:gutentags_dont_load` setting. Ludovic Chabant <ludovic@chabant.com> parents: 145 diff changeset	285 gutentags_dont_load
f915393ff68d Add `g:gutentags_dont_load` setting. Ludovic Chabant <ludovic@chabant.com> parents: 145 diff changeset	286 g:gutentags_dont_load
f915393ff68d Add `g:gutentags_dont_load` setting. Ludovic Chabant <ludovic@chabant.com> parents: 145 diff changeset	287 Prevents Gutentags from loading at all on Vim startup.
f915393ff68d Add `g:gutentags_dont_load` setting. Ludovic Chabant <ludovic@chabant.com> parents: 145 diff changeset	288
f915393ff68d Add `g:gutentags_dont_load` setting. Ludovic Chabant <ludovic@chabant.com> parents: 145 diff changeset	289 The difference between this and \|gutentags_enabled\| is
f915393ff68d Add `g:gutentags_dont_load` setting. Ludovic Chabant <ludovic@chabant.com> parents: 145 diff changeset	290 that \|gutentags_enabled\| can be turned on and off in
f915393ff68d Add `g:gutentags_dont_load` setting. Ludovic Chabant <ludovic@chabant.com> parents: 145 diff changeset	291 the same Vim session -- Gutentags as a plugin stays
f915393ff68d Add `g:gutentags_dont_load` setting. Ludovic Chabant <ludovic@chabant.com> parents: 145 diff changeset	292 loaded and will keep track of what happened while it
f915393ff68d Add `g:gutentags_dont_load` setting. Ludovic Chabant <ludovic@chabant.com> parents: 145 diff changeset	293 was disabled. However, \|gutentags_dont_load\| only
f915393ff68d Add `g:gutentags_dont_load` setting. Ludovic Chabant <ludovic@chabant.com> parents: 145 diff changeset	294 works on Vim startup and will prevent Gutentags from
f915393ff68d Add `g:gutentags_dont_load` setting. Ludovic Chabant <ludovic@chabant.com> parents: 145 diff changeset	295 loading at all, as if it wasn't there.
f915393ff68d Add `g:gutentags_dont_load` setting. Ludovic Chabant <ludovic@chabant.com> parents: 145 diff changeset	296
204 30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	297 gutentags_modules
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	298 g:gutentags_modules
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	299 A list of modules to load with Gutentags. Each module
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	300 is responsible for generating a specific type of tags
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	301 file.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	302 Valid values are:
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	303
204 30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	304 - `ctags`: generates a `tags` file using
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	305 a `ctags`-compatible program like Exhuberant Ctags
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	306 or Universal Ctags.
68 ca61487b3215 Add docs about ctags executable per filetype marc <marc@lamarciana.com> parents: 60 diff changeset	307
204 30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	308 - `cscope`: generates a code database file using
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	309 `cscope`.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	310
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	311 - `gtags_cscope`: same as `cscope` but uses GNU's
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	312 `gtags` executable and database.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	313
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	314 Defaults to `[ctags]`.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	315
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	316 gutentags_project_root
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	317 g:gutentags_project_root
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	318 When a buffer is loaded, Gutentags will figure out if
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	319 it's part of a project that should have tags managed
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	320 automatically. To do this, it looks for "root markers"
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	321 in the current file's directory and its parent
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	322 directories. If it finds any of those markers,
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	323 Gutentags will be enabled for the project, and a tags
165 cbc1ebe23ef1 Rename all ctags-related options to have "ctags" in their name. Ludovic Chabant <ludovic@chabant.com> parents: 149 diff changeset	324 file named after \|gutentags_ctags_tagfile\| will be
cbc1ebe23ef1 Rename all ctags-related options to have "ctags" in their name. Ludovic Chabant <ludovic@chabant.com> parents: 149 diff changeset	325 created at the project root.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	326 Defaults to `[]` (an empty \|List\|).
128 e673026faa56 Add option to not append the default project root markers. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	327 A list of default markers will be appended to the
e673026faa56 Add option to not append the default project root markers. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	328 user-defined ones unless
e673026faa56 Add option to not append the default project root markers. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	329 \|gutentags_add_default_project_roots\| is set to 0.
e673026faa56 Add option to not append the default project root markers. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	330
e673026faa56 Add option to not append the default project root markers. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	331 gutentags_add_default_project_roots
e673026faa56 Add option to not append the default project root markers. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	332 g:gutentags_add_default_project_roots
e673026faa56 Add option to not append the default project root markers. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	333 Defines whether Gutentags should always define some
e673026faa56 Add option to not append the default project root markers. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	334 default project roots (see \|gutentags_project_root\|).
e673026faa56 Add option to not append the default project root markers. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	335 This can be useful to prevent unnecessary disk access
e673026faa56 Add option to not append the default project root markers. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	336 when Gutentags searches for a project root.
e673026faa56 Add option to not append the default project root markers. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	337 The default markers are:
e673026faa56 Add option to not append the default project root markers. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	338 `['.git', '.hg', '.bzr', '_darcs', '_darcs', '_FOSSIL_', '.fslckout']`
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	339
118 2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 98 diff changeset	340 gutentags_exclude_project_root
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 98 diff changeset	341 g:gutentags_exclude_project_root
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 98 diff changeset	342 A list of project roots to generally ignore. If a file
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 98 diff changeset	343 is opened inside one of those projects, Gutentags
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 98 diff changeset	344 won't be activated. This is similar to placing
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 98 diff changeset	345 a `.notags` file in the root of those projects, but
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 98 diff changeset	346 can be useful when you don't want to, or can't, place
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 98 diff changeset	347 such a file there.
132 a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	348 Defaults to `['/usr/local']`, which is the folder where
118 2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 98 diff changeset	349 Homebrew is known to create a Git directory by default
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 98 diff changeset	350 on MacOS.
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 98 diff changeset	351
132 a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	352 gutentags_project_root_finder
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	353 g:gutentags_project_root_finder
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	354 When a buffer is loaded, Gutentags uses a default
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	355 (internal) implementation to find that file's
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	356 project's root directory, using settings like
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	357 \|g:gutentags_project_root\|. When you specify
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	358 \|g:gutentags_project_root_finder\|, you can tell
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	359 Gutentags to use a custom implementation, such as
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	360 `vim-projectroot`. The value of this setting must be
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	361 the name of a function that takes a single string
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	362 argument (the path to the current buffer's file) and
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	363 returns a string value (the project's root directory).
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	364 Defaults to `''`.
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	365 Note: when set, the called implementation will most
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	366 likely ignore \|g:gutentags_project_root\|.
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 129 diff changeset	367
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	368 gutentags_generate_on_missing
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	369 g:gutentags_generate_on_missing
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	370 If set to 1, Gutentags will start generating an initial
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	371 tag file if a file is open in a project where no tags
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	372 file is found. See \|gutentags_project_root\| for how
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	373 Gutentags locates the project.
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	374 When set to 0, Gutentags will only generate the first
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	375 time the file is saved (if
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	376 \|gutentags_generate_on_write\| is set to 1), or when
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	377 \|GutentagsUpdate\| or \|GutentagsGenerate\| is run.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	378 Defaults to 1.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	379
61 735fce322ae4 Add documentation for `g:gutentags_generate_on_new`. Ludovic Chabant <ludovic@chabant.com> parents: 60 diff changeset	380 gutentags_generate_on_new
735fce322ae4 Add documentation for `g:gutentags_generate_on_new`. Ludovic Chabant <ludovic@chabant.com> parents: 60 diff changeset	381 g:gutentags_generate_on_new
735fce322ae4 Add documentation for `g:gutentags_generate_on_new`. Ludovic Chabant <ludovic@chabant.com> parents: 60 diff changeset	382 If set to 1, Gutentags will start generating the tag
735fce322ae4 Add documentation for `g:gutentags_generate_on_new`. Ludovic Chabant <ludovic@chabant.com> parents: 60 diff changeset	383 file when a new project is open. A new project is
735fce322ae4 Add documentation for `g:gutentags_generate_on_new`. Ludovic Chabant <ludovic@chabant.com> parents: 60 diff changeset	384 considered open when a buffer is created for a file
735fce322ae4 Add documentation for `g:gutentags_generate_on_new`. Ludovic Chabant <ludovic@chabant.com> parents: 60 diff changeset	385 whose corresponding tag file has not been "seen" yet
735fce322ae4 Add documentation for `g:gutentags_generate_on_new`. Ludovic Chabant <ludovic@chabant.com> parents: 60 diff changeset	386 in the current Vim session -- which pretty much means
735fce322ae4 Add documentation for `g:gutentags_generate_on_new`. Ludovic Chabant <ludovic@chabant.com> parents: 60 diff changeset	387 when you open the first file in a given source control
735fce322ae4 Add documentation for `g:gutentags_generate_on_new`. Ludovic Chabant <ludovic@chabant.com> parents: 60 diff changeset	388 repository.
735fce322ae4 Add documentation for `g:gutentags_generate_on_new`. Ludovic Chabant <ludovic@chabant.com> parents: 60 diff changeset	389 When set to 0, Gutentags won't do anything special.
735fce322ae4 Add documentation for `g:gutentags_generate_on_new`. Ludovic Chabant <ludovic@chabant.com> parents: 60 diff changeset	390 See also \|gutentags_generate_on_missing\| and
735fce322ae4 Add documentation for `g:gutentags_generate_on_new`. Ludovic Chabant <ludovic@chabant.com> parents: 60 diff changeset	391 \|gutentags_generate_on_write\|.
735fce322ae4 Add documentation for `g:gutentags_generate_on_new`. Ludovic Chabant <ludovic@chabant.com> parents: 60 diff changeset	392 Defaults to 1.
735fce322ae4 Add documentation for `g:gutentags_generate_on_new`. Ludovic Chabant <ludovic@chabant.com> parents: 60 diff changeset	393
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	394 gutentags_generate_on_write
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	395 g:gutentags_generate_on_write
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	396 If set to 1, Gutentags will update the current
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	397 project's tag file when a file inside that project is
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	398 saved. See \|gutentags_project_root\| for how Gutentags
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	399 locates the project.
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	400 When set to 0, Gutentags won't do anything on save.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	401 This means that the project's tag file won't reflect
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	402 the latest changes, and you will have to run
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	403 \|GutentagsUpdate\| manually.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	404 Defaults to 1.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	405
182 2489b4b54d5c Add `g:gutentags_generate_on_empty_buffer` setting. Ludovic Chabant <ludovic@chabant.com> parents: 165 diff changeset	406 gutentags_generate_on_empty_buffer
2489b4b54d5c Add `g:gutentags_generate_on_empty_buffer` setting. Ludovic Chabant <ludovic@chabant.com> parents: 165 diff changeset	407 g:gutentags_generate_on_empty_buffer
2489b4b54d5c Add `g:gutentags_generate_on_empty_buffer` setting. Ludovic Chabant <ludovic@chabant.com> parents: 165 diff changeset	408 If set to 1, Gutentags will start generating the tag
2489b4b54d5c Add `g:gutentags_generate_on_empty_buffer` setting. Ludovic Chabant <ludovic@chabant.com> parents: 165 diff changeset	409 file even if there's no buffer currently open, as long
2489b4b54d5c Add `g:gutentags_generate_on_empty_buffer` setting. Ludovic Chabant <ludovic@chabant.com> parents: 165 diff changeset	410 as the current working directory (as returned by
2489b4b54d5c Add `g:gutentags_generate_on_empty_buffer` setting. Ludovic Chabant <ludovic@chabant.com> parents: 165 diff changeset	411 \|:cd\|) is inside a known project.
2489b4b54d5c Add `g:gutentags_generate_on_empty_buffer` setting. Ludovic Chabant <ludovic@chabant.com> parents: 165 diff changeset	412 This is useful if you want Gutentags to generate the
2489b4b54d5c Add `g:gutentags_generate_on_empty_buffer` setting. Ludovic Chabant <ludovic@chabant.com> parents: 165 diff changeset	413 tag file right after opening Vim.
2489b4b54d5c Add `g:gutentags_generate_on_empty_buffer` setting. Ludovic Chabant <ludovic@chabant.com> parents: 165 diff changeset	414 Defaults to 0.
2489b4b54d5c Add `g:gutentags_generate_on_empty_buffer` setting. Ludovic Chabant <ludovic@chabant.com> parents: 165 diff changeset	415
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	416 gutentags_background_update
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	417 g:gutentags_background_update
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	418 Specifies whether the process that updates the tags
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	419 file should be run in the background or in the
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	420 foreground. If run in the foreground, Vim will block
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	421 until the process is complete.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	422 Defaults to 1.
512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	423
22 4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	424 gutentags_cache_dir
4e1b0253f71a Renamed project to "Gutentags" (thanks Sylvain!). Ludovic Chabant <ludovic@chabant.com> parents: 20 diff changeset	425 g:gutentags_cache_dir
20 bd136cb41034 Update documentation. Ludovic Chabant <ludovic@chabant.com> parents: 17 diff changeset	426 Specifies a directory in which to create all the tags
bd136cb41034 Update documentation. Ludovic Chabant <ludovic@chabant.com> parents: 17 diff changeset	427 files, instead of writing them at the root of each
bd136cb41034 Update documentation. Ludovic Chabant <ludovic@chabant.com> parents: 17 diff changeset	428 project. This is handy to keep tags files from
bd136cb41034 Update documentation. Ludovic Chabant <ludovic@chabant.com> parents: 17 diff changeset	429 polluting many directories all across your computer.
4 512eaa56c7db First pass at documentation. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	430
85 0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 74 diff changeset	431 gutentags_resolve_symlinks
0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 74 diff changeset	432 g:gutentags_resolve_symlinks
0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 74 diff changeset	433 When set to 1, Gutentags will resolve any symlinks in
0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 74 diff changeset	434 the current buffer's path in order to find the project
0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 74 diff changeset	435 it belongs to. This is what you want if you're editing
0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 74 diff changeset	436 a symlink located outside of the project, and it
0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 74 diff changeset	437 points to a file inside the project. However, this is
0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 74 diff changeset	438 maybe not what you want if the symlink itself is
0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 74 diff changeset	439 part of the project.
0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 74 diff changeset	440 Defaults to 0.
88 073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 85 diff changeset	441
141 7bc4df0225d1 Add support for specifying buffer-specific tagfiles. Ludovic Chabant <ludovic@chabant.com> parents: 140 diff changeset	442 gutentags_init_user_func
7bc4df0225d1 Add support for specifying buffer-specific tagfiles. Ludovic Chabant <ludovic@chabant.com> parents: 140 diff changeset	443 g:gutentags_init_user_func
88 073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 85 diff changeset	444 When set to a non-empty string, it is expected to be
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 85 diff changeset	445 the name of a function that will be called when a file
123 76a4822aab76 Use existing b:gutentags_root Daniel Hahler <git@thequod.de> parents: 98 diff changeset	446 is opened in a project. The function gets passed the
88 073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 85 diff changeset	447 path of the file and if it returns 0, Gutentags won't
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 85 diff changeset	448 be enabled for that file.
141 7bc4df0225d1 Add support for specifying buffer-specific tagfiles. Ludovic Chabant <ludovic@chabant.com> parents: 140 diff changeset	449
7bc4df0225d1 Add support for specifying buffer-specific tagfiles. Ludovic Chabant <ludovic@chabant.com> parents: 140 diff changeset	450 You can use this to manually set buffer-local
7bc4df0225d1 Add support for specifying buffer-specific tagfiles. Ludovic Chabant <ludovic@chabant.com> parents: 140 diff changeset	451 settings:
7bc4df0225d1 Add support for specifying buffer-specific tagfiles. Ludovic Chabant <ludovic@chabant.com> parents: 140 diff changeset	452
165 cbc1ebe23ef1 Rename all ctags-related options to have "ctags" in their name. Ludovic Chabant <ludovic@chabant.com> parents: 149 diff changeset	453 * `b:gutentags_ctags_tagfile` (see \|gutentags_ctags_tagfile\|).
141 7bc4df0225d1 Add support for specifying buffer-specific tagfiles. Ludovic Chabant <ludovic@chabant.com> parents: 140 diff changeset	454
7bc4df0225d1 Add support for specifying buffer-specific tagfiles. Ludovic Chabant <ludovic@chabant.com> parents: 140 diff changeset	455 This setting was previously called
7bc4df0225d1 Add support for specifying buffer-specific tagfiles. Ludovic Chabant <ludovic@chabant.com> parents: 140 diff changeset	456 `gutentags_enabled_user_func`. The old setting is
7bc4df0225d1 Add support for specifying buffer-specific tagfiles. Ludovic Chabant <ludovic@chabant.com> parents: 140 diff changeset	457 still used as a fallback.
7bc4df0225d1 Add support for specifying buffer-specific tagfiles. Ludovic Chabant <ludovic@chabant.com> parents: 140 diff changeset	458
88 073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 85 diff changeset	459 Defaults to "".
85 0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 74 diff changeset	460
46 c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 43 diff changeset	461 gutentags_define_advanced_commands
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 43 diff changeset	462 g:gutentags_define_advanced_commands
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 43 diff changeset	463 Defines some advanced commands like
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 43 diff changeset	464 \|GutentagsToggleEnabled\| and \|GutentagsUnlock\|.
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 43 diff changeset	465
89 8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	466 gutentags_project_info
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	467 g:gutentags_project_info
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	468 Defines ways for Gutentags to figure out what kind of
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	469 project any given file belongs to. This should be
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	470 a list of dictionaries:
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	471
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	472 let g:gutentags_project_info = []
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	473 call add(g:gutentags_project_info, {...})
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	474
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	475 Each dictionary item must contain at least a `type`
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	476 key, indicating the type of project:
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	477
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	478 {"type": "python"}
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	479
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	480 Other items will be used to figure out if a project is
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	481 of the given type.
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	482
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	483 "file": any existing file with this path (relative to
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	484 the project root) will make the current project match
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	485 the given info.
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	486
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	487 "glob": any result found with this glob pattern
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	488 (relative to the project root) will make the current
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	489 project match the given info. See \|glob()\| for more
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	490 information.
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	491
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	492 Gutentags adds by default the following definitions:
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	493
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	494 call add(g:gutentags_project_info, {'type': 'python', 'file': 'setup.py'})
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	495 call add(g:gutentags_project_info, {'type': 'ruby', 'file': 'Gemfile'})
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	496
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	497 This means, for example, that you can use
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	498 `g:gutentags_ctags_executable_ruby` out of the box.
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	499 See \|gutentags_ctags_executable_{filetype}\| for more
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	500 information.
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	501
136 286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	502 gutentags_file_list_command
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	503 g:gutentags_file_list_command
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	504 Specifies command(s) to use to list files for which
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	505 tags should be generated, instead of recursively
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	506 examining all files within the project root. When
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	507 invoked, file list commands will execute in the
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	508 project root directory.
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	509
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	510 This setting is useful in projects using source
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	511 control to restrict tag generation to only files
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	512 tracked in the repository.
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	513
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	514 This variable may be set in one of two ways. If
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	515 set as a \|String\|, the specified command will be used to
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	516 list files for all projects. For example: >
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	517
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	518 let g:gutentags_file_list_command = 'find . -type f'
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	519 <
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	520 If set as a \|Dictionary\|, this variable should be set
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	521 as a mapping of project root markers to the desired
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	522 file list command for that root marker. (See
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	523 \|gutentags_project_root\| for how Gutentags uses root
190 6dc4bb6c53ba minor typos minusf <minusf@gmail.com> parents: 188 diff changeset	524 markers to locate the project.) For example: >
136 286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	525
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	526 let g:gutentags_file_list_command = {
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	527 \ 'markers': {
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	528 \ '.git': 'git ls-files',
138 851aec42057d Use `hg files` in the example (`locate` is deprecated). Ludovic Chabant <ludovic@chabant.com> parents: 136 diff changeset	529 \ '.hg': 'hg files',
136 286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	530 \ },
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	531 \ }
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	532 <
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	533 Note: If a custom ctags executable is specified, it
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	534 must support the '-L' command line option in order to
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 132 diff changeset	535 read the list of files to be examined.
0 a3a37124558b Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	536
204 30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	537
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	538 The following settings are valid for the `ctags` module.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	539
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	540 gutentags_ctags_executable
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	541 g:gutentags_ctags_executable
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	542 Specifies the ctags executable to launch.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	543 Defaults to `ctags`.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	544
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	545 gutentags_ctags_executable_{filetype}
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	546 g:gutentags_ctags_executable_{type}
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	547 Specifies the ctags executable to launch for a project
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	548 of type {type}. See \|gutentags_project_info\| for more
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	549 information.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	550 IMPORTANT: please see \|gutentags-ctags-requirements\|.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	551 Example: >
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	552 let g:gutentags_ctags_executable_ruby = 'foobar'
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	553 <
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	554
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	555 gutentags_ctags_tagfile
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	556 g:gutentags_ctags_tagfile
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	557 Specifies the name of the tag file to create. This
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	558 will be appended to the project's root. See
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	559 \|gutentags_project_root\| for how Gutentags locates the
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	560 project.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	561 Defaults to `tags`.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	562
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	563 gutentags_ctags_exclude
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	564 g:gutentags_ctags_exclude
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	565 A list of file patterns to pass to the
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	566 \|gutentags_ctags_executable\| so that they will be
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	567 excluded from parsing for the tags generation.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	568 See also \|gutentags_ctags_exclude_wildignore\|.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	569 Defaults to `[]` (an empty \|List\|).
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	570
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	571 gutentags_ctags_exclude_wildignore
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	572 g:gutentags_ctags_exclude_wildignore
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	573 When 1, Gutentags will automatically pass your
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	574 'wildignore' file patterns to the
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	575 \|gutentags_ctags_executable\| so that they are ignored.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	576 Set also \|gutentags_ctags_exclude\| to pass custom
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	577 patterns.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	578 Defaults to 1.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	579
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	580 gutentags_ctags_auto_set_tags
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	581 g:gutentags_ctags_auto_set_tags
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	582 If set to 1, Gutentags will automatically prepend
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	583 'tags' with the exact path to the tag file for the
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	584 current project. See \|gutentags_project_root\| for how
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	585 Gutentags locates the project.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	586 When set to 0, Gutentags doesn't change 'tags', and
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	587 this means that whatever tag file it generates may
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	588 not be picked up by Vim. See \|tagfiles()\| to know what
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	589 tag files Vim knows about.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	590 Defaults to 1.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	591
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	592 gutentags_ctags_extra_args
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	593 g:gutentags_ctags_extra_args
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	594 A list of arguments to pass to `ctags`.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	595 Defaults to `[]`.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	596
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	597 gutentags_ctags_post_process_cmd
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	598 g:gutentags_ctags_post_process_cmd
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	599 If defined, the tags generation script will run the
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	600 command with an argument that points to a temporary
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	601 copy of the tags file. If the post-process step is
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	602 modifying the tags file, it needs to do so in-place.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	603 This is useful for cleaning up a tags file that may
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	604 contain tags with non-ASCII names that somehow upsets
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	605 Vim.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	606 Defaults to `""` (an empty \|String\|).
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	607
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	608
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	609 The following settings are valid for the `cscope` module.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	610
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	611 gutentags_cscope_executable
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	612 g:gutentags_cscope_executable
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	613 Specifies the name or path of the `cscope` executable
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	614 to use to generate the code database.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	615 Defaults to `"cscope"`.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	616
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	617 gutentags_auto_add_cscope
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	618 g:gutentags_auto_add_cscope
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	619 If set to 1, Gutentags will automatically add the
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	620 generated code database to Vim by running `:cs add`
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	621 (see \|:cscope\|).
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	622 Defaults to 1.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	623
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	624
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	625 The following settings are valid for the `gtags_cscope` module.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	626
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	627 gutentags_gtags_executable
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	628 g:gutentags_gtags_executable
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	629 Specifies the name or path of the `gtags` executable
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	630 to use to generate the code database.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	631 Default to `"gtags"`.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	632
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	633 gutentags_gtags_options_file
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	634 g:gutentags_gtags_options_file
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	635 The name of a file that will be looked for in
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	636 a project root directory. The file is expected to
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	637 contain `gtags` options (one per line).
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	638 Defaults to `".gutgtags"`.
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	639
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	640 gutentags_auto_add_gtags_cscope
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	641 g:gutentags_auto_add_gtags_cscope
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	642 If set to 1, Gutentags will automatically add the
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	643 generated code database to Vim by running `:cs add`
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	644 (see \|:cscope\|).
30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	645 Defaults to 1.
210 39547ffc8867 Add mention of `gutentags_plus` for Cscope users. Ludovic Chabant <ludovic@chabant.com> parents: 207 diff changeset	646
39547ffc8867 Add mention of `gutentags_plus` for Cscope users. Ludovic Chabant <ludovic@chabant.com> parents: 207 diff changeset	647 People using `cscope` or `gtags_cscope` across multiple projects in the same
39547ffc8867 Add mention of `gutentags_plus` for Cscope users. Ludovic Chabant <ludovic@chabant.com> parents: 207 diff changeset	648 Vim instance might be interested in the `gutentags_plus` plugin, which handles
39547ffc8867 Add mention of `gutentags_plus` for Cscope users. Ludovic Chabant <ludovic@chabant.com> parents: 207 diff changeset	649 switching databases automatically before performing a query.
39547ffc8867 Add mention of `gutentags_plus` for Cscope users. Ludovic Chabant <ludovic@chabant.com> parents: 207 diff changeset	650 See https://github.com/skywind3000/gutentags_plus.
204 30ac3583c902 Re-arrange documentation of settings per module. Add missing settings. Ludovic Chabant <ludovic@chabant.com> parents: 202 diff changeset	651
49 70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	652 =============================================================================
70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	653 5. Project Settings gutentags-project-settings
70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	654
70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	655 Gutentags can be customized to some extent on a per-project basis with the
70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	656 following files present in the project root directory:
70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	657
74 cb1cf815052e Fix the documentation about the project settings file. Ludovic Chabant <ludovic@chabant.com> parents: 69 diff changeset	658 gutentags-.gutctags
cb1cf815052e Fix the documentation about the project settings file. Ludovic Chabant <ludovic@chabant.com> parents: 69 diff changeset	659 `.gutctags`: if this file exists, Ctags will be told to load additional
49 70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	660 command-line parameters by reading it line by line (see the Ctags
70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	661 documentation for more information).
70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	662
74 cb1cf815052e Fix the documentation about the project settings file. Ludovic Chabant <ludovic@chabant.com> parents: 69 diff changeset	663 Note that for complex reasons, Gutentags can't run `ctags` from the project
cb1cf815052e Fix the documentation about the project settings file. Ludovic Chabant <ludovic@chabant.com> parents: 69 diff changeset	664 root if you're using \|gutentags_cache_dir\|, so if the `.gutctags` file exists,
cb1cf815052e Fix the documentation about the project settings file. Ludovic Chabant <ludovic@chabant.com> parents: 69 diff changeset	665 it will be pre-processed in order to make all `--exclude=` clauses into
cb1cf815052e Fix the documentation about the project settings file. Ludovic Chabant <ludovic@chabant.com> parents: 69 diff changeset	666 absolute paths (by prepending the project root). The resulting file will be
cb1cf815052e Fix the documentation about the project settings file. Ludovic Chabant <ludovic@chabant.com> parents: 69 diff changeset	667 saved into the cache directory, and passed to `ctags` via the `--options=`
cb1cf815052e Fix the documentation about the project settings file. Ludovic Chabant <ludovic@chabant.com> parents: 69 diff changeset	668 parameter. If you're _not_ using \|gutentags_cache_dir\|, the `.gutctags` file
cb1cf815052e Fix the documentation about the project settings file. Ludovic Chabant <ludovic@chabant.com> parents: 69 diff changeset	669 is _not_ pre-processed, and is passed as-is via the `--options=` parameter.
49 70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	670
70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	671 gutentags-.notags
70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	672 `.notags`: if this file exists, Gutentags will be disabled completely for that
70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	673 project.
70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	674
70423c2202c5 Ctags options files changes Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	675
0 a3a37124558b Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	676 vim:tw=78:et:ft=help:norl:

Mercurial > vim-gutentags

annotate doc/gutentags.txt @ 222:34aa86c552db