| Misha Brukman | 115dc0d | 2003-08-11 17:56:08 +0000 | [diff] [blame] | 1 | -*- llvm/utils/vim/README -*- |
| 2 | |
| Matthias Braun | b1675e5 | 2015-04-21 01:35:42 +0000 | [diff] [blame] | 3 | This directory contains settings for the vim editor to work on llvm *.ll and |
| 4 | tablegen *.td files. It comes with filetype detection rules in the (ftdetect), |
| 5 | syntax highlighting (syntax), some minimal sensible default settings (ftplugin) |
| 6 | and indentation plugins (indent). |
| Misha Brukman | 115dc0d | 2003-08-11 17:56:08 +0000 | [diff] [blame] | 7 | |
| Matthias Braun | b1675e5 | 2015-04-21 01:35:42 +0000 | [diff] [blame] | 8 | To install copy all subdirectories to your $HOME/.vim or if you prefer create |
| 9 | 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. |
| Misha Brukman | 3871f05 | 2003-08-11 18:05:19 +0000 | [diff] [blame] | 10 | |
| Misha Brukman | 115dc0d | 2003-08-11 17:56:08 +0000 | [diff] [blame] | 11 | Note: If you notice missing or incorrect syntax highlighting, please contact |
| Tanya Lattner | 377a984 | 2015-08-05 03:51:17 +0000 | [diff] [blame] | 12 | <llvm-bugs [at] lists.llvm.org>; if you wish to provide a patch to improve the |
| Misha Brukman | 115dc0d | 2003-08-11 17:56:08 +0000 | [diff] [blame] | 13 | functionality, it will be most appreciated. Thank you. |
| Misha Brukman | e38adf5 | 2004-05-19 21:20:40 +0000 | [diff] [blame] | 14 | |
| 15 | If you find yourself working with LLVM Makefiles often, but you don't get syntax |
| 16 | highlighting (because the files have names such as Makefile.rules or |
| 17 | TEST.nightly.Makefile), add the following to your ~/.vimrc: |
| 18 | |
| 19 | " LLVM Makefile highlighting mode |
| 20 | augroup filetype |
| 21 | au! BufRead,BufNewFile *Makefile* set filetype=make |
| 22 | augroup END |