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.devel Subject: [PATCH] Add more detailed instructions into the HACKING file. Date: Wed, 29 Nov 2023 17:40:29 +0100 Message-ID: <20231129164054.15881-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="32115"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Tomas Volf <~@wolfsden.cz> To: guile-devel@gnu.org Original-X-From: guile-devel-bounces+guile-devel=m.gmane-mx.org@gnu.org Wed Nov 29 17:41:32 2023 Return-path: Envelope-to: guile-devel@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 1r8Ncy-00089X-59 for guile-devel@m.gmane-mx.org; Wed, 29 Nov 2023 17:41:32 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1r8Nca-0006AI-2H; Wed, 29 Nov 2023 11:41:08 -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 1r8NcX-0006A5-Qt for guile-devel@gnu.org; Wed, 29 Nov 2023 11:41:05 -0500 Original-Received: from wolfsden.cz ([37.205.8.62]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1r8NcS-0004ol-8b for guile-devel@gnu.org; Wed, 29 Nov 2023 11:41:05 -0500 Original-Received: by wolfsden.cz (Postfix, from userid 104) id 462D125FC54; Wed, 29 Nov 2023 16:40:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=wolfsden.cz; s=mail; t=1701276057; bh=k7h8sDo1v/DyIovMUHlZOvLuOI4HtSdpZCd4tOhwuUY=; h=From:To:Cc:Subject:Date; b=V7BcSaIUB0DOwJaNt5YvGYcekRjV/YoLmUxuBqALX4AQGpaWI5WkMOAIqUafBfRe6 s9HZOVT6ZVr14ZrFJW8kvNWxoC+LR1I0PKFKe6RP2LS/JhqNo3OTwzwFvA+ixetg9d 3cWzRj0MrXYM16lGV/xTPjLlflaj2PKU6knRCbM+i+rhIkfcewWdhslSeC2Pau8wvd FnszJelwJSrsP2l8uXUvkUM2RNyRxe6FqGUadssjVJAk1VYkOnhurTqbOBq28OvlLj lSN1Xgwu7GWxoZR2gNAwN7tr2fRO8g8ACCi78razRH8l4lIkQFXYMhSz0tgo/GILLc SHgVZxt7nLXvj5UPDwwffGHwpqrHJbhamBBfqAtHg2FfhQB7NXm4ZiE7Dy472MdP8l KZBMFRqg4ppSL5e0UPhqGXrGcYSWt87w7rPyEIEYgXaJhSH04MwKs2tGstgZvmDWhv G8r7H8JTmYyoygqCgY3Rl7KFRJiMFtzDP9jyN3MzIvcmT1bngw/QQRPD5oHa2EuvYW LQyMcAx4QbVmqgYAfLvOp+jaMk3H7Qupo4RFPEIXxdNw23+GsvfWTLyMJGuAT7dTNn fgjdtAIuCJPDCx3TwrqEagjvXWYJKvrKQ/V3QarbBTDoXqCC387EmSaVP0AUn6WO6b uYWUlxEUS3BwiDCsDz55u1qY= Original-Received: from localhost (unknown [81.17.16.69]) by wolfsden.cz (Postfix) with ESMTPSA id 8EE77261309; Wed, 29 Nov 2023 16:40:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=wolfsden.cz; s=mail; t=1701276056; bh=k7h8sDo1v/DyIovMUHlZOvLuOI4HtSdpZCd4tOhwuUY=; h=From:To:Cc:Subject:Date; b=HfvQiJuizsAR7A8j69HYaRyJkFWKyVLlYoaocxwWa0+WPKsm5nqZIfovrMWyN34wA Cd7PdYQgDFHMY8fPn0h2il1wZGlQLxfi496r0E2yvSMPJbn7xretBux6zzkp1a3wM1 gCJNZSb9rbHySrjTPgRiDPR0v2Nu0v0L4/F3l2nfzxVAWyCH9+xfxHA64cpzuf8kaD 8aXBpn5Hpbjjl+gie68LUw1Ig4mAOzD55SuDs38MnxpL5R/WfsiXL/NxvkTjMxKZhf uXbTvOFZhIA5I0jOtIOQ39UsUOV+5IaKYnzYv7cSgal27wXH7n7O8C78HsM4c4Orub qkANrbpSqllGroLZ6n/wkGj1GymEZJXCS2YMT3Bak6R+tDuvoRoaSSeXY5La5/Uspq wNVSQtvU9+L04sKTQq+7UZnnq6w+rz8mUbQ5ebU2mOKybCOiNe3zfn51wFE+WrVYeT c8WCN2/tr/woQdeaKpew5AxO9MuAwRj/84+yxo2iB4bk+MNyBqeq1KCGCf1MSzsuda 6+cghUEmzcSMj8g+KTbPS2JKXR22QnCD/TYPLeFmdr7Uz6XukewnHxdHMfTQgofo4D SYkgPUd6eg8cIBjHo9ZskDJUesVejo6NoDFrKRArM1FvBSzpykJ/d+XkoYVZWeEiDu dvh+K5fpS3AbidUirWJkJHG8= Original-Received: from localhost (localhost [local]) by localhost (OpenSMTPD) with ESMTPA id 2e067405; Wed, 29 Nov 2023 16:40:55 +0000 (UTC) X-Mailer: git-send-email 2.41.0 Received-SPF: none client-ip=37.205.8.62; envelope-from=ws@wolfsnet.cz; helo=wolfsden.cz X-Spam_score_int: -17 X-Spam_score: -1.8 X-Spam_bar: - X-Spam_report: (-1.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, HEADER_FROM_DIFFERENT_DOMAINS=0.249, SPF_HELO_PASS=-0.001, SPF_NONE=0.001, T_SCC_BODY_TEXT_LINE=-0.01, UNPARSEABLE_RELAY=0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: guile-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Developers list for Guile, the GNU extensibility library" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guile-devel-bounces+guile-devel=m.gmane-mx.org@gnu.org Original-Sender: guile-devel-bounces+guile-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.lisp.guile.devel:22142 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. --- I think this will make it easier for people to start hacking on the Guile. HACKING | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/HACKING b/HACKING index 387643bf7..ae39218fa 100644 --- a/HACKING +++ b/HACKING @@ -26,6 +26,26 @@ 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 -D -f guix.scm --pure -- ./autogen.sh + guix shell -D -f guix.scm --pure -- ./configure --enable-mini-gmp + guix shell -D -f guix.scm --pure -- make + +Once that finishes, you can execute your newly compiled Guile using the +./meta/guile script: + + $ ./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 +93,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 +235,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