-*- 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
+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.
- 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
+Note: If you notice missing or incorrect syntax highlighting, please contact
+<llvm-bugs [at] lists.llvm.org>; if you wish to provide a patch to improve the
+functionality, it will be most appreciated. Thank you.
- Syntax highlighting mode for TableGen description files. To use, COPY
- `tablegen.vim' to ~/.vim/syntax and add this code to your ~/.vimrc :
+If you find yourself working with LLVM Makefiles often, but you don't get syntax
+highlighting (because the files have names such as Makefile.rules or
+TEST.nightly.Makefile), add the following to your ~/.vimrc:
+ " LLVM Makefile highlighting mode
augroup filetype
- au! BufRead,BufNewFile *.td set filetype=tablegen
+ au! BufRead,BufNewFile *Makefile* set filetype=make
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.
-
-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
-functionality, it will be most appreciated. Thank you.
projects / oota-llvm.git / blobdiff