Mercurial > vim-gutentags

comparison doc/autotags.txt @ 7:49e3cb99ab27

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Small edits.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 20 Jul 2014 14:39:33 -0700
parents 512eaa56c7db
children b73466268844
comparison
equal deleted inserted replaced
6:ec87439fc784 7:49e3cb99ab27
35 35
36 ============================================================================= 36 =============================================================================
37 1. Introduction *autotags-intro* 37 1. Introduction *autotags-intro*
38 38
39 Autotags is a plugin that takes care of the much needed management of tags 39 Autotags is a plugin that takes care of the much needed management of tags
40 files in VIM. It will (re)generate tag files as you work while staying 40 files in Vim. It will (re)generate tag files as you work while staying
41 completely out of your way. It will even do its best to keep those tag files 41 completely out of your way. It will even do its best to keep those tag files
42 out of your way too. It has no dependencies and just works. 42 out of your way too. It has no dependencies and just works.
43 43
44 In order to generate tag files, Autotags will have to figure out what's in 44 In order to generate tag files, Autotags will have to figure out what's in
45 your project. To do this, it will locate well-known project root markers like 45 your project. To do this, it will locate well-known project root markers like
59 59
60 Also, Autotags is clever enough to not stumble upon itself by triggering 60 Also, Autotags is clever enough to not stumble upon itself by triggering
61 multiple ctags processes if you save files to fast, or your project is really 61 multiple ctags processes if you save files to fast, or your project is really
62 big. 62 big.
63 63
64 There are some similar VIM plugins out there ("vim-tags", "vim-autotag", 64 There are some similar Vim plugins out there ("vim-tags", "vim-autotag",
65 "vim-automatic-ctags", etc.). They all fail on one or more of the requirements 65 "vim-automatic-ctags", etc.). They all fail on one or more of the requirements
66 I set for myself with Autotags: 66 I set for myself with Autotags:
67 67
68 * No other dependency than running VIM: no Python, Ruby, or whatever. 68 * No other dependency than running Vim: no Python, Ruby, or whatever.
69 * Cross-platform: should work on at least Mac and Windows. 69 * Cross-platform: should work on at least Mac and Windows.
70 * Incremental tags generation: don't re-generate the whole project all the 70 * Incremental tags generation: don't re-generate the whole project all the
71 time. This may be fine for small projects, but it doesn't scale. 71 time. This may be fine for small projects, but it doesn't scale.
72 * External process management: if the ctags process is taking a long time, 72 * External process management: if the ctags process is taking a long time,
73 don't run another one because I saved the file again. 73 don't run another one because I saved the file again.