summaryrefslogtreecommitdiff
path: root/doc/guix.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/guix.texi')
-rw-r--r--doc/guix.texi7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index bcf07a6b35..a20bca677d 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -2469,6 +2469,13 @@ This variable is exported by @code{(guix build-system ruby)}. It
implements the RubyGems build procedure used by Ruby packages, which
involves running @code{gem build} followed by @code{gem install}.
+The @code{source} field of a package that uses this build system is
+expected to reference a gem archive instead of a traditional tarball,
+since this is the format that all Ruby developers use when releasing
+their software. The build system unpacks the gem archive, potentially
+patches the source, runs the test suite, repackages the gem, and
+installs it.
+
Which Ruby package is used can be specified with the @code{#:ruby}
parameter. A list of additional flags to be passed to the @command{gem}
command can be specified with the @code{#:gem-flags} parameter.