From d8538f06e6c046680a0237ca5d3eeee43c2682e4 Mon Sep 17 00:00:00 2001 From: Diego Biurrun <diego@biurrun.de> Date: Mon, 5 Dec 2011 13:18:27 +0100 Subject: doc: add editor configuration section with Vim and Emacs settings based on a patch by Victor Vasiliev, vasilvv gmail com --- doc/developer.texi | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) (limited to 'doc/developer.texi') 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 -- cgit v1.2.3