; ui, web: mention out-of-step server clock issue for file reloading

[ci skip]
This commit is contained in:
Simon Michael 2019-06-11 10:20:45 -07:00
parent 4962b2696a
commit 233f72b7bf
2 changed files with 10 additions and 3 deletions

View File

@ -296,12 +296,16 @@ When you press `g`, the current and all previous screens are
regenerated, which may cause a noticeable pause with large files. regenerated, which may cause a noticeable pause with large files.
Also there is no visual indication that this is in progress. Also there is no visual indication that this is in progress.
`--watch` is not yet fully robust. It works well for normal usage, `--watch` is not yet fully robust. It works well for normal usage, but
but many file changes in a short time (eg saving the file thousands of many file changes in a short time (eg saving the file thousands of
times with an editor macro) can cause problems at least on OSX. times with an editor macro) can cause problems at least on OSX.
Symptoms include: unresponsive UI, periodic resetting of the cursor Symptoms include: unresponsive UI, periodic resetting of the cursor
position, momentary display of parse errors, high CPU usage eventually position, momentary display of parse errors, high CPU usage eventually
subsiding, and possibly a small but persistent build-up of CPU usage subsiding, and possibly a small but persistent build-up of CPU usage
until the program is restarted. until the program is restarted.
Also, if you are viewing files mounted from another machine, `--watch`
requires that both machine clocks are roughly in step.
}}) }})

View File

@ -176,6 +176,9 @@ when you reload the page or navigate to a new page.
If a change makes a file unparseable, If a change makes a file unparseable,
hledger-web will display an error message until the file has been fixed. hledger-web will display an error message until the file has been fixed.
(Note: if you are viewing files mounted from another machine, make
sure that both machine clocks are roughly in step.)
# JSON API # JSON API
In addition to the web UI, hledger-web provides some API routes that In addition to the web UI, hledger-web provides some API routes that