Mercurial > vim-gutentags

comparison doc/gutentags.txt @ 129:48045d81f25a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix some typos in the docs.
author Ludovic Chabant <ludovic@chabant.com>
date Tue, 19 Jul 2016 23:30:15 +0200
parents e673026faa56
children a6ef1c860d07
comparison
equal deleted inserted replaced
128:e673026faa56 129:48045d81f25a
52 will make sure the tag file for that project is up to date. Then, as you work 52 will make sure the tag file for that project is up to date. Then, as you work
53 in files in that project, it will partially re-generate the tag file. Every 53 in files in that project, it will partially re-generate the tag file. Every
54 time you save, it will silently, in the background, update the tags for that 54 time you save, it will silently, in the background, update the tags for that
55 file. 55 file.
56 56
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 to fast, or your project is really 62 multiple ctags processes if you save files too fast, or your project is really
63 big. 63 big.
64 64
65 There are some similar Vim plugins out there ("vim-tags", "vim-autotag", 65 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 66 "vim-automatic-ctags", etc.). They all fail on one or more of the requirements
67 I set for myself with Gutentags: 67 I set for myself with Gutentags:
74 don't run another one because I saved the file again. 74 don't run another one because I saved the file again.
75 * Keep the tag file consistent: don't just append the current file's tags to 75 * Keep the tag file consistent: don't just append the current file's tags to
76 the tag file, otherwise you will still "see" tags for deleted or renamed 76 the tag file, otherwise you will still "see" tags for deleted or renamed
77 classes and functions. 77 classes and functions.
78 * Automatically create the tag file: you open something from a freshly forked 78 * Automatically create the tag file: you open something from a freshly forked
79 project, it should start indexing it automatically, just in Sublime Text or 79 project, it should start indexing it automatically, just like in Sublime Text
80 Visual Studio or any other IDE. 80 or Visual Studio or any other IDE.
81 81
82 82
83 ============================================================================= 83 =============================================================================
84 2. Commands *gutentags-commands* 84 2. Commands *gutentags-commands*
85 85