1-*- llvm/utils/vim/README -*-
2
3This directory contains settings for the vim editor to work on llvm *.ll and
4tablegen *.td files. It comes with filetype detection rules in the (ftdetect),
5syntax highlighting (syntax), some minimal sensible default settings (ftplugin)
6and indentation plugins (indent).
7
8To install copy all subdirectories to your $HOME/.vim or if you prefer create
9symlinks to the files here. Do not copy the vimrc file here it is only meant as
10an inspiration and starting point for those working on llvm c++ code.
11
12Note: If you notice missing or incorrect syntax highlighting, please contact
13<llvm-bugs [at] lists.llvm.org>; if you wish to provide a patch to improve the
14functionality, it will be most appreciated. Thank you.
15
16If you find yourself working with LLVM Makefiles often, but you don't get syntax
17highlighting (because the files have names such as Makefile.rules or
18TEST.nightly.Makefile), add the following to your ~/.vimrc:
19
20  " LLVM Makefile highlighting mode
21  augroup filetype
22    au! BufRead,BufNewFile *Makefile*     set filetype=make
23  augroup END
24