X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=utils%2Fvim%2FREADME;h=8aea87924eb26aa59d14c1ad98c5c11ddf7704b9;hb=300c966c183777eb5fc8db3ed0380b192e6b3438;hp=466de4f686a22d29380f2b503f3d17f4da29d9e3;hpb=e38adf52c8b367b86a547fcf967047d1968ae9f2;p=oota-llvm.git diff --git a/utils/vim/README b/utils/vim/README index 466de4f686a..8aea87924eb 100644 --- a/utils/vim/README +++ b/utils/vim/README @@ -1,36 +1,15 @@ -*- llvm/utils/vim/README -*- -These are syntax highlighting files for the VIM editor. Included are: +This directory contains settings for the vim editor to work on llvm *.ll and +tablegen *.td files. It comes with filetype detection rules in the (ftdetect), +syntax highlighting (syntax), some minimal sensible default settings (ftplugin) +and indentation plugins (indent). -* llvm.vim - - Syntax highlighting mode for LLVM assembly files. To use, COPY `llvm.vim' to - ~/.vim/syntax and add this code to your ~/.vimrc : - - augroup filetype - au! BufRead,BufNewFile *.ll set filetype=llvm - au! BufRead,BufNewFile *.llx set filetype=llvm - augroup END - -* tablegen.vim - - Syntax highlighting mode for TableGen description files. To use, COPY - `tablegen.vim' to ~/.vim/syntax and add this code to your ~/.vimrc : - - augroup filetype - au! BufRead,BufNewFile *.td set filetype=tablegen - augroup END - - -IMPORTANT: Making symlinks from ~/.vim/syntax/... to the syntax files in your -LLVM source tree does not work, you DO need to copy the files directly. - -However, if you do not already have a ~/.vim/syntax/ directory, simply -symlinking it to llvm/utils/vim will do the trick nicely, and you can stay -up-to-date with CVS. +To install copy all subdirectories to your $HOME/.vim or if you prefer create +symlinks to the files here. Do not copy the vimrc file here it is only meant as an inspiration and starting point for those working on llvm c++ code. Note: If you notice missing or incorrect syntax highlighting, please contact -; if you wish to provide a patch to improve the +; if you wish to provide a patch to improve the functionality, it will be most appreciated. Thank you. If you find yourself working with LLVM Makefiles often, but you don't get syntax