GNU bug report logs - #74269
[PATCH] doc: Document GUILE_JIT_PAUSE_WHEN_STOPPING

Message received at submit <at> debbugs.gnu.org:

Received: (at submit) by debbugs.gnu.org; 8 Nov 2024 22:42:35 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Fri Nov 08 17:42:35 2024
Received: from localhost ([127.0.0.1]:52462 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1t9XgY-0006p6-No
	for submit <at> debbugs.gnu.org; Fri, 08 Nov 2024 17:42:34 -0500
Received: from lists.gnu.org ([209.51.188.17]:40810)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <ekaitz@HIDDEN>) id 1t9XgV-0006ov-8g
 for submit <at> debbugs.gnu.org; Fri, 08 Nov 2024 17:42:33 -0500
Received: from eggs.gnu.org ([2001:470:142:3::10])
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <ekaitz@HIDDEN>) id 1t9XgS-0003v5-Ko
 for bug-guile@HIDDEN; Fri, 08 Nov 2024 17:42:29 -0500
Received: from dane.soverin.net ([185.233.34.148])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
 (Exim 4.90_1) (envelope-from <ekaitz@HIDDEN>) id 1t9XgQ-0003dg-Fo
 for bug-guile@HIDDEN; Fri, 08 Nov 2024 17:42:28 -0500
Received: from smtp.soverin.net (c04smtp-lb01.int.sover.in [10.10.4.74])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256)
 (No client certificate requested)
 by dane.soverin.net (Postfix) with ESMTPS id 4XlYpt3HYMz2xrc;
 Fri,  8 Nov 2024 22:42:14 +0000 (UTC)
Received: from smtp.soverin.net (smtp.soverin.net [10.10.4.99]) by soverin.net
 (Postfix) with ESMTPSA id 4XlYpt05jtzL7; 
 Fri,  8 Nov 2024 22:42:13 +0000 (UTC)
Authentication-Results: smtp.soverin.net; dkim=pass (2048-bit key;
 unprotected) header.d=elenq.tech header.i=@elenq.tech header.a=rsa-sha256
 header.s=soverin1 header.b=dpYoZJcL; dkim-atps=neutral
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=elenq.tech; s=soverin1;
 t=1731105734;
 h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
 to:to:cc:cc:mime-version:mime-version:
 content-transfer-encoding:content-transfer-encoding;
 bh=fTocVBFw/qqBpg32q6Frfb1Q9w0FBstE4XgLnCurmKI=;
 b=dpYoZJcLaZNWwamT+6f9JcB4CRGISK7H92VshL6NVwz5QcPCHiYEwB6oIuUzUePBiDlLaf
 r7u3PB+Gucr61tcPvENCskUubppWBNLFp8fau1F0OTTH0o8dB6WLRB+b+rzqCXhxbBht9m
 2qcNM/sMKmC7FtGlMuHMXBoX3i6Fv72ODEoHD87QQpnXJkq4RaixF7gDsisugG9ePoYjSQ
 yZbZGb3PgmozIRq0+2Dr2pboctIByIeAojfNYhCnPCyYmTf/7OrF1M8M7EUwaT96ev3jGt
 HOWI4y+tVQSMY58hJPH7rmOwHQ2YuI2ALeHrIkCvYEKCVn25XdypIeitZkxCEg==
From: Ekaitz Zarraga <ekaitz@HIDDEN>
To: bug-guile@HIDDEN
Subject: [PATCH] doc: Document GUILE_JIT_PAUSE_WHEN_STOPPING
Date: Fri,  8 Nov 2024 23:41:49 +0100
Message-ID: <20241108224200.32164-1-ekaitz@HIDDEN>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-Spampanel-Class: ham
Received-SPF: pass client-ip=185.233.34.148; envelope-from=ekaitz@HIDDEN;
 helo=dane.soverin.net
X-Spam_score_int: -27
X-Spam_score: -2.8
X-Spam_bar: --
X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
 DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,
 RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001,
 RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_NONE=0.001,
 SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Spam-Score: -1.3 (-)
X-Debbugs-Envelope-To: submit
Cc: Ekaitz Zarraga <ekaitz@HIDDEN>
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -2.3 (--)

* 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