xref: /aosp_15_r20/external/llvm/utils/vim/README (revision 9880d6810fe72a1726cb53787c6711e909410d58)
1*9880d681SAndroid Build Coastguard Worker-*- llvm/utils/vim/README -*-
2*9880d681SAndroid Build Coastguard Worker
3*9880d681SAndroid Build Coastguard WorkerThis directory contains settings for the vim editor to work on llvm *.ll and
4*9880d681SAndroid Build Coastguard Workertablegen *.td files. It comes with filetype detection rules in the (ftdetect),
5*9880d681SAndroid Build Coastguard Workersyntax highlighting (syntax), some minimal sensible default settings (ftplugin)
6*9880d681SAndroid Build Coastguard Workerand indentation plugins (indent).
7*9880d681SAndroid Build Coastguard Worker
8*9880d681SAndroid Build Coastguard WorkerTo install copy all subdirectories to your $HOME/.vim or if you prefer create
9*9880d681SAndroid Build Coastguard Workersymlinks 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.
10*9880d681SAndroid Build Coastguard Worker
11*9880d681SAndroid Build Coastguard WorkerNote: If you notice missing or incorrect syntax highlighting, please contact
12*9880d681SAndroid Build Coastguard Worker<llvm-bugs [at] lists.llvm.org>; if you wish to provide a patch to improve the
13*9880d681SAndroid Build Coastguard Workerfunctionality, it will be most appreciated. Thank you.
14*9880d681SAndroid Build Coastguard Worker
15*9880d681SAndroid Build Coastguard WorkerIf you find yourself working with LLVM Makefiles often, but you don't get syntax
16*9880d681SAndroid Build Coastguard Workerhighlighting (because the files have names such as Makefile.rules or
17*9880d681SAndroid Build Coastguard WorkerTEST.nightly.Makefile), add the following to your ~/.vimrc:
18*9880d681SAndroid Build Coastguard Worker
19*9880d681SAndroid Build Coastguard Worker  " LLVM Makefile highlighting mode
20*9880d681SAndroid Build Coastguard Worker  augroup filetype
21*9880d681SAndroid Build Coastguard Worker    au! BufRead,BufNewFile *Makefile*     set filetype=make
22*9880d681SAndroid Build Coastguard Worker  augroup END
23