diff mbox

[2/2] doc: Document extra-packages argument of base-initrd.

Message ID 20160802074318.2572-3-sleep_walker@gnu.org
State New
Headers show

Commit Message

Tomáš Čech Aug. 2, 2016, 7:43 a.m. UTC
* doc/guix.texi(Initial RAM Disk): Describe extra-modules parameter in
  definition of base-initrd. Mention it under example of use of
  extra-packges.
---
 doc/guix.texi | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

Comments

Vincent Legoll Aug. 2, 2016, 8:19 a.m. UTC | #1
On Tue, Aug 2, 2016 at 9:43 AM, Tomáš Čech <sleep_walker@gnu.org> wrote:
> * doc/guix.texi(Initial RAM Disk): Describe extra-modules parameter in
>   definition of base-initrd. Mention it under example of use of
>   extra-packges.
> ---
>  doc/guix.texi | 10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)
>
> diff --git a/doc/guix.texi b/doc/guix.texi
> index 786fe55..27a4cea 100644
> --- a/doc/guix.texi
> +++ b/doc/guix.texi
> @@ -10183,6 +10183,9 @@ system declaration like this:
>                   rest)))
>  @end example
>
> +In a similar way you can add programs to packed into initrd using
> +@code{#:extra-packages}.

"to pack in the" maybe ?

>  The @code{base-initrd} procedure also handles common use cases that
>  involves using the system as a QEMU guest, or as a ``live'' system with
>  volatile root file system.
> @@ -10233,7 +10236,7 @@ further.
>
>  @deffn {Monadic Procedure} base-initrd @var{file-systems} @
>         [#:qemu-networking? #f] [#:virtio? #t] [#:volatile-root? #f] @
> -       [#:extra-modules '()] [#:mapped-devices '()]
> +       [#:extra-packages '()] [#:extra-modules '()] [#:mapped-devices '()]
>  Return a monadic derivation that builds a generic initrd.  @var{file-systems} is
>  a list of file systems to be mounted by the initrd, possibly in addition to
>  the root file system specified on the kernel command line via @code{--root}.
> @@ -10251,6 +10254,11 @@ The initrd is automatically populated with all the kernel modules necessary
>  for @var{file-systems} and for the given options.  However, additional kernel
>  modules can be listed in @var{extra-modules}.  They will be added to the initrd, and
>  loaded at boot time in the order in which they appear.
> +
> +Additional packages can be added through @var{extra-packages}. This is
> +useful mostly for development and debugging purposes but it can also be
> +used to extend set of commands available in case of interactive
> +recovery.
>  @end deffn

"to extend the set"
diff mbox

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index 786fe55..27a4cea 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -10183,6 +10183,9 @@  system declaration like this:
                  rest)))
 @end example
 
+In a similar way you can add programs to packed into initrd using
+@code{#:extra-packages}.
+
 The @code{base-initrd} procedure also handles common use cases that
 involves using the system as a QEMU guest, or as a ``live'' system with
 volatile root file system.
@@ -10233,7 +10236,7 @@  further.
 
 @deffn {Monadic Procedure} base-initrd @var{file-systems} @
        [#:qemu-networking? #f] [#:virtio? #t] [#:volatile-root? #f] @
-       [#:extra-modules '()] [#:mapped-devices '()]
+       [#:extra-packages '()] [#:extra-modules '()] [#:mapped-devices '()]
 Return a monadic derivation that builds a generic initrd.  @var{file-systems} is
 a list of file systems to be mounted by the initrd, possibly in addition to
 the root file system specified on the kernel command line via @code{--root}.
@@ -10251,6 +10254,11 @@  The initrd is automatically populated with all the kernel modules necessary
 for @var{file-systems} and for the given options.  However, additional kernel
 modules can be listed in @var{extra-modules}.  They will be added to the initrd, and
 loaded at boot time in the order in which they appear.
+
+Additional packages can be added through @var{extra-packages}. This is
+useful mostly for development and debugging purposes but it can also be
+used to extend set of commands available in case of interactive
+recovery.
 @end deffn
 
 Needless to say, the initrds we produce and use embed a