• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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
24If you prefer, instead of making copies you can make symlinks from
25~/.vim/syntax/... to the syntax files in your LLVM source tree. Apparently
26this did not work with older versions of vim however, so if this doesn't
27work you may need to make actual copies of the files.
28
29Another option, if you do not already have a ~/.vim/syntax directory, is
30to symlink ~/.vim/syntax itself to llvm/utils/vim .
31
32Note: If you notice missing or incorrect syntax highlighting, please contact
33<llvmbugs [at] cs.uiuc.edu>; if you wish to provide a patch to improve the
34functionality, it will be most appreciated. Thank you.
35
36If you find yourself working with LLVM Makefiles often, but you don't get syntax
37highlighting (because the files have names such as Makefile.rules or
38TEST.nightly.Makefile), add the following to your ~/.vimrc:
39
40  " LLVM Makefile highlighting mode
41  augroup filetype
42    au! BufRead,BufNewFile *Makefile*     set filetype=make
43  augroup END
44