blob: 43038399ea8d09cfc74b1ed12a2c9ae82c82ccf5 [file] [log] [blame]
Misha Brukman831ad842005-04-24 17:05:04 +00001" LLVM coding guidelines conformance for VIM
Misha Brukmanac7b4562009-01-02 16:26:14 +00002"
3" Maintainer: The LLVM Team, http://llvm.org
Misha Brukman831ad842005-04-24 17:05:04 +00004" WARNING: Read before you source in all these commands and macros! Some
Misha Brukmanf1ed8ed2005-05-12 21:41:48 +00005" of them may change VIM behavior that you depend on.
Misha Brukmanac7b4562009-01-02 16:26:14 +00006"
7" You can run VIM with these settings without changing your current setup with:
8" $ vim -u /path/to/llvm/utils/vim/vimrc
9
10" It's VIM, not VI
11set nocompatible
Misha Brukman831ad842005-04-24 17:05:04 +000012
13" Wrap text at 80 cols
14set textwidth=80
15
16" A tab produces a 2-space indentation
Dan Gohman2dca8282009-01-04 00:05:43 +000017set softtabstop=2
Misha Brukman831ad842005-04-24 17:05:04 +000018set shiftwidth=2
19set expandtab
20
Misha Brukmanac7b4562009-01-02 16:26:14 +000021" Highlight trailing whitespace
22highlight WhitespaceEOL ctermbg=DarkYellow guibg=DarkYellow
23match WhitespaceEOL /\s\+$/
24
Misha Brukmanf1ed8ed2005-05-12 21:41:48 +000025" Optional
26" C/C++ programming helpers
Dan Gohmane4159702009-01-04 00:03:54 +000027set cindent
Dan Gohmanbe631a32009-01-04 18:59:55 +000028" Set a few indentation parameters. See the VIM help for cinoptions-values for
29" details. These aren't absolute rules; they're just an approximation of
30" common style in LLVM source.
31set cinoptions=:0,g0,(0,Ws
Misha Brukmanf1ed8ed2005-05-12 21:41:48 +000032" Add and delete spaces in increments of `shiftwidth' for tabs
33set smarttab
34
Misha Brukmanac7b4562009-01-02 16:26:14 +000035" Highlight syntax in programming languages
36syntax on
37
Misha Brukman831ad842005-04-24 17:05:04 +000038" Enable filetype detection
39filetype on
40
41" LLVM Makefiles can have names such as Makefile.rules or TEST.nightly.Makefile,
42" so it's important to categorize them as such.
43augroup filetype
Misha Brukmanac7b4562009-01-02 16:26:14 +000044 au! BufRead,BufNewFile *Makefile* set filetype=make
Misha Brukman831ad842005-04-24 17:05:04 +000045augroup END
46
47" In Makefiles, don't expand tabs to spaces, since we need the actual tabs
48autocmd FileType make set noexpandtab
49
50" Useful macros for cleaning up code to conform to LLVM coding guidelines
51
52" Delete trailing whitespace and tabs at the end of each line
Misha Brukman93bd1ca2009-01-08 02:17:30 +000053command! DeleteTrailingWs :%s/\s\+$//
Misha Brukman831ad842005-04-24 17:05:04 +000054
55" Convert all tab characters to two spaces
Misha Brukmanac7b4562009-01-02 16:26:14 +000056command! Untab :%s/\t/ /g