document DFHACK_ENABLE_LUACOV env var

develop
myk002 2021-02-27 21:52:54 -08:00
parent 418a8c5d21
commit dc58d39c36
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
1 changed files with 4 additions and 0 deletions

@ -535,6 +535,10 @@ on UNIX-like systems:
- ``DFHACK_LOG_MEM_RANGES`` (macOS only): if set, logs memory ranges to - ``DFHACK_LOG_MEM_RANGES`` (macOS only): if set, logs memory ranges to
``stderr.log``. Note that `devel/lsmem` can also do this. ``stderr.log``. Note that `devel/lsmem` can also do this.
- ``DFHACK_ENABLE_LUACOV``: if set, enables coverage analysis of Lua scripts.
Use the `devel/luacov` script to generage coverage reports from the gathered
metrics.
Other (non-DFHack-specific) variables that affect DFHack: Other (non-DFHack-specific) variables that affect DFHack:
- ``TERM``: if this is set to ``dumb`` or ``cons25`` on \*nix, the console will - ``TERM``: if this is set to ``dumb`` or ``cons25`` on \*nix, the console will