aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/src
diff options
context:
space:
mode:
authorJan Daniel Bothma <jan.bothma@erlang-solutions.com>2012-11-14 18:01:07 +0100
committerPatrik Nyblom <pan@erlang.org>2012-12-20 14:58:31 +0100
commitd96af2dd3333e8870523402de97f022796c34b5c (patch)
tree249f1abd9845010afc0ff728ec84f11cce6ef233 /lib/kernel/src
parente69d4d80e0dbb1916fb6900a2b47e0fdf85aea61 (diff)
downloadotp-d96af2dd3333e8870523402de97f022796c34b5c.tar.gz
otp-d96af2dd3333e8870523402de97f022796c34b5c.tar.bz2
otp-d96af2dd3333e8870523402de97f022796c34b5c.zip
Basic documentation of the 'ram' mode in the 'file' module
Diffstat (limited to 'lib/kernel/src')
-rw-r--r--lib/kernel/src/file.erl5
1 files changed, 3 insertions, 2 deletions
diff --git a/lib/kernel/src/file.erl b/lib/kernel/src/file.erl
index 22af38c598..85426baba1 100644
--- a/lib/kernel/src/file.erl
+++ b/lib/kernel/src/file.erl
@@ -88,7 +88,7 @@
| {'cur', Offset :: integer()}
| {'eof', Offset :: integer()} | 'bof' | 'cur' | 'eof'.
-type mode() :: 'read' | 'write' | 'append'
- | 'exclusive' | 'raw' | 'binary'
+ | 'exclusive' | 'raw' | 'binary' | 'ram'
| {'delayed_write',
Size :: non_neg_integer(),
Delay :: non_neg_integer()}
@@ -397,7 +397,8 @@ raw_write_file_info(Name, #file_info{} = Info) ->
%% Contemporary mode specification - list of options
--spec open(Filename, Modes) -> {ok, IoDevice} | {error, Reason} when
+-spec open(File, Modes) -> {ok, IoDevice} | {error, Reason} when
+ File :: Filename | iodata(),
Filename :: name(),
Modes :: [mode()],
IoDevice :: io_device(),