summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2020-08-03 17:14:54 +0200
committerLudovic Courtès <ludo@gnu.org>2020-08-03 17:14:54 +0200
commitc471d4733f066f70e8ec9997e96c0096758aac29 (patch)
tree274beb5e04334de00e104fba979d5a58a7ad0c96 /doc
parent48f4927c10fb1ade3b067af442ced9dbbb77f0a1 (diff)
downloadguix-c471d4733f066f70e8ec9997e96c0096758aac29.tar.gz
doc: Document 'mount-may-fail?' field.
This is a followup to 7c27bd115b14afd142da7684cc349369965f9eab.

* doc/guix.texi (File Systems): Document 'mount-may-fail?'.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index f9cb7f204b..0c8c284a84 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -12165,6 +12165,12 @@ errors before being mounted.
 @item @code{create-mount-point?} (default: @code{#f})
 When true, the mount point is created if it does not exist yet.
 
+@item @code{mount-may-fail?} (default: @code{#f})
+When true, this indicates that mounting this file system can fail but
+that should not be considered an error.  This is useful in unusual
+cases; an example of this is @code{efivarfs}, a file system that can
+only be mounted on EFI/UEFI systems.
+
 @item @code{dependencies} (default: @code{'()})
 This is a list of @code{<file-system>} or @code{<mapped-device>} objects
 representing file systems that must be mounted or mapped devices that