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     au! BufRead,BufNewFile *.llx    set filetype=llvm
  13   augroup END
  14
  15 * tablegen.vim
  16
  17   Syntax highlighting mode for TableGen description files. To use, COPY
  18   `tablegen.vim' to ~/.vim/syntax and add this code to your ~/.vimrc :
  19
  20   augroup filetype
  21     au! BufRead,BufNewFile *.td     set filetype=tablegen
  22   augroup END
  23
  24
  25 IMPORTANT: Making symlinks from ~/.vim/syntax/... to the syntax files in your
  26 LLVM source tree does not work, you DO need to copy the files directly.
  27
  28 However, if you do not already have a ~/.vim/syntax/ directory, simply
  29 symlinking it to llvm/utils/vim will do the trick nicely, and you can stay
  30 up-to-date with CVS.
  31
  32 Note: 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
  34 functionality, it will be most appreciated. Thank you.