From 233f72b7bf6b79c9312d6a5c8f962d6c4a674f04 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 11 Jun 2019 10:20:45 -0700 Subject: [PATCH] ; ui, web: mention out-of-step server clock issue for file reloading [ci skip] --- hledger-ui/hledger-ui.m4.md | 10 +++++++--- hledger-web/hledger-web.m4.md | 3 +++ 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/hledger-ui/hledger-ui.m4.md b/hledger-ui/hledger-ui.m4.md index eea36c532..ace88fec1 100644 --- a/hledger-ui/hledger-ui.m4.md +++ b/hledger-ui/hledger-ui.m4.md @@ -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. Also there is no visual indication that this is in progress. -`--watch` is not yet fully robust. It works well for normal usage, -but many file changes in a short time (eg saving the file thousands of +`--watch` is not yet fully robust. It works well for normal usage, but +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. Symptoms include: unresponsive UI, periodic resetting of the cursor position, momentary display of parse errors, high CPU usage eventually 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. + }}) diff --git a/hledger-web/hledger-web.m4.md b/hledger-web/hledger-web.m4.md index 49ecdb808..4bc5c2f07 100644 --- a/hledger-web/hledger-web.m4.md +++ b/hledger-web/hledger-web.m4.md @@ -176,6 +176,9 @@ when you reload the page or navigate to a new page. If a change makes a file unparseable, 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 In addition to the web UI, hledger-web provides some API routes that