xref: /llvm-project-15.0.7/llvm/utils/vim/README (revision 634a3bd6)
1-*- llvm/utils/vim/README -*-
2
3These 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
24IMPORTANT: Making symlinks from ~/.vim/syntax/... to the syntax files in your
25LLVM source tree does not work, you DO need to copy the files directly.
26
27However, if you do not already have a ~/.vim/syntax/ directory, simply
28symlinking it to llvm/utils/vim will do the trick nicely, and you can stay
29up-to-date with CVS.
30
31Note: If you notice missing or incorrect syntax highlighting, please contact
32<llvmbugs [at] cs.uiuc.edu>; if you wish to provide a patch to improve the
33functionality, it will be most appreciated. Thank you.
34
35If you find yourself working with LLVM Makefiles often, but you don't get syntax
36highlighting (because the files have names such as Makefile.rules or
37TEST.nightly.Makefile), add the following to your ~/.vimrc:
38
39  " LLVM Makefile highlighting mode
40  augroup filetype
41    au! BufRead,BufNewFile *Makefile*     set filetype=make
42  augroup END
43