Skip to content

Commit

Permalink
README.developer: add debug information
Browse files Browse the repository at this point in the history
Sometimes we need to use tools like gdb for further info.

Signed-off-by: Douglas Schilling Landgraf <[email protected]>
  • Loading branch information
dougsland committed Jul 31, 2023
1 parent 421adc1 commit d074ce9
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
- [Code Style](#code-style)
- [Linting](#linting)
- [Build](#build)
- [Debug](#debug)
- [Unit Tests](#unit-tests)
- [Integration Tests](#integration-tests)
- [Running](#running)
Expand Down Expand Up @@ -128,6 +129,19 @@ these need to be re-generated via
bash build-scripts/generate-bindings.sh python
```

### Debug

In some cases, developers might need a debug session with tools like gdb, here an example:

First, make sure **meson.build** contains **debug=true**.

Rebuild the hirte project with debug symbols included:
```bash

Check failure on line 139 in README.developer.md

View workflow job for this annotation

GitHub Actions / Markdown

Fenced code blocks should be surrounded by blank lines [Context: "```bash"]

README.developer.md:139 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
hirte> make clean
hirte> meson install -C builddir --dest=bin
hirte> gdb --args ./builddir/bin/usr/local/bin/hirte -c /etc/hirte/hirte.conf
```

### Unit tests

Unit tests can be executed using following commands:
Expand Down

0 comments on commit d074ce9

Please sign in to comment.