Merge branch 'maint'

[git.git] / contrib / vim / README

diff --git a/contrib/vim/README b/contrib/vim/README
index 9e7881fea923e47c3c35028ebbc00bce395d4005..c487346eba0f4ecad01903ccc68963040d9944ab 100644 (file)
--- a/contrib/vim/README
+++ b/contrib/vim/README
@@ -1,8 +1,30 @@
-To syntax highlight git's commit messages, you need to:
-  1. Copy syntax/gitcommit.vim to vim's syntax directory:
-     $ mkdir -p $HOME/.vim/syntax
-     $ cp syntax/gitcommit.vim $HOME/.vim/syntax
-  2. Auto-detect the editing of git commit files:
-     $ cat >>$HOME/.vimrc <<'EOF'
-     autocmd BufNewFile,BufRead COMMIT_EDITMSG set filetype=gitcommit
-     EOF
+Syntax highlighting for git commit messages, config files, etc. is
+included with the vim distribution as of vim 7.2, and should work
+automatically.
+
+If you have an older version of vim, you can get the latest syntax
+files from the vim project:
+
+  http://vim.svn.sourceforge.net/viewvc/vim/trunk/runtime/syntax/git.vim
+  http://vim.svn.sourceforge.net/viewvc/vim/trunk/runtime/syntax/gitcommit.vim
+  http://vim.svn.sourceforge.net/viewvc/vim/trunk/runtime/syntax/gitconfig.vim
+  http://vim.svn.sourceforge.net/viewvc/vim/trunk/runtime/syntax/gitrebase.vim
+  http://vim.svn.sourceforge.net/viewvc/vim/trunk/runtime/syntax/gitsendemail.vim
+
+To install:
+
+  1. Copy these files to vim's syntax directory $HOME/.vim/syntax
+  2. To auto-detect the editing of various git-related filetypes:
+       $ cat >>$HOME/.vim/filetype.vim <<'EOF'
+       autocmd BufNewFile,BufRead *.git/COMMIT_EDITMSG    setf gitcommit
+       autocmd BufNewFile,BufRead *.git/config,.gitconfig setf gitconfig
+       autocmd BufNewFile,BufRead git-rebase-todo         setf gitrebase
+       autocmd BufNewFile,BufRead .msg.[0-9]*
+               \ if getline(1) =~ '^From.*# This line is ignored.$' |
+               \   setf gitsendemail |
+               \ endif
+       autocmd BufNewFile,BufRead *.git/**
+               \ if getline(1) =~ '^\x\{40\}\>\|^ref: ' |
+               \   setf git |
+               \ endif
+       EOF