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

;doc: DEVFAQ: edits

Browse Source
This commit is contained in:
Simon Michael 2024-05-01 16:36:25 -10:00
parent 470f359a56
commit 2eda0934f4
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/DEVFAQ.md
View File

@ -56,6 +56,7 @@ $ cabal install all:exes
You might need to stop background builders like HLS, to avoid a fight over the build flag You might need to stop background builders like HLS, to avoid a fight over the build flag
(in VS Code, run the command "Haskell: Stop Haskell LSP server"). (in VS Code, run the command "Haskell: Stop Haskell LSP server").
Then build lib and executable(s) with the `ghcdebug` flag: Then build lib and executable(s) with the `ghcdebug` flag:
```cli ```cli
$ stack build --flag hledger-lib:ghcdebug --flag hledger:ghcdebug --flag hledger-ui:ghcdebug --flag hledger-web:ghcdebug $ stack build --flag hledger-lib:ghcdebug --flag hledger:ghcdebug --flag hledger-ui:ghcdebug --flag hledger-web:ghcdebug
@ -67,7 +68,7 @@ $ stack exec -- hledger --version
... with ghc debug support ... with ghc debug support
``` ```
Now if you run at debug level -1, -2 or -3 the output should mention ghc-debug: And when you run at debug level -1, -2 or -3 the output should mention ghc-debug:
```cli ```cli
$ hledger CMD --debug=-1 # run normally, and listen for ghc-debug commands $ hledger CMD --debug=-1 # run normally, and listen for ghc-debug commands
$ hledger CMD --debug=-2 # pause for ghc-debug commands at program start $ hledger CMD --debug=-2 # pause for ghc-debug commands at program start
@ -75,7 +76,7 @@ $ hledger CMD --debug=-3 # pause for ghc-debug commands at program end
Starting ghc-debug on socket: ... Starting ghc-debug on socket: ...
``` ```
Then in another window, you can run [ghc-debug-brick](https://hackage.haskell.org/package/ghc-debug-brick) and it will show the running hledger process. Press enter to connect. This is not robust. Tips: Now in another window, you can run [ghc-debug-brick](https://hackage.haskell.org/package/ghc-debug-brick) and it will show the hledger process (until it ends). Press enter to connect. This is not robust. Tips:
- you might need to clear out stale sockets: `rm -f ~/.local/share/ghc-debug/debuggee/sockets/*` - you might need to clear out stale sockets: `rm -f ~/.local/share/ghc-debug/debuggee/sockets/*`
- you might need to kill stale hledger processes: `pkill -fl hledger` - you might need to kill stale hledger processes: `pkill -fl hledger`
- it might still fail with this error, reasons unclear:\ - it might still fail with this error, reasons unclear:\