From 9dd60c47d4e91f39933edc97840bbd68f10c55d8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= <bjorn@erlang.org>
Date: Wed, 13 Feb 2013 14:29:14 +0100
Subject: file: Document list_dir_all/1 and read_link_all/1

---
 lib/kernel/doc/src/file.xml | 59 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 58 insertions(+), 1 deletion(-)

(limited to 'lib/kernel/doc/src')

diff --git a/lib/kernel/doc/src/file.xml b/lib/kernel/doc/src/file.xml
index 4851a53dd9..22a04c6c13 100644
--- a/lib/kernel/doc/src/file.xml
+++ b/lib/kernel/doc/src/file.xml
@@ -496,7 +496,8 @@
       <name name="list_dir" arity="1"/>
       <fsummary>List files in a directory</fsummary>
       <desc>
-        <p>Lists all the files in a directory. Returns
+        <p>Lists all files in a directory, <b>except</b> files
+	with "raw" names. Returns
           <c>{ok, <anno>Filenames</anno>}</c> if successful.
           Otherwise, it returns <c>{error, <anno>Reason</anno>}</c>.
           <c><anno>Filenames</anno></c> is a list of
@@ -516,6 +517,31 @@
         </taglist>
       </desc>
     </func>
+    <func>
+      <name name="list_dir_all" arity="1"/>
+      <fsummary>List all files in a directory</fsummary>
+      <desc>
+        <p>Lists all the files in a directory, including files with
+	"raw" names.
+	Returns <c>{ok, <anno>Filenames</anno>}</c> if successful.
+          Otherwise, it returns <c>{error, <anno>Reason</anno>}</c>.
+          <c><anno>Filenames</anno></c> is a list of
+          the names of all the files in the directory. The names are
+          not sorted.</p>
+        <p>Typical error reasons are:</p>
+        <taglist>
+          <tag><c>eacces</c></tag>
+          <item>
+            <p>Missing search or write permissions for <c><anno>Dir</anno></c>
+              or one of its parent directories.</p>
+          </item>
+          <tag><c>enoent</c></tag>
+          <item>
+            <p>The directory does not exist.</p>
+          </item>
+        </taglist>
+      </desc>
+    </func>
     <func>
       <name name="make_dir" arity="1"/>
       <fsummary>Make a directory</fsummary>
@@ -1399,12 +1425,43 @@
     <func>
       <name name="read_link" arity="1"/>
       <fsummary>See what a link is pointing to</fsummary>
+      <desc>
+        <p>This function returns <c>{ok, <anno>Filename</anno>}</c> if
+          <c><anno>Name</anno></c> refers to a symbolic link that is
+	  not a "raw" file name, or <c>{error, <anno>Reason</anno>}</c>
+	  otherwise.
+          On platforms that do not support symbolic links, the return
+          value will be <c>{error,enotsup}</c>.</p>
+        <p>Typical error reasons:</p>
+        <taglist>
+          <tag><c>einval</c></tag>
+          <item>
+            <p><c><anno>Name</anno></c> does not refer to a symbolic link
+	    or the name of the file that it refers to does not conform
+	    to the expected encoding.</p>
+          </item>
+          <tag><c>enoent</c></tag>
+          <item>
+            <p>The file does not exist.</p>
+          </item>
+          <tag><c>enotsup</c></tag>
+          <item>
+            <p>Symbolic links are not supported on this platform.</p>
+          </item>
+        </taglist>
+      </desc>
+    </func>
+    <func>
+      <name name="read_link_all" arity="1"/>
+      <fsummary>See what a link is pointing to</fsummary>
       <desc>
         <p>This function returns <c>{ok, <anno>Filename</anno>}</c> if
           <c><anno>Name</anno></c> refers to a symbolic link or
           <c>{error, <anno>Reason</anno>}</c> otherwise.
           On platforms that do not support symbolic links, the return
           value will be <c>{error,enotsup}</c>.</p>
+	  <p>Note that <c><anno>Filename</anno></c> can be either a list
+	  or a binary.</p>
         <p>Typical error reasons:</p>
         <taglist>
           <tag><c>einval</c></tag>
-- 
cgit v1.2.3