m-vim_plugins/vim-gitgutter
1
0
Fork 0
mirror of https://github.com/airblade/vim-gitgutter.git synced 2025-11-08 11:33:48 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document 'updatetime' and 'signcolumn' more prominently

Browse Source
This commit is contained in:
Andy Stewart
2023-07-14 14:29:31 +01:00
parent 4a7ca061af
commit 8a2f8199b6
2 changed files with 20 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.mkd
View File

@@ -55,7 +55,7 @@ In the screenshot above you can see:
### Installation
Install using your favourite package manager, or use Vim's built-in package support.
First, install using your favourite package manager, or use Vim's built-in package support.
Vim:
@@ -68,7 +68,6 @@ vim -u NONE -c "helptags vim-gitgutter/doc" -c q
Neovim:
```
mkdir -p ~/.config/nvim/pack/airblade/start
cd ~/.config/nvim/pack/airblade/start
@@ -76,6 +75,12 @@ git clone https://github.com/airblade/vim-gitgutter.git
nvim -u NONE -c "helptags vim-gitgutter/doc" -c q
```
Second, ensure your `updatetime` and `signcolumn` options are set appropriately.
When you make a change to a file tracked by git, the diff markers should appear automatically after a short delay. The delay is governed by vim's `updatetime` option; the default value is `4000`, i.e. 4 seconds, but I suggest reducing it to around 100ms (add `set updatetime=100` to your vimrc). Note `updatetime` also controls the delay before vim writes its swap file (see `:help updatetime`).
The `signcolumn` option can have any value except `'off'`.
### Windows
@@ -93,7 +98,7 @@ Unfortunately I don't know the correct escaping for the path - if you do, please
### Getting started
When you make a change to a file tracked by git, the diff markers should appear automatically. The delay is governed by vim's `updatetime` option; the default value is `4000`, i.e. 4 seconds, but I suggest reducing it to around 100ms (add `set updatetime=100` to your vimrc). Note `updatetime` also controls the delay before vim writes its swap file (see `:help updatetime`).
When you make a change to a file tracked by git, the diff markers should appear automatically after a short delay.
You can jump between hunks with `[c` and `]c`. You can preview, stage, and undo hunks with `<leader>hp`, `<leader>hs`, and `<leader>hu` respectively.

13
doc/gitgutter.txt
View File

@@ -41,7 +41,8 @@ one in 2013.
===============================================================================
INSTALLATION *gitgutter-installation*
Use your favourite package manager, or use Vim's built-in package support.
First, use your favourite package manager, or use Vim's built-in package
support.
Vim:~
>
@@ -59,6 +60,16 @@ Neovim:~
nvim -u NONE -c "helptags vim-gitgutter/doc" -c q
<
Second, ensure your 'updatetime' and 'signcolumn' options are set appropriately.
When you make a change to a file tracked by git, the diff markers should
appear automatically after a short delay. The delay is governed by vim's
'updatetime' option; the default value is `4000`, i.e. 4 seconds, but I
suggest reducing it to around 100ms (add `set updatetime=100` to your vimrc).
Note 'updatetime' also controls the delay before vim writes its swap file.
The 'signcolumn' option can have any value except "off".
===============================================================================
WINDOWS *gitgutter-windows*