02/05: doc: Document 'mount-may-fail?' field.

[guix-commits]

civodul pushed a commit to branch master
in repository guix.

commit c471d4733f066f70e8ec9997e96c0096758aac29
Author: Ludovic Courtès <ludo@gnu.org>
AuthorDate: Mon Aug 3 17:14:54 2020 +0200

    doc: Document 'mount-may-fail?' field.
    
    This is a followup to 7c27bd115b14afd142da7684cc349369965f9eab.
    
    * doc/guix.texi (File Systems): Document 'mount-may-fail?'.
---
 doc/guix.texi | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/guix.texi b/doc/guix.texi
index f9cb7f2..0c8c284 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