aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2020-12-03 16:15:00 +0100
committerLudovic Courtès <ludo@gnu.org>2020-12-03 16:18:44 +0100
commitb5a6eddd8e9f2e840f47d3307f436433e74e16f3 (patch)
treeb8338f21c9dfd1f432714f2eb31a6f5043dd5c8f
parenteee037ec877b3674ce2c3198a58c8cd97c972df7 (diff)
downloadguix-b5a6eddd8e9f2e840f47d3307f436433e74e16f3.tar
guix-b5a6eddd8e9f2e840f47d3307f436433e74e16f3.tar.gz
doc: Tweak wording of 'chicken-build-system' material.
* doc/guix.texi (Build Systems): Fix spelling of "CHICKEN". Add xref to its web site. Tweak wording.
-rw-r--r--doc/guix.texi19
1 files changed, 10 insertions, 9 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 9835d19d2b..80185e0731 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -7336,26 +7336,27 @@ defined by the crate.
@end defvr
@defvr {Scheme Variable} chicken-build-system
-This variable is exported by @code{(guix build-system chicken)}.
-It builds Chicken Scheme modules (also called ``eggs'' or ``extensions'').
-Chicken generates C source code, which then gets compiled by a C compiler,
-in this case GCC.
+This variable is exported by @code{(guix build-system chicken)}. It
+builds @uref{https://call-cc.org/, CHICKEN Scheme} modules, also called
+``eggs'' or ``extensions''. CHICKEN generates C source code, which then
+gets compiled by a C compiler, in this case GCC.
-It adds @code{chicken} to the package inputs, as well as the packages of
-@code{gnu-build-system}.
+This build system adds @code{chicken} to the package inputs, as well as
+the packages of @code{gnu-build-system}.
The build system can't (yet) deduce the egg's name automatically, so just like
with @code{go-build-system} and its @code{#:import-path}, you should define
@code{#:egg-name} in the package's @code{arguments} field.
-For example, if you are packaging the srfi-1 egg:
+For example, if you are packaging the @code{srfi-1} egg:
+
@lisp
(arguments '(#:egg-name "srfi-1"))
@end lisp
Egg dependencies must be defined in @code{propagated-inputs}, not @code{inputs}
-because Chicken doesn't embed absolute references in compiled eggs.
-Test dependecies should go to @code{native-inputs}, as usual.
+because CHICKEN doesn't embed absolute references in compiled eggs.
+Test dependencies should go to @code{native-inputs}, as usual.
@end defvr
@defvr {Scheme Variable} copy-build-system