hledger-ui 1.42.1 → 1.42.2
raw patch · 6 files changed
+150/−78 lines, 6 filesdep ~basedep ~brickdep ~extraPVP ok
version bump matches the API change (PVP)
Dependency ranges changed: base, brick, extra, fsnotify, hledger, hledger-lib
API changes (from Hackage documentation)
Files
- CHANGES.md +17/−1
- README.md +0/−1
- hledger-ui.1 +45/−26
- hledger-ui.cabal +8/−9
- hledger-ui.info +41/−20
- hledger-ui.txt +39/−21
CHANGES.md view
@@ -22,7 +22,23 @@ See also the hledger changelog. -# 2025-03-12 1.42.1+# 1.42.2 2025-05-16++Fixes++- Require fsnotify-0.4.2.0+/hfsevents-0.1.8+, which fixes some events+ being ignored on mac (see https://github.com/luite/hfsevents/pull/19),+ which should help `hledger-ui --watch` a little.++- Require extra >= 1.7.11, fixing the stack8.10.yaml build. (Thomas Miedema)++Docs++- Update --watch notes+- Drop obsolete Windows non-support note+++# 1.42.1 2025-03-12 - allow vty 6.4
README.md view
@@ -2,7 +2,6 @@ A simple curses-style text user interface for the hledger accounting system. It can be a more convenient way to browse your accounts than the CLI.-This package currently does not support Microsoft Windows, except in WSL. See also: the [project README](https://hledger.org/README.html)
hledger-ui.1 view
@@ -1,5 +1,5 @@ -.TH "HLEDGER\-UI" "1" "March 2025" "hledger-ui-1.42.1 " "hledger User Manuals"+.TH "HLEDGER\-UI" "1" "May 2025" "hledger-ui-1.42.2 " "hledger User Manuals" @@ -17,7 +17,7 @@ .PD \f[CR]hledger ui \-\- [OPTS] [QUERYARGS]\f[R] .SH DESCRIPTION-This manual is for hledger\[aq]s terminal interface, version 1.42.1.+This manual is for hledger\[aq]s terminal interface, version 1.42.2. See also the hledger manual for common concepts and file formats. .PP hledger is a robust, user\-friendly, cross\-platform set of programs for@@ -437,26 +437,44 @@ This leaves more mental bandwidth for your accounting. Of course you can still interact with hledger\-ui when needed, eg to toggle cleared mode, or to explore the history.-.PP-There are currently some limitations with \f[CR]\-\-watch\f[R]:-.PP-It may not work correctly for you, depending on platform or system+.SS \-\-watch problems+\f[I]However.\f[R] There are limitations/unresolved bugs with+\f[CR]\-\-watch\f[R]:+.IP \[bu] 2+It may not work at all for you, depending on platform or system configuration.-(Eg #836.)-.PP-At least on mac, there can be a slow build\-up of CPU usage over time,-until the program is restarted (or, suspending and restarting with-\f[CR]CTRL\-z\f[R] \f[CR]fg\f[R] may be enough).-.PP-It will not detect file changes made by certain editors, such as-Jetbrains IDEs or \f[CR]gedit\f[R], or on certain less common-filesystems.-(To work around, press \f[CR]g\f[R] to reload manually, or try-#1617\[aq]s \f[CR]fs.inotify.max_user_watches\f[R] workaround and let us-know.)+On some unix systems, increasing fs.inotify.max_user_watches or+fs.file\-max parameters in /etc/sysctl.conf might help.+(#836)+.IP \[bu] 2+It may not detect file changes made by certain tools, such as Jetbrains+IDEs or gedit.+(#1617)+.IP \[bu] 2+It may not detect changes made from outside a virtual machine, ie by an+editor running on the host system.+.IP \[bu] 2+It may not detect file changes on certain less common filesystems.+.IP \[bu] 2+It may use increasing CPU and RAM over time, especially with large+files.+(This is probably not \-\-watch specific, you may be able to reproduce+it by pressing \f[CR]g\f[R] repeatedly.)+(#1825) .PP-If you are viewing files mounted from another machine, the system clocks-on both machines should be roughly in agreement.+Tips/workarounds:+.IP \[bu] 2+If \-\-watch won\[aq]t work for you, press \f[CR]g\f[R] to reload data+manually instead.+.IP \[bu] 2+If \-\-watch is leaking resources over time, quit and restart (or+suspend and resume) hledger\-ui when you\[aq]re not using it.+.IP \[bu] 2+When running hledger\-ui inside a VM, also make file changes inside the+VM.+.IP \[bu] 2+When working with files mounted from another machine, make sure the+system clocks on both machines are roughly in agreement. .SH ENVIRONMENT \f[B]LEDGER_FILE\f[R] The main journal file to use when not specified with \f[CR]\-f/\-\-file\f[R].@@ -471,14 +489,15 @@ \f[CR]\-f\-\f[R] doesn\[aq]t work (hledger\-ui can\[aq]t read from stdin). .PP-If you press \f[CR]g\f[R] with large files, there could be a noticeable-pause.+\f[CR]\-\-watch\f[R] is not robust, especially with large files (see+WATCH MODE above). .PP-The Transaction screen does not update from file changes until you exit-and re\-endter it (see SCREENS > Transaction above).+The Transaction screen does not update after file changes, even if you+press \f[CR]g\f[R], until you exit and re\-enter it.+(#2288) .PP-\f[CR]\-\-watch\f[R] is not yet fully robust on all platforms (see Watch-mode above).+If you press \f[CR]g\f[R] with large files, there could be a noticeable+pause with the UI unresponsive. .SH AUTHORS
hledger-ui.cabal view
@@ -1,15 +1,14 @@ cabal-version: 1.12 --- This file has been generated from package.yaml by hpack version 0.37.0.+-- This file has been generated from package.yaml by hpack version 0.38.0. -- -- see: https://github.com/sol/hpack name: hledger-ui-version: 1.42.1+version: 1.42.2 synopsis: Terminal interface for the hledger accounting system description: A simple terminal user interface for the hledger accounting system. It can be a more convenient way to browse your accounts than the CLI.- This package currently does not support Microsoft Windows, except in WSL. . hledger is a robust, cross-platform set of tools for tracking money, time, or any other commodity, using double-entry accounting and a@@ -73,7 +72,7 @@ hs-source-dirs: ./ ghc-options: -Wall -Wno-incomplete-uni-patterns -Wno-missing-signatures -Wno-orphans -Wno-type-defaults -Wno-unused-do-bind- cpp-options: -DVERSION="1.42.1" -DVERSION="1.42.1"+ cpp-options: -DVERSION="1.42.2" -DVERSION="1.42.2" build-depends: ansi-terminal >=0.9 , async@@ -84,12 +83,12 @@ , data-default , directory , doclayout >=0.3 && <0.6- , extra >=1.6.3+ , extra >=1.7.11 , filepath- , fsnotify ==0.4.*+ , fsnotify >=0.4.2.0 && <0.5 , githash >=0.1.6.2- , hledger >=1.42.1 && <1.43- , hledger-lib >=1.42.1 && <1.43+ , hledger >=1.42.2 && <1.43+ , hledger-lib >=1.42.2 && <1.43 , megaparsec >=7.0.0 && <9.8 , microlens >=0.4 , microlens-platform >=0.2.3.1@@ -121,7 +120,7 @@ hs-source-dirs: app ghc-options: -Wall -Wno-incomplete-uni-patterns -Wno-missing-signatures -Wno-orphans -Wno-type-defaults -Wno-unused-do-bind -with-rtsopts=-T- cpp-options: -DVERSION="1.42.1"+ cpp-options: -DVERSION="1.42.2" build-depends: base >=4.14 && <4.21 , hledger-ui
hledger-ui.info view
@@ -18,7 +18,7 @@ or 'hledger ui -- [OPTS] [QUERYARGS]' - This manual is for hledger's terminal interface, version 1.42.1. See+ This manual is for hledger's terminal interface, version 1.42.2. See also the hledger manual for common concepts and file formats. hledger is a robust, user-friendly, cross-platform set of programs@@ -491,23 +491,42 @@ hledger-ui when needed, eg to toggle cleared mode, or to explore the history. - There are currently some limitations with '--watch':+* Menu: - It may not work correctly for you, depending on platform or system-configuration. (Eg #836.)+* --watch problems:: - At least on mac, there can be a slow build-up of CPU usage over time,-until the program is restarted (or, suspending and restarting with-'CTRL-z' 'fg' may be enough).++File: hledger-ui.info, Node: --watch problems, Up: WATCH MODE - It will not detect file changes made by certain editors, such as-Jetbrains IDEs or 'gedit', or on certain less common filesystems. (To-work around, press 'g' to reload manually, or try #1617's-'fs.inotify.max_user_watches' workaround and let us know.)+5.1 -watch problems+=================== - If you are viewing files mounted from another machine, the system-clocks on both machines should be roughly in agreement.+_However._ There are limitations/unresolved bugs with '--watch': + * It may not work at all for you, depending on platform or system+ configuration. On some unix systems, increasing+ fs.inotify.max_user_watches or fs.file-max parameters in+ /etc/sysctl.conf might help. (#836)+ * It may not detect file changes made by certain tools, such as+ Jetbrains IDEs or gedit. (#1617)+ * It may not detect changes made from outside a virtual machine, ie+ by an editor running on the host system.+ * It may not detect file changes on certain less common filesystems.+ * It may use increasing CPU and RAM over time, especially with large+ files. (This is probably not -watch specific, you may be able to+ reproduce it by pressing 'g' repeatedly.) (#1825)++ Tips/workarounds:++ * If -watch won't work for you, press 'g' to reload data manually+ instead.+ * If -watch is leaking resources over time, quit and restart (or+ suspend and resume) hledger-ui when you're not using it.+ * When running hledger-ui inside a VM, also make file changes inside+ the VM.+ * When working with files mounted from another machine, make sure the+ system clocks on both machines are roughly in agreement.+ File: hledger-ui.info, Node: ENVIRONMENT, Next: BUGS, Prev: WATCH MODE, Up: Top @@ -531,13 +550,14 @@ '-f-' doesn't work (hledger-ui can't read from stdin). - If you press 'g' with large files, there could be a noticeable pause.+ '--watch' is not robust, especially with large files (see WATCH MODE+above). - The Transaction screen does not update from file changes until you-exit and re-endter it (see SCREENS > Transaction above).+ The Transaction screen does not update after file changes, even if+you press 'g', until you exit and re-enter it. (#2288) - '--watch' is not yet fully robust on all platforms (see Watch mode-above).+ If you press 'g' with large files, there could be a noticeable pause+with the UI unresponsive. Tag Table:@@ -555,8 +575,9 @@ Node: Transaction screen18826 Node: Error screen20401 Node: WATCH MODE20767-Node: ENVIRONMENT22343-Node: BUGS22576+Node: --watch problems21665+Node: ENVIRONMENT23018+Node: BUGS23251 End Tag Table
hledger-ui.txt view
@@ -11,7 +11,7 @@ hledger ui -- [OPTS] [QUERYARGS] DESCRIPTION- This manual is for hledger's terminal interface, version 1.42.1. See+ This manual is for hledger's terminal interface, version 1.42.2. See also the hledger manual for common concepts and file formats. hledger is a robust, user-friendly, cross-platform set of programs for@@ -394,43 +394,61 @@ hledger-ui when needed, eg to toggle cleared mode, or to explore the history. - There are currently some limitations with --watch:+ --watch problems+ However. There are limitations/unresolved bugs with --watch: - It may not work correctly for you, depending on platform or system con-- figuration. (Eg #836.)+ o It may not work at all for you, depending on platform or system con-+ figuration. On some unix systems, increasing fs.ino-+ tify.max_user_watches or fs.file-max parameters in /etc/sysctl.conf+ might help. (#836) - At least on mac, there can be a slow build-up of CPU usage over time,- until the program is restarted (or, suspending and restarting with- CTRL-z fg may be enough).+ o It may not detect file changes made by certain tools, such as Jet-+ brains IDEs or gedit. (#1617) - It will not detect file changes made by certain editors, such as Jet-- brains IDEs or gedit, or on certain less common filesystems. (To work- around, press g to reload manually, or try #1617's fs.ino-- tify.max_user_watches workaround and let us know.)+ o It may not detect changes made from outside a virtual machine, ie by+ an editor running on the host system. - If you are viewing files mounted from another machine, the system- clocks on both machines should be roughly in agreement.+ o It may not detect file changes on certain less common filesystems. + o It may use increasing CPU and RAM over time, especially with large+ files. (This is probably not --watch specific, you may be able to+ reproduce it by pressing g repeatedly.) (#1825)++ Tips/workarounds:++ o If --watch won't work for you, press g to reload data manually in-+ stead.++ o If --watch is leaking resources over time, quit and restart (or sus-+ pend and resume) hledger-ui when you're not using it.++ o When running hledger-ui inside a VM, also make file changes inside+ the VM.++ o When working with files mounted from another machine, make sure the+ system clocks on both machines are roughly in agreement.+ ENVIRONMENT- LEDGER_FILE The main journal file to use when not specified with+ LEDGER_FILE The main journal file to use when not specified with -f/--file. Default: $HOME/.hledger.journal. BUGS We welcome bug reports in the hledger issue tracker (shortcut:- https://bugs.hledger.org), or on the hledger chat or mail list+ https://bugs.hledger.org), or on the hledger chat or mail list (https://hledger.org/support). Some known issues: -f- doesn't work (hledger-ui can't read from stdin). - If you press g with large files, there could be a noticeable pause.+ --watch is not robust, especially with large files (see WATCH MODE+ above). - The Transaction screen does not update from file changes until you exit- and re-endter it (see SCREENS > Transaction above).+ The Transaction screen does not update after file changes, even if you+ press g, until you exit and re-enter it. (#2288) - --watch is not yet fully robust on all platforms (see Watch mode- above).+ If you press g with large files, there could be a noticeable pause with+ the UI unresponsive. @@ -450,4 +468,4 @@ SEE ALSO hledger(1), hledger-ui(1), hledger-web(1), ledger(1) -hledger-ui-1.42.1 March 2025 HLEDGER-UI(1)+hledger-ui-1.42.2 May 2025 HLEDGER-UI(1)