slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ui: doc: note --watch weaknesses under stress in BUGS

Browse Source
This commit is contained in:
Simon Michael 2016-12-30 19:59:30 -08:00
parent 04557613b1
commit 48fa4afc96
3 changed files with 30 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
hledger-ui/doc/hledger-ui.1
View File

@ -436,8 +436,17 @@ is awkward.
\f[C]\-V\f[] affects only the accounts screen. \f[C]\-V\f[] affects only the accounts screen.
.PP .PP
When you press \f[C]g\f[], the current and all previous screens are When you press \f[C]g\f[], the current and all previous screens are
regenerated, which may cause a noticeable pause. 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.
.PP
\f[C]\-\-watch\f[] 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.
.SH "REPORTING BUGS" .SH "REPORTING BUGS"

12
hledger-ui/doc/hledger-ui.1.m4.md
View File

@ -259,7 +259,15 @@ The need to precede options with `--` when invoked from hledger is awkward.
`-V` affects only the accounts screen. `-V` affects only the accounts screen.
When you press `g`, the current and all previous screens are When you press `g`, the current and all previous screens are
regenerated, which may cause a noticeable pause. Also there is no regenerated, which may cause a noticeable pause with large files.
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,
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.
}}) }})

12
hledger-ui/doc/hledger-ui.1.txt
View File

@ -326,8 +326,16 @@ BUGS
-V affects only the accounts screen. -V affects only the accounts screen.
When you press g, the current and all previous screens are regenerated, When you press g, the current and all previous screens are regenerated,
which may cause a noticeable pause. Also there is no visual indication which may cause a noticeable pause with large files. Also there is no
that this is in progress. 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
times with an editor macro) can cause problems at least on OSX. Symp-
toms include: unresponsive UI, periodic resetting of the cursor posi-
tion, momentary display of parse errors, high CPU usage eventually sub-
siding, and possibly a small but persistent build-up of CPU usage until
the program is restarted.