diff options
| author | Diego Biurrun <diego@biurrun.de> | 2011-12-05 13:18:27 +0100 |
|---|---|---|
| committer | Diego Biurrun <diego@biurrun.de> | 2011-12-07 18:57:43 +0100 |
| commit | d8538f06e6c046680a0237ca5d3eeee43c2682e4 (patch) | |
| tree | 8a4ba5f28c56bf7c3d053ddd0ad2518295e61d9a | |
| parent | 7efea2a05196baf61f54ddf53b1e1f53f92ea738 (diff) | |
| download | ffmpeg-d8538f06e6c046680a0237ca5d3eeee43c2682e4.tar.gz | |
doc: add editor configuration section with Vim and Emacs settings
based on a patch by Victor Vasiliev, vasilvv gmail com
| -rw-r--r-- | doc/developer.texi | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/developer.texi b/doc/developer.texi index c9cf7bde98..dd31e3725b 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -207,6 +207,31 @@ Casts should be used only when necessary. Unneeded parentheses should also be avoided if they don't make the code easier to understand. @end itemize +@subsection Editor configuration +In order to configure Vim to follow Libav formatting conventions, paste +the following snippet into your @file{.vimrc}: +@example +" indentation rules for libav: 4 spaces, no tabs +set expandtab +set shiftwidth=4 +set softtabstop=4 +" allow tabs in Makefiles +autocmd FileType make set noexpandtab shiftwidth=8 softtabstop=8 +" Trailing whitespace and tabs are forbidden, so highlight them. +highlight ForbiddenWhitespace ctermbg=red guibg=red +match ForbiddenWhitespace /\s\+$\|\t/ +" Do not highlight spaces at the end of line while typing on that line. +autocmd InsertEnter * match ForbiddenWhitespace /\t\|\s\+\%#\@@<!$/ +@end example + +For Emacs, add these roughly equivalent lines to your @file{.emacs.d/init.el}: +@example +(setq c-default-style "k&r") +(setq-default c-basic-offset 4) +(setq-default indent-tabs-mode nil) +(setq-default show-trailing-whitespace t) +@end example + @section Development Policy @enumerate |