aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/src
diff options
context:
space:
mode:
authorBjörn-Egil Dahlberg <[email protected]>2011-12-07 23:37:11 +0100
committerBjörn-Egil Dahlberg <[email protected]>2011-12-08 14:12:03 +0100
commit965db6494f80e4c784aa3bb1cd96dd925ce8b284 (patch)
tree3fe61d9c128b67479af5b8e4f5fa19fa28a56936 /lib/kernel/src
parent9dd83933601f3c933718874c13d83ca952febc3f (diff)
downloadotp-965db6494f80e4c784aa3bb1cd96dd925ce8b284.tar.gz
otp-965db6494f80e4c784aa3bb1cd96dd925ce8b284.tar.bz2
otp-965db6494f80e4c784aa3bb1cd96dd925ce8b284.zip
Document file:*_file_info/2
* file:read_file_info/2 * file:write_file_info/3 Document options and time behavior.
Diffstat (limited to 'lib/kernel/src')
-rw-r--r--lib/kernel/src/file.erl10
1 files changed, 7 insertions, 3 deletions
diff --git a/lib/kernel/src/file.erl b/lib/kernel/src/file.erl
index 7a48d34a09..b253b3e901 100644
--- a/lib/kernel/src/file.erl
+++ b/lib/kernel/src/file.erl
@@ -109,6 +109,10 @@
-type posix_file_advise() :: 'normal' | 'sequential' | 'random'
| 'no_reuse' | 'will_need' | 'dont_need'.
-type sendfile_option() :: {chunk_size, non_neg_integer()}.
+-type file_info_option() :: {'time', 'local'} | {'time', 'universal'}
+ | {'time', 'posix'}.
+
+
%%%-----------------------------------------------------------------
%%% General functions
@@ -218,7 +222,7 @@ read_file_info(Name) ->
-spec read_file_info(Filename, Opts) -> {ok, FileInfo} | {error, Reason} when
Filename :: name(),
- Opts :: list(),
+ Opts :: [file_info_option()],
FileInfo :: file_info(),
Reason :: posix() | badarg.
@@ -240,7 +244,7 @@ read_link_info(Name) ->
-spec read_link_info(Name, Opts) -> {ok, FileInfo} | {error, Reason} when
Name :: name(),
- Opts :: list(),
+ Opts :: [file_info_option()],
FileInfo :: file_info(),
Reason :: posix() | badarg.
@@ -266,7 +270,7 @@ write_file_info(Name, Info = #file_info{}) ->
-spec write_file_info(Filename, FileInfo, Opts) -> ok | {error, Reason} when
Filename :: name(),
- Opts :: list(),
+ Opts :: [file_info_option()],
FileInfo :: file_info(),
Reason :: posix() | badarg.