From 965db6494f80e4c784aa3bb1cd96dd925ce8b284 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= Date: Wed, 7 Dec 2011 23:37:11 +0100 Subject: Document file:*_file_info/2 * file:read_file_info/2 * file:write_file_info/3 Document options and time behavior. --- lib/kernel/src/file.erl | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'lib/kernel/src/file.erl') 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. -- cgit v1.2.3