summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorMaxim Cournoyer <maxim.cournoyer@gmail.com>2020-11-11 23:48:12 -0500
committerMaxim Cournoyer <maxim.cournoyer@gmail.com>2020-11-17 15:20:03 -0500
commit41f27bf8702838f19b1dc5ffee8eec1d4315d4e6 (patch)
tree2122f9c5136e8aa94b0f3288c09baca96d51c366 /doc
parentac96f2c8369c13dd7d27878ad9426fcda140ef3a (diff)
downloadguix-41f27bf8702838f19b1dc5ffee8eec1d4315d4e6.tar.gz
guix: system: Make disk-image root file system non-volatile by default.
And add a new '--volatile' option to have it volatile otherwise.

* guix/scripts/system.scm (%options)[volatile-root?]: New boolean option.
(%default-options): Set its default value to #f.
(show-help): Add help doc.
* guix/scripts/system.scm (perform-action): Propagate option...
(system-derivation-for-action): ...here.  Use it to set the volatile-root?
field of the image object passed to SYSTEM-IMAGE.
* doc/guix.texi (Invoking guix system): Document it.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 104e771562..cca57140d6 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -31029,10 +31029,12 @@ the @option{--image-size} option is ignored in the case of
 
 @cindex disk-image, creating disk images
 The @code{disk-image} command can produce various image types.  The
-image type can be selected using the @command{--image-type} option.  It
+image type can be selected using the @option{--image-type} option.  It
 defaults to @code{raw}.  When its value is @code{iso9660}, the
 @option{--label} option can be used to specify a volume ID with
-@code{disk-image}.  When using @code{disk-image}, the bootloader
+@code{disk-image}.  By default, the root file system of a disk image is
+mounted non-volatile; the @option{--volatile} option can be provided to
+make it volatile instead.  When using @code{disk-image}, the bootloader
 installed on the generated image is taken from the provided
 @code{operating-system} definition.  The following example demonstrates
 how to generate an image that uses the @code{grub-efi-bootloader}