Re: [PATCH] contrib/vim: add syntax highlighting file for commits
- From
Junio C Hamano <junkio@cox.net>
- Date
- Sep 13, 2006, 06:12 UTC
- Message-ID
- <7vy7so9txj.fsf@assigned-by-dhcp.cox.net>
- In-Reply-To
- <20060912023256.GA6596@coredump.intra.peff.net>
Jeff King <peff@peff.net> writes:
Show 10 quoted lines
> On Mon, Sep 11, 2006 at 08:08:13PM -0600, Tom Prince wrote: > >> > + 1. Copy commit-syntax.vim to vim's syntax directory: >> > + $ cp commit-syntax.vim $HOME/.vim/syntax/gitcommit.vim >> It would be more obvious if you could do cp gitcomit.vim $HOME/.vim/syntax/ > > It would be with only one file, but you could just as easily have a > .vim/ftplugin/gitcommit.vim file (I think there are others, too). If you > want to give it the "proper" name, it should probably be > syntax/gitcommit.vim.
I am not a vim user, but my reading of Tom's comment is that he thinks it would have been nicer if the file the patch adds were named gitcommit.vim, not commit-syntax.vim. As you seem to agree that the preferred name for this file when deployed is gitcommit.vim, how about something like this on top of your patch perhaps?
diff --git a/contrib/vim/README b/contrib/vim/README index bad0a05..f574cc8 100644 --- a/contrib/vim/README +++ b/contrib/vim/README @@ -1,6 +1,6 @@ To syntax highlight git's commit messages, you need to: - 1. Copy commit-syntax.vim to vim's syntax directory: - $ cp commit-syntax.vim $HOME/.vim/syntax/gitcommit.vim + 1. Copy gitcommit.vim to vim's syntax directory: + $ cp 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 diff --git a/contrib/vim/commit-syntax.vim b/contrib/vim/gitcommit.vim similarity index 100% rename from contrib/vim/commit-syntax.vim rename to contrib/vim/gitcommit.vim