Subject: Re: [PATCH] remove vim syntax highlighting in favor of upstream

From: Michael J Gruber <[email-masked]>
Date: Tue, 30 Sep 2008 10:29:37 +0200

SZEDER Gábor venit, vidit, dixit 29.09.2008 22:08:
> As of version 7.2, vim ships with its own syntax
> highlighting for git commit messages, which is:
> 
>   1. more comprehensive in splitting up the various
>      components of the file
> 
>   2. in accordance with the usual vim behavior for syntax
>      highlighting (e.g., respecting b:current_syntax)
> 
>   3. presumably better maintained (I have not been using
>      what's in git's contrib/ directory for some time in
>      favor of the upstream version)
> 
> Furthermore, vim upsream also provides syntax highlighting
> for other git filetypes (gitconfig, rebase, send-email).
> 
> This patch gets rid of our local version and just points
> interested parties to the upstream version.
> 
> The code for auto-detecting filetypes is taken from vim's
> runtime/filetype.vim.
> 
> Signed-off-by: SZEDER Gábor <[email-masked]>
> ---
> 
> On Mon, Sep 29, 2008 at 07:55:42AM -0700, Shawn O. Pearce wrote:
>> Missing SBO line?
> Here it is.  Since significant parts of the patch and the commit
> message are from Jeff, maybe he should sign off, too?
> 
> Note, that this patch is slightly different from the previous one, as
> it proposes writing the auto-detect commands into ~/.vim/filetype.vim
> instead of ~/.vimrc.  It's not quite clear to me why, but it seems to
> resolve the filetype confusion I mentioned in my previous email.
> 
> 
>  contrib/vim/README               |   38 ++++++++++++++++++++++++++++++--------
>  contrib/vim/syntax/gitcommit.vim |   18 ------------------
>  2 files changed, 30 insertions(+), 26 deletions(-)
>  delete mode 100644 contrib/vim/syntax/gitcommit.vim
> 
> diff --git a/contrib/vim/README b/contrib/vim/README
> index 9e7881f..c487346 100644
> --- 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

Works as described with vim 7.1.

How about creating a syntax file for editing the files generated by
format-patch, especially 0000-cover-letter.patch? Should be mostly a
combination of "git.vim" and "gitsendemail.vim", but I didn't find any
syntax defs for the diffstat.

Michael

P.S.: What? Git doc linking to an svn repo? Someone needs to set up a
git mirror ;)