diff options
Diffstat (limited to 'llvm/utils/vim/README')
| -rw-r--r-- | llvm/utils/vim/README | 33 |
1 files changed, 6 insertions, 27 deletions
diff --git a/llvm/utils/vim/README b/llvm/utils/vim/README index bca25bfe612..1fe00992b0a 100644 --- a/llvm/utils/vim/README +++ b/llvm/utils/vim/README @@ -1,33 +1,12 @@ -*- 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 - 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 - - -If you prefer, instead of making copies you can make symlinks from -~/.vim/syntax/... to the syntax files in your LLVM source tree. Apparently -this did not work with older versions of vim however, so if this doesn't -work you may need to make actual copies of the files. - -Another option, if you do not already have a ~/.vim/syntax directory, is -to symlink ~/.vim/syntax itself to llvm/utils/vim . +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 <llvmbugs [at] cs.uiuc.edu>; if you wish to provide a patch to improve the |
