summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Högberg <john@erlang.org>2021-08-23 17:34:17 +0200
committerJohn Högberg <john@erlang.org>2021-08-23 17:38:59 +0200
commit9840537ab271ab25a1f1bb4643f787555b8d9bff (patch)
tree22682e747d0e2091f9abb7d35f565bf2fa71aa7e
parent9246e531029909c10e19268d748b095e60107e92 (diff)
downloaderlang-9840537ab271ab25a1f1bb4643f787555b8d9bff.tar.gz
kernel: Recommend against opening NFS-mounted files
-rw-r--r--lib/kernel/doc/src/file.xml7
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/kernel/doc/src/file.xml b/lib/kernel/doc/src/file.xml
index 42798530bd..aa1201d381 100644
--- a/lib/kernel/doc/src/file.xml
+++ b/lib/kernel/doc/src/file.xml
@@ -988,6 +988,13 @@ f.txt: {person, "kalle", 25}.
An <c><anno>IoDevice</anno></c> returned from this call can be used
as an argument to the I/O functions (see
<seeerl marker="stdlib:io"><c>io(3)</c></seeerl>).</p>
+ <warning>
+ <p>While this function can be used to open any file, we recommend
+ against using it for NFS-mounted files, FIFOs, devices, or
+ similar since they can cause IO threads to hang forever.</p>
+ <p>If your application needs to interact with these kinds of files we
+ recommend breaking out those parts to a port program instead.</p>
+ </warning>
<note>
<p>In previous versions of <c>file</c>, modes were specified
as one of the atoms <c>read</c>, <c>write</c>, or