Document how to disable realtime updates.

This commit is contained in:
Andy Stewart
2018-02-19 14:31:59 +00:00
parent 38a7789be9
commit 4692457ae2
2 changed files with 19 additions and 3 deletions

View File

@@ -462,6 +462,16 @@ nmap <silent> [c :call PrevHunkAllBuffers()<CR>
### FAQ ### FAQ
> How can I turn off realtime updates?
Add this to your vim configuration (in an `/after/plugin` directory):
```viml
" .vim/after/plugin/gitgutter.vim
autocmd! gitgutter CursorHold,CursorHoldI
```
> Why can't I unstage staged changes? > Why can't I unstage staged changes?
This plugin is for showing changes between the working tree and the index (and staging/undoing those changes). Unstaging a staged hunk would require showing changes between the index and HEAD, which is out of scope. This plugin is for showing changes between the working tree and the index (and staging/undoing those changes). Unstaging a staged hunk would require showing changes between the index and HEAD, which is out of scope.

View File

@@ -417,19 +417,25 @@ colorscheme or |vimrc|:
=============================================================================== ===============================================================================
FAQ *gitgutter-faq* FAQ *gitgutter-faq*
a. Why can't I unstage staged changes? a. How do I turn off realtime updates?
Add this to your vim configuration in an |after-directory|:
>
autocmd! gitgutter CursorHold,CursorHoldI
<
b. Why can't I unstage staged changes?
This plugin is for showing changes between the working tree and the index This plugin is for showing changes between the working tree and the index
(and staging/undoing those changes). Unstaging a staged hunk would require (and staging/undoing those changes). Unstaging a staged hunk would require
showing changes between the index and HEAD, which is out of scope. showing changes between the index and HEAD, which is out of scope.
b. Why are the colours in the sign column weird? c. Why are the colours in the sign column weird?
Your colorscheme is configuring the |hl-SignColumn| highlight group weirdly. Your colorscheme is configuring the |hl-SignColumn| highlight group weirdly.
Please see |g:gitgutter_override_sign_column_highlight| on customising the Please see |g:gitgutter_override_sign_column_highlight| on customising the
sign column. sign column.
c. What happens if I also use another plugin which uses signs (e.g. Syntastic)? d. What happens if I also use another plugin which uses signs (e.g. Syntastic)?
Vim only allows one sign per line. Vim-gitgutter will not interfere with Vim only allows one sign per line. Vim-gitgutter will not interfere with
signs it did not add. signs it did not add.