aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore1
-rw-r--r--HACKING22
-rw-r--r--docs/hacking.html.in26
3 files changed, 49 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index 41f7654c0..e8c907ead 100644
--- a/.gitignore
+++ b/.gitignore
@@ -15,6 +15,7 @@
*~
.git
.git-module-status
+.lvimrc
.sc-start-sc_*
/ABOUT-NLS
/COPYING
diff --git a/HACKING b/HACKING
index 4a71b370c..b2ceaa7db 100644
--- a/HACKING
+++ b/HACKING
@@ -87,6 +87,28 @@ If you use Emacs, add the following to one of one of your start-up files
'(lambda () (if (string-match "/libvirt" (buffer-file-name))
(libvirt-c-mode))))
+If you use vim, append the following to your ~/.vimrc file:
+
+ set nocompatible
+ filetype on
+ set autoindent
+ set smartindent
+ set cindent
+ set tabstop=8
+ set shiftwidth=4
+ set expandtab
+ set cinoptions=(0,:0,l1,t0
+ filetype plugin indent on
+ au FileType make setlocal noexpandtab
+ au BufRead,BufNewFile *.am setlocal noexpandtab
+ match ErrorMsg /\s\+$\| \+\ze\t/
+
+Or if you don't want to mess your ~/.vimrc up, you can save the above into a
+file called .lvimrc (not .vimrc) located at the root of libvirt source, then
+install a vim script from
+http://www.vim.org/scripts/script.php?script_id=1408, which will load the
+.lvimrc only when you edit libvirt code.
+
Code formatting (especially for new code)
=========================================
diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index 0d81b0bed..e0484dd59 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -101,6 +101,32 @@
(libvirt-c-mode))))
</pre>
+ <p>
+ If you use vim, append the following to your ~/.vimrc file:
+ </p>
+<pre>
+ set nocompatible
+ filetype on
+ set autoindent
+ set smartindent
+ set cindent
+ set tabstop=8
+ set shiftwidth=4
+ set expandtab
+ set cinoptions=(0,:0,l1,t0
+ filetype plugin indent on
+ au FileType make setlocal noexpandtab
+ au BufRead,BufNewFile *.am setlocal noexpandtab
+ match ErrorMsg /\s\+$\| \+\ze\t/
+</pre>
+ <p>
+ Or if you don't want to mess your ~/.vimrc up, you can save the above
+ into a file called .lvimrc (not .vimrc) located at the root of libvirt
+ source, then install a vim script from
+ http://www.vim.org/scripts/script.php?script_id=1408,
+ which will load the .lvimrc only when you edit libvirt code.
+ </p>
+
<h2><a name="formatting">Code formatting (especially for new code)</a></h2>
<p>