Skip to content

Commit 0071e2d

Browse files
committed
note about debug build; closes #3433
1 parent 01de523 commit 0071e2d

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

docs/development.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,12 @@ On macOS, either `brew install doxygen` or
9797
You'll also need a "essential build" tools:
9898
a compiler (`gcc`) and a few other things (e.g., `make`).
9999

100-
All Python development is managed using [uv](https://docs.astral.sh/uv/).
100+
All Python development is managed using [uv](https://docs.astral.sh/uv/),
101+
which takes the place of virtual/conda environments.
101102
It is not strictly necessary to use uv in order to make small changes, but
102-
the development workflows of all tskit-dev packages are organised around
103+
if you don't use it, you'll need to figure out how to install python
104+
dependencies on your own,
105+
and the development workflows of all tskit-dev packages are organised around
103106
using uv, and therefore we strongly recommend using it. Uv is straightforward
104107
to install, and not invasive (existing Python installations can be completely
105108
isolated if you don't use features like ``uv tool`` etc which update your
@@ -759,7 +762,9 @@ cd c
759762
meson setup build
760763
```
761764

762-
To setup a debug build add `--buildtype=debug` to the above command. This will set the `TSK_TRACE_ERRORS`
765+
To setup a debug build add `--buildtype=debug` to the above command.
766+
(Re-running the command with this argument will have the desired effect.)
767+
This will set the `TSK_TRACE_ERRORS`
763768
flag, which will print error messages to `stderr` when errors occur which is useful for debugging.
764769

765770
To compile the code run

0 commit comments

Comments
 (0)