[erlang-patches] fm/file-operations

[Tuncer Ayaz]

2010/5/19 Björn Gustavsson:
> We hope to graduate this branch soon, but with
> a few changes:
>
> The get_int64() macro that you used did not actually
> work (it was not actually used before), so I have corrected
> it in a separate commit:
>
> http://github.com/bjorng/otp/commit/1a4c6275d3cb1d91db376a854bdda083c63f0feb
>
>
> I also did a minor clean-up in a commit that is separate now, but
> I want to combine it with your commit:
>
> http://github.com/bjorng/otp/commit/1d477960292a6065231763e9691949aac818d3a8
>
> If you don't like this change, please tell us so as soon as possible.
>
>
> Here is the fetch command to fetch the updated branch:
>
> git fetch git://github.com/bjorng/otp.git fm/file-operations

I would prefer the documentation to be more in line with the existing
text in file.xml, use the same order of advise values as in the
original manpage and be less specific about the effect.

--- a/file.xml
+++ b/file.xml
@@ -69,16 +69,15 @@ time() = {{Year, Month, Day}, {Hour, Minute, Second}}
         <v>Offset = int()</v>
         <v>Length = int()</v>
         <v>Advise = posix_file_advise()</v>
-        <v>posix_file_advise() = normal | sequential | random | will_need
-          | dont_need | no_reuse</v>
+        <v>posix_file_advise() = normal | sequential | random | no_reuse
+          | will_need | dont_need</v>
         <v>Reason = ext_posix()</v>
       </type>
       <desc>
-        <p>This function allows the Operating System to perform caching
-           optimizations for accessing a file's data.</p>
-        <p>This function is available only on POSIX compliant systems.
-           For systems that are not POSIX compliant, this function has
-           no effect when invoked.</p>
+        <p><c>advise</c> can be used to announce an intention to access file
+          data in a specific pattern in the future, thus allowing the
+          operating system to perform appropriate optimizations.</p>
+        <p>On some platforms, this function might have no effect.</p>
       </desc>
     </func>
     <func>