summaryrefslogtreecommitdiff
path: root/contrib/vim/README
blob: fca1e17251f1f414a1d97bf6e6240bdf20daa648 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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://ftp.vim.org/pub/vim/runtime/syntax/git.vim
  http://ftp.vim.org/pub/vim/runtime/syntax/gitcommit.vim
  http://ftp.vim.org/pub/vim/runtime/syntax/gitconfig.vim
  http://ftp.vim.org/pub/vim/runtime/syntax/gitrebase.vim
  http://ftp.vim.org/pub/vim/runtime/syntax/gitsendemail.vim

These files are also available via FTP at the same location.

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