Mercurial > vim-gutentags

comparison doc/gutentags.txt @ 139:ed43e3a87ffd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add `ctags` executable requirements to the documentation page.
author Ludovic Chabant <ludovic@chabant.com>
date Thu, 22 Sep 2016 20:58:46 -0700
parents 851aec42057d
children 95092f4fbc4b
comparison
equal deleted inserted replaced
138:851aec42057d 139:ed43e3a87ffd
57 Usually, `ctags` can only append tags to an existing tag file, so Gutentags 57 Usually, `ctags` can only append tags to an existing tag file, so Gutentags
58 removes the tags for the current file first, to make sure the tag file is 58 removes the tags for the current file first, to make sure the tag file is
59 always consistent with the source code. 59 always consistent with the source code.
60 60
61 Also, Gutentags is clever enough to not stumble upon itself by triggering 61 Also, Gutentags is clever enough to not stumble upon itself by triggering
62 multiple ctags processes if you save files too fast, or your project is really 62 multiple ctags processes if you save files too fast, or if your project is
63 big. 63 really big.
64
65
66 1.1 Requirements
67
68 If you're using the `ctags` modules (which is the default and only working one
69 at this point, really), you will need a `tags` generator that supports the
70 following arguments:
71
72 * `-f` (to specify the output file)
73 * `--append` (to append to an existing file while keeping it sorted)
74 * `--exclude` (to exclude file patterns)
75 * `--options` (to specify an options file)
76
77 This means you probably want Exhuberant Ctags or Universal Ctags. The basic
78 old BSD Ctags WON'T WORK. Other language-specific versions may or may not
79 work. Check with their help or man page.
80
81
82 1.2 Similar Plugins
64 83
65 There are some similar Vim plugins out there ("vim-tags", "vim-autotag", 84 There are some similar Vim plugins out there ("vim-tags", "vim-autotag",
66 "vim-automatic-ctags", etc.). They all fail on one or more of the requirements 85 "vim-automatic-ctags", etc.). They all fail on one or more of the requirements
67 I set for myself with Gutentags: 86 I set for myself with Gutentags:
68 87