From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Tomas Volf <~@wolfsden.cz> Newsgroups: gmane.lisp.guile.bugs Subject: bug#68505: [PATCH v3] Add more detailed instructions into the HACKING file. Date: Wed, 24 Jan 2024 17:48:04 +0100 Message-ID: <20240124165526.19035-1-~@wolfsden.cz> References: <20240116125109.14779-1-~@wolfsden.cz> Mime-Version: 1.0 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="2433"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Tomas Volf <~@wolfsden.cz> To: 68505@debbugs.gnu.org Original-X-From: bug-guile-bounces+guile-bugs=m.gmane-mx.org@gnu.org Wed Jan 24 17:56:31 2024 Return-path: Envelope-to: guile-bugs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rSgYA-0000TT-HA for guile-bugs@m.gmane-mx.org; Wed, 24 Jan 2024 17:56:30 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rSgXf-0007vI-Lr; Wed, 24 Jan 2024 11:55:59 -0500 Original-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 ) id 1rSgXc-0007v9-Oy for bug-guile@gnu.org; Wed, 24 Jan 2024 11:55:56 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rSgXc-0007Qs-GD for bug-guile@gnu.org; Wed, 24 Jan 2024 11:55:56 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rSgXh-0002Za-Pr for bug-guile@gnu.org; Wed, 24 Jan 2024 11:56:01 -0500 X-Loop: help-debbugs@gnu.org In-Reply-To: <20240116125109.14779-1-~@wolfsden.cz> Resent-From: Tomas Volf <~@wolfsden.cz> Original-Sender: "Debbugs-submit" Resent-CC: bug-guile@gnu.org Resent-Date: Wed, 24 Jan 2024 16:56:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 68505 X-GNU-PR-Package: guile X-GNU-PR-Keywords: patch Original-Received: via spool by 68505-submit@debbugs.gnu.org id=B68505.17061153449861 (code B ref 68505); Wed, 24 Jan 2024 16:56:01 +0000 Original-Received: (at 68505) by debbugs.gnu.org; 24 Jan 2024 16:55:44 +0000 Original-Received: from localhost ([127.0.0.1]:46448 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rSgXP-0002Yx-LK for submit@debbugs.gnu.org; Wed, 24 Jan 2024 11:55:44 -0500 Original-Received: from wolfsden.cz ([37.205.8.62]:50754) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from <~@wolfsden.cz>) id 1rSgXN-0002Yg-FZ for 68505@debbugs.gnu.org; Wed, 24 Jan 2024 11:55:42 -0500 Original-Received: by wolfsden.cz (Postfix, from userid 104) id 492012758C8; Wed, 24 Jan 2024 16:55:34 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=wolfsden.cz; s=mail; t=1706115334; bh=4P9kjGL5h4A91V7vEijolFP4AgzItBU1yaLhEGWALNY=; h=From:To:Cc:Subject:Date; b=wHXa2Vg/pCxuNAbEP3dl+kdeYF4rLphpdWThEbnKerKl09OnYVyIs1WPlwR4tYSO4 /Ve/8HHuy0nq6LGAAw+zRX5Bt5pv0p++dDHqLQ4YLfYKpLQgKhNxp1kNxZkOZRPjyx EEKLJ0i/wzQ4n6fA7+9DgqdylNrDvQuJFoK4SKXCGZGsY7w/QGWU3j9ryt9LulXcq3 cco8hhe1oVgdqTQltUq0ndshqA4vBC8RQynlmLazM9E4jZXEy/sbbdKocllwckHDjt JfrKde/3sINku3m+6JC3j/6aaGZu1crwe3eKjZMPeTw3e3D69Ink1pVVx4feuInJuQ J7Fkwa7alAODpsgysYEzyv65lUDUnZNzUik24qYBCIYSdSVljBG9xMNtl/OQzXe4cW qAcgPyqezufShXFGOhh++cAcQMG1M3MPDnjzMg3JC2pUVXr/DXpRhB0uKYb+IWu8Lk dREY73XMvLCwkLJBl6KGWtUz272wx7BcikpaksDY0eiA9jeuBZjvasX2X4BSGhf39i JesE9+QnlsZGfQueW0GSEXxs2w3Eyso4uOdgTSCtbRb1S569q76DTP0EHxkq6t2dxa fWhac63RUCWk5wJD5Ilw6zo59L1vUcKJrjiTZDzYGjMJEtIj7B7BVPOXbwaLglHRMt YKmsUSkAQ3h7cxyaxyQIfjpA= Original-Received: from localhost (unknown [146.70.134.137]) by wolfsden.cz (Postfix) with ESMTPSA id BBE10276C28; Wed, 24 Jan 2024 16:55:33 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=wolfsden.cz; s=mail; t=1706115333; bh=4P9kjGL5h4A91V7vEijolFP4AgzItBU1yaLhEGWALNY=; h=From:To:Cc:Subject:Date; b=RlXguFk+bzQ4AypPIEc+u8KfEM5ZeNTY9fDdpUgXSIbw3tBZkb1doluE9JQkSvOLd 0d41TdGpG7M04XKQ9vmmvbIHE+Bjjr6Xdj7pQL6UQZXf4CVoJcsvnAezq3kAtLkmiW eWeHtyZNOEwi5n5a35u62/RFcCLNshVFu+QB9BLwAmwQ7B6gDNuImb06uKpWx3Zcl2 Ns5T0WmGww3H5YoUS2SAR2rtvO0tkTlCJexutc89JS+eOo5GvPSkb5Mwb1nbwemq71 snxXl8COFx2VO9CZAfJ8pZC5QhZGDpeaIfrMLcUf1U6/DJj21Adp+Y6E3fmNaknBxz SIKV2DJwxqB4MyC4cjNTTveRX1b051NT5of+mqGNoGMbuZhmX4ctkXvLZkPrguNDUE orrlHaV4xNQAmJGstRwXX0RmYt+b+8xjTZcnxJ3IaT9q9joNbe/KyMNT4y1KZ1aYIX 7b5ja6pLwmd50CkViVebv3thaMW69dEYaMne+qJOFJjQb1MopMXU1KK+ti35s78JRx sA07ksDZwN7BLDLiQAMG73E1PWOfxo+UkSeGxu9OgqzvvtB8iRX6LitVkAMCDOfSqe KB4b942e5ivqrAishfQty/3rZAOcUo/tP4TnlMAteRLm/f2NPO8E1ApvipEWs12HPS vlD76tDFEP3CEdVIoinAAXw4= X-Mailer: git-send-email 2.41.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-guile@gnu.org List-Id: "Bug reports for GUILE, GNU's Ubiquitous Extension Language" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-guile-bounces+guile-bugs=m.gmane-mx.org@gnu.org Original-Sender: bug-guile-bounces+guile-bugs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.lisp.guile.bugs:10764 Archived-At: Until now, the ./meta/guile was not mentioned anywhere, and therefore it was not obvious how to run the locally compiled Guile without installing it. While modifying the file, I took the liberty to also mention a bit about compiling Guile using Guix. Finally, the header lines where cleaned up, ensuring all of them end at 70 and have a leading space. * HACKING (Hacking It Yourself): Add Guix instructions. Add a note about meta/guile script. (Sample GDB Initialization File), (Naming conventions): Clean up the header line. --- v2: Add note regarding JIT and GNU Hurd. Add note regarding -fexcess-precision. Add --disable-static and explain it. v3: Use -CP instead of --pure. HACKING | 38 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 36 insertions(+), 2 deletions(-) diff --git a/HACKING b/HACKING index 387643bf7..94fba199c 100644 --- a/HACKING +++ b/HACKING @@ -26,6 +26,40 @@ http://www.gnu.org/software/guile/mail/mail.html for more info. Hacking It Yourself ================================================== +You can spawn a shell with all the required dependencies using GNU Guix +by running the following command: + + guix shell -D -f guix.scm --pure + +In this way, you can effortlessly compile Guile from the Git checkout +with just these three lines: + + guix shell -CP -D -f guix.scm -- ./autogen.sh + guix shell -CP -D -f guix.scm -- ./configure \ + --enable-mini-gmp --disable-static + guix shell -CP -D -f guix.scm -- make + +Disabling of the static libraries is optional, but it does speed up the +builds, and you are unlikely to need them for local development. + + Note: Currently JIT causes Guile to crash in obscure ways on GNU Hurd, + so on that platform you want to also pass the --disable-jit flag + to the configure script. + + Note: On any i*86 architecture, you also need to pass in the compiler + flag -fexcess-precision=standard in order to get the test suite + to pass. That can be done by passing an additional argument to + the configure script: + CFLAGS='-g -O2 -fexcess-precision=standard' + +Once that finishes, you can execute your newly compiled Guile using the +./meta/guile script: + + $ guix shell -CP -D -f guix.scm -- ./meta/guile -v | head -n1 + guile (GNU Guile) 3.0.9.139-d7cf5-dirty + +For more manual approach, read on. + When Guile is obtained from Git, a few extra steps must be taken before the usual configure, make, make install. You will need to have up-to-date versions of the tools as listed below, correctly installed. @@ -73,7 +107,7 @@ Here is the authoritative list of tool/version/platform tuples that have been known to cause problems, and a short description of the problem. -Sample GDB Initialization File========================================= +Sample GDB Initialization File ======================================= In GDB, you probably want to load the gdbinit file included with Guile, which defines a number of GDB helpers to inspect Scheme values. @@ -215,7 +249,7 @@ The goal is to reduce (and over time, eliminate) spurious diffs. For Emacs users: (add-hook 'before-save-hook 'delete-trailing-whitespace) -Naming conventions ================================================= +Naming conventions =================================================== We use certain naming conventions to structure the considerable number of global identifiers. All identifiers should be either all lower -- 2.41.0