diff --git a/README.mkd b/README.mkd index 1839660..2a1c9fb 100644 --- a/README.mkd +++ b/README.mkd @@ -659,7 +659,10 @@ Here are some things you can check: * Verify `:echo system("git --version")` succeeds. * Verify your git config is compatible with the version of git returned by the command above. * Verify your Vim supports signs (`:echo has('signs')` should give `1`). -* Verify your file is being tracked by git and has unstaged changes. +* Verify your file is being tracked by git and has unstaged changes. Check whether the plugin thinks git knows about your file: `:echo b:gitgutter.path` should show the path to the file in the repo. +* Execute `:sign place group=gitgutter`; you should see a list of signs. + - If the signs are listed: this is a colorscheme / highlight problem. Compare `:highlight GitGutterAdd` with `:highlight SignColumn`. + - If no signs are listed: the call to git-diff is probably failing. Add `let g:gitgutter_log=1` to your vimrc, restart, reproduce the problem, and look at the `gitgutter.log` file in the plugin's directory. #### When the whole file is marked as added diff --git a/doc/gitgutter.txt b/doc/gitgutter.txt index 1a9cf92..06b0be9 100644 --- a/doc/gitgutter.txt +++ b/doc/gitgutter.txt @@ -654,6 +654,22 @@ When no signs are showing at all:~ < If the result is -2, the plugin thinks your file is not tracked by git. +6. Check whether the signs have been placed: +> + :sign place group=gitgutter +< + If you see a list of signs, this is a colorscheme / highlight problem. + Compare these two highlight values: +> + :highlight GitGutterAdd + :highlight SignColumn +< + If no signs are listed, the call to git-diff is probably failing. Turn on + logging by adding the following to your vimrc, restart, reproduce the problem, + and examing the gitgutter.log file in the plugin's directory. +> + let g:gitgutter_log = 1 +< When the whole file is marked as added:~