[RFC/PATCH] remove vim syntax highlighting in favor of upstream

From: Jeff King <peff@peff.net>
Date: Sep 24, 2008, 17:53 UTC
Message-ID: <20080924175315.GA10337@coredump.intra.peff.net>
In-Reply-To: <20080924170154.GA6816@neumann>

[Tim Pope cc'd as the author of the official version. Tim: just an FYI, but if you have any comments, please feel free to share]

[Shawn cc'd as the interim maintainer. I, for one, welcome our new Java-programming overlords].

On Wed, Sep 24, 2008 at 07:01:54PM +0200, SZEDER Gábor wrote:

Show 5 quoted lines

> > Is there any objection to simply removing it (and probably replacing it
> > with a note to go look at the official highlighting file)?
> I'm for it, because I didn't know that there is an official git syntax
> highlight file out there.  Indeed, I haven't even know that vim 7.2 is
> out.

Here is a patch, then. Shawn, we should probably give any vim users a few days to object in case there is something they don't like about the upstream version, but other than that, I think this should be applied to master.

-- >8 -- remove vim syntax highlighting in favor of upstream

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)

This patch gets rid of our local version and just points
interested parties to the upstream version.
---
 contrib/vim/README               |   13 +++++++++++--
 contrib/vim/syntax/gitcommit.vim |   18 ------------------
 2 files changed, 11 insertions(+), 20 deletions(-)
 delete mode 100644 contrib/vim/syntax/gitcommit.vim

diff --git a/contrib/vim/README b/contrib/vim/README
index 9e7881f..12d61bb 100644
--- a/contrib/vim/README
+++ b/contrib/vim/README
@@ -1,8 +1,17 @@
-To syntax highlight git's commit messages, you need to:
-  1. Copy syntax/gitcommit.vim to vim's syntax directory:
+Syntax highlighting for git commit messages 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 file
+from the vim project:
+
+  http://vim.svn.sourceforge.net/viewvc/vim/trunk/runtime/syntax/gitcommit.vim
+
+To install:
+
+  1. Copy 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
diff --git a/contrib/vim/syntax/gitcommit.vim b/contrib/vim/syntax/gitcommit.vim
deleted file mode 100644
index 332121b..0000000
--- a/contrib/vim/syntax/gitcommit.vim
+++ /dev/null
@@ -1,18 +0,0 @@
-syn region gitLine start=/^#/ end=/$/
-syn region gitCommit start=/^# Changes to be committed:$/ end=/^#$/ contains=gitHead,gitCommitFile
-syn region gitHead contained start=/^#   (.*)/ end=/^#$/
-syn region gitChanged start=/^# Changed but not updated:/ end=/^#$/ contains=gitHead,gitChangedFile
-syn region gitUntracked start=/^# Untracked files:/ end=/^#$/ contains=gitHead,gitUntrackedFile
-
-syn match gitCommitFile contained /^#\t.*/hs=s+2
-syn match gitChangedFile contained /^#\t.*/hs=s+2
-syn match gitUntrackedFile contained /^#\t.*/hs=s+2
-
-hi def link gitLine Comment
-hi def link gitCommit Comment
-hi def link gitChanged Comment
-hi def link gitHead Comment
-hi def link gitUntracked Comment
-hi def link gitCommitFile Type
-hi def link gitChangedFile Constant
-hi def link gitUntrackedFile Constant

-- 
1.6.0.2.473.g126a14