Document 'updatetime' also controlling writing of swap files.

See #672.
This commit is contained in:
Andy Stewart
2020-01-06 11:52:07 +00:00
parent 1c53af9a0d
commit 91bd300021
2 changed files with 6 additions and 3 deletions

View File

@@ -82,7 +82,7 @@ This is to avoid a problem which occurs if you have file named `git.*` (i.e. wit
### Getting started ### 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). 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`).
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. 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.
@@ -649,7 +649,7 @@ Here are some things you can check:
#### When signs take a few seconds to appear #### When signs take a few seconds to appear
* Try reducing `updatetime`, e.g. `set updatetime=100`. * Try reducing `updatetime`, e.g. `set updatetime=100`. Note this also controls the delay before vim writes its swap file.
#### When signs don't update after focusing Vim #### When signs don't update after focusing Vim

View File

@@ -249,7 +249,8 @@ OPTIONS *gitgutter-options*
The most important option is 'updatetime' which determines how long (in The most important option is 'updatetime' which determines how long (in
milliseconds) the plugin will wait after you stop typing before it updates the milliseconds) the plugin will wait after you stop typing before it updates the
signs. Vim's default is 4000. I recommend 100. signs. Vim's default is 4000. I recommend 100. Note this also controls how
long vim waits before writing its swap file.
Most important option:~ Most important option:~
@@ -624,6 +625,8 @@ Try reducing 'updatetime':
set updatetime=100 set updatetime=100
< <
Note this also controls how long vim waits before writing its swap file.
When signs don't update after focusing Vim:~ When signs don't update after focusing Vim:~