summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-04-08 22:23:55 +0300
committerPaul Buetow <paul@buetow.org>2026-04-08 22:23:55 +0300
commita2335b65b2ccf7e6ffc440ca3d61dd6bec9e9163 (patch)
tree9aa5444fad75281aaada1355cd65f8ad8075498a /README.md
parent55d49e6a68a2b35457347df5443fe770fe474a3b (diff)
Task e: gate debug signal handlers behind build tag
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 94359f8..1e4753a 100644
--- a/README.md
+++ b/README.md
@@ -69,7 +69,7 @@ If Task Samurai appears to hang or freeze, you can capture runtime diagnostics u
### Signal Handlers (Unix/Linux/macOS only)
-Task Samurai supports two debugging signals:
+Task Samurai supports two debugging signals when built with the `debugsignals` build tag:
#### SIGUSR1 - Quick Goroutine Dump
@@ -100,6 +100,8 @@ This creates multiple files:
- `tasksamurai-TIMESTAMP-cpu.pprof` - CPU profile (5 second sample)
- `tasksamurai-TIMESTAMP-block.pprof` - Lock contention events
+Build with `-tags debugsignals` to enable these handlers in a local or debug build.
+
### Analyzing Profiles
Use Go's pprof tool to analyze the binary profile files: