summary refs log tree commit diff
path: root/gnu/system/linux-initrd.scm
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2014-07-17 17:49:34 +0200
committerLudovic Courtès <ludo@gnu.org>2014-07-17 17:49:34 +0200
commitfd1b1fa296886652ec34a117b6289cb64f471a97 (patch)
treef775dd78daeededfab88a1d15ebcf700314f4790 /gnu/system/linux-initrd.scm
parenta1906758c31036c30f8c11703daa4202adde8dac (diff)
downloadguix-fd1b1fa296886652ec34a117b6289cb64f471a97.tar.gz
doc: Add "Initial RAM Disk" section.
* doc/guix.texi (Initial RAM Disk): New node.
* gnu/system/linux-initrd.scm (expression->initrd): Adjust docstring.
Diffstat (limited to 'gnu/system/linux-initrd.scm')
-rw-r--r--gnu/system/linux-initrd.scm12
1 files changed, 7 insertions, 5 deletions
diff --git a/gnu/system/linux-initrd.scm b/gnu/system/linux-initrd.scm
index afbfc692d3..9e39f2d663 100644
--- a/gnu/system/linux-initrd.scm
+++ b/gnu/system/linux-initrd.scm
@@ -57,11 +57,13 @@
                              (to-copy '())
                              (linux #f)
                              (linux-modules '()))
-  "Return a package that contains a Linux initrd (a gzipped cpio archive)
-containing GUILE and that evaluates EXP upon booting.  LINUX-MODULES is a list
-of `.ko' file names to be copied from LINUX into the initrd.  TO-COPY is a
-list of additional derivations or packages to copy to the initrd.  MODULES is
-a list of Guile module names to be embedded in the initrd."
+  "Return a derivation that builds a Linux initrd (a gzipped cpio archive)
+containing GUILE and that evaluates EXP, a G-expression, upon booting.
+
+LINUX-MODULES is a list of '.ko' file names to be copied from LINUX into the
+initrd.  TO-COPY is a list of additional derivations or packages to copy to
+the initrd.  MODULES is a list of Guile module names to be embedded in the
+initrd."
 
   ;; General Linux overview in `Documentation/early-userspace/README' and
   ;; `Documentation/filesystems/ramfs-rootfs-initramfs.txt'.