8dc6b297419d68cba9159c1e1daeeb945b6f0945
[oota-llvm.git] / utils / vim / README
1 -*- llvm/utils/vim/README -*-
2
3 These are syntax highlighting files for the VIM editor. Included are:
4
5 * llvm.vim
6
7   Syntax highlighting mode for LLVM assembly files. To use, COPY `llvm.vim' to
8   ~/.vim/syntax and add this code to your ~/.vimrc :
9
10   augroup filetype
11     au! BufRead,BufNewFile *.ll     set filetype=llvm
12   augroup END
13
14 * tablegen.vim
15
16   Syntax highlighting mode for TableGen description files. To use, COPY
17   `tablegen.vim' to ~/.vim/syntax and add this code to your ~/.vimrc :
18
19   augroup filetype
20     au! BufRead,BufNewFile *.td     set filetype=tablegen
21   augroup END
22
23
24 IMPORTANT: Making symlinks from ~/.vim/syntax/... to the syntax files in your
25 LLVM source tree does not work, you DO need to copy the files directly.
26
27 Note: If you notice missing or incorrect syntax highlighting, please contact
28 <llvmbugs [at] cs.uiuc.edu>; if you wish to provide a patch to improve the
29 functionality, it will be most appreciated. Thank you.