From 02aca536aec93edd799d67615e47bdb7b5babf4a Mon Sep 17 00:00:00 2001
From: Hans Bolinder
Date: Fri, 9 Oct 2015 13:02:25 +0200
Subject: [kernel] Correct documentation
Fix mistakes found by 'xmllint'.
---
lib/kernel/doc/src/file.xml | 25 ++++++++++++-------------
1 file changed, 12 insertions(+), 13 deletions(-)
(limited to 'lib/kernel/doc/src/file.xml')
diff --git a/lib/kernel/doc/src/file.xml b/lib/kernel/doc/src/file.xml
index 4954568086..9cd4cfa712 100644
--- a/lib/kernel/doc/src/file.xml
+++ b/lib/kernel/doc/src/file.xml
@@ -87,9 +87,10 @@
- fd()
+ fd()
- A file descriptor representing a file opened in
+ A file descriptor representing a file opened in raw mode.
@@ -491,7 +492,7 @@
List files in a directory
- Lists all files in a directory, except files
+
Lists all files in a directory, except files
with "raw" names. Returns
{ok, Filenames} if successful.
Otherwise, it returns {error, Reason}.
@@ -1307,15 +1308,15 @@
-
The current system access to the file.
- atime = date_time() | integer() >= 0
+ atime = date_time() | integer() >= 0
-
The last time the file was read.
- mtime = date_time() | integer() >= 0
+ mtime = date_time() | integer() >= 0
-
The last time the file was written.
- ctime = date_time() | integer() >=0
+ ctime = date_time() | integer() >=0
-
The interpretation of this time field depends on
the operating system. On Unix, it is the last time
@@ -1745,7 +1746,7 @@
See gen_tcp:controlling_process/2
If the OS used does not support sendfile, an Erlang fallback
using file:read and gen_tcp:send is used.
- The option list can contain the following options:
+
The option list can contain the following options:
chunk_size
- The chunk size used by the erlang fallback to send
@@ -1760,7 +1761,6 @@
the sendfile call will return {error,einval}.
Introduced in Erlang/OTP 17.0. Default is false.
-
@@ -1851,22 +1851,21 @@
Type local will interpret the time set as local, universal will
interpret it as universal time and posix must be seconds since
or before unix time epoch which is 1970-01-01 00:00 UTC.
- Default is {time, local}.
+ Default is {time, local}.
If the raw option is set, the file server will not be called
and only informations about local files will be returned.
-
The following fields are used from the record, if they are
given.
- atime = date_time() | integer() >= 0
+ atime = date_time() | integer() >= 0
-
The last time the file was read.
- mtime = date_time() | integer() >= 0
+ mtime = date_time() | integer() >= 0
-
The last time the file was written.
- ctime = date_time() | integer() >= 0
+ ctime = date_time() | integer() >= 0
-
On Unix, any value give for this field will be ignored
(the "ctime" for the file will be set to the current
--
cgit v1.2.3