xref: /llvm-project-15.0.7/llvm/utils/vim/README (revision 595a97a2)
161e66baaSMisha Brukman-*- llvm/utils/vim/README -*-
261e66baaSMisha Brukman
32718fb1dSMatthias BraunThis directory contains settings for the vim editor to work on llvm *.ll and
42718fb1dSMatthias Brauntablegen *.td files. It comes with filetype detection rules in the (ftdetect),
52718fb1dSMatthias Braunsyntax highlighting (syntax), some minimal sensible default settings (ftplugin)
62718fb1dSMatthias Braunand indentation plugins (indent).
761e66baaSMisha Brukman
82718fb1dSMatthias BraunTo install copy all subdirectories to your $HOME/.vim or if you prefer create
9*595a97a2SSam Cleggsymlinks to the files here. Do not copy the vimrc file here it is only meant as
10*595a97a2SSam Cleggan inspiration and starting point for those working on llvm c++ code.
11216ed650SMisha Brukman
1261e66baaSMisha BrukmanNote: If you notice missing or incorrect syntax highlighting, please contact
130d28f80bSTanya Lattner<llvm-bugs [at] lists.llvm.org>; if you wish to provide a patch to improve the
1461e66baaSMisha Brukmanfunctionality, it will be most appreciated. Thank you.
15bd094e73SMisha Brukman
16bd094e73SMisha BrukmanIf you find yourself working with LLVM Makefiles often, but you don't get syntax
17bd094e73SMisha Brukmanhighlighting (because the files have names such as Makefile.rules or
18bd094e73SMisha BrukmanTEST.nightly.Makefile), add the following to your ~/.vimrc:
19bd094e73SMisha Brukman
20bd094e73SMisha Brukman  " LLVM Makefile highlighting mode
21bd094e73SMisha Brukman  augroup filetype
22bd094e73SMisha Brukman    au! BufRead,BufNewFile *Makefile*     set filetype=make
23bd094e73SMisha Brukman  augroup END
24