From: Tomas Volf <~@wolfsden.cz>
To: guile-devel@gnu.org
Cc: Tomas Volf <~@wolfsden.cz>
Subject: [PATCH] Add more detailed instructions into the HACKING file.
Date: Wed, 29 Nov 2023 17:40:29 +0100 [thread overview]
Message-ID: <20231129164054.15881-1-~@wolfsden.cz> (raw)
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
next reply other threads:[~2023-11-29 16:40 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-29 16:40 Tomas Volf [this message]
2023-12-04 21:06 ` [PATCH] Add more detailed instructions into the HACKING file Maxime Devos
2023-12-04 23:12 ` Tomas Volf
2023-12-15 22:16 ` Maxime Devos
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/guile/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='20231129164054.15881-1-~@wolfsden.cz' \
--to=~@wolfsden.cz \
--cc=guile-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).