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

doc: DEVFAQ: building with ghc-debug support

Browse Source
This commit is contained in:
Simon Michael 2024-05-01 13:47:02 -10:00
parent 4c53ab419b
commit 2295185735
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/DEVFAQ.md
View File

@ -51,3 +51,22 @@ It will install executables to `~/.cabal/bin`:
```cli ```cli
$ cabal install all:exes $ cabal install all:exes
``` ```
### How do I build/run hledger with ghc-debug support ?
```cli
$ stack build --flag hledger:ghcdebug --flag hledger-ui:ghcdebug --flag hledger-web:ghcdebug
```
You can check it in the --version output, which should mention "ghc-debug":
```
$ stack exec -- hledger --version
```
With such a build, you can enable the ghc-debug listener by running hledger with a negative --debug level. Eg:
```cli
$ hledger ... --debug=-1 # run normally, while also listening for ghc-debug commands
$ hledger ... --debug=-2 # pause for ghc-debug commands at program start
$ hledger ... --debug=-3 # pause for ghc-debug commands at program end
```
Then you can pause/resume hledger's execution and inspect memory and profile information
with the interactive `ghc-debug-brick` client,
or extract specific information with a custom ghc-debug script.