Subject: [PATCH] doc: Document GUILE_JIT_PAUSE_WHEN_STOPPING

From: Ekaitz Zarraga <[email-masked]>
Date: Fri, 8 Nov 2024 23:41:49 +0100

* doc/ref/guile-invoke.texi: Add GUILE_JIT_PAUSE_WHEN_STOPPING
---
 doc/ref/guile-invoke.texi | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/doc/ref/guile-invoke.texi b/doc/ref/guile-invoke.texi
index 7ceef0bb5..c837598b8 100644
--- a/doc/ref/guile-invoke.texi
+++ b/doc/ref/guile-invoke.texi
@@ -453,6 +453,18 @@ integer indicating the maximum number of functions to JIT-compile.  By
 bisecting over the value of @env{GUILE_JIT_STOP_AFTER}, you can pinpoint
 the precise function that is being miscompiled.
 
+@item GUILE_JIT_PAUSE_WHEN_STOPPING
+@vindex GUILE_JIT_PAUSE_WHEN_STOPPING
+Debugging the JIT compiler sometimes requires analysing the running
+process.  Setting @env{GUILE_JIT_PAUSE_WHEN_STOPPING} will pause the
+process when the JIT stops to let you connect a debugger to it and will
+print something along these lines:
+@example
+stopping automatic JIT compilation, as requested
+sleeping for 30s; to debug:
+   gdb -p 133646
+@end example
+
 @end table
 
 @c Local Variables: 
-- 
2.46.0