unified MX27, MX25, MX37 trees

[karo-tx-redboot.git] / packages / io / fileio / v2_0 / doc / fileio.sgml

diff --git a/packages/io/fileio/v2_0/doc/fileio.sgml b/packages/io/fileio/v2_0/doc/fileio.sgml
index 3111fc32bbdc96875a3b2d738d766ec3bb40d4dd..2364c5d66f4a56ce7c97085ceb0ab8c98b048ce0 100644 (file)
--- a/packages/io/fileio/v2_0/doc/fileio.sgml
+++ b/packages/io/fileio/v2_0/doc/fileio.sgml
@@ -520,8 +520,14 @@ specifier of <literal>SEEK_SET</literal>.
 Most of these considerations are invisible to clients of a filesystem
 since they will access directories via the POSIX
 <function>opendir()</function>, <function>readdir()</function> and
-<function>closedir()</function> functions.
-</para>
+<function>closedir()</function> functions. The <structname> struct
+dirent</structname> object returned by <function>readdir()</function>
+will always contain <structname>d_name</structname> as required by
+POSIX. When <literal>CYGPKG_FILEIO_DIRENT_DTYPE</literal> is enabled
+it will also contain <structname>d_type</structname>, which is not
+part of POSIX, but often implemented by OSes. Currently only the
+FATFS, RAMFS, ROMFS and JFFS2 filesystem sets this value. For other
+filesystems a value of 0 will be returned in the member.</para>
 
 <para>
 Support for the <function>getcwd()</function> function is provided by
@@ -1193,4 +1199,4 @@ examples of how this has been done.
 
 <!-- }}} -->
 
-</part>
\ No newline at end of file
+</part>