[haiku-commits] haiku: hrev54318 - docs/user/drivers

  • From: Axel Dörfler <axeld@xxxxxxxxxxxxxxxx>
  • To: haiku-commits@xxxxxxxxxxxxx
  • Date: Thu, 11 Jun 2020 06:39:38 -0400 (EDT)

hrev54318 adds 1 changeset to branch 'master'
old head: 3959883f5047e803205668d4eb7d083b2d81e2da
new head: bb6b48a9c3013e72ad79788692aba2ecb0423c1e
overview: 
https://git.haiku-os.org/haiku/log/?qt=range&q=bb6b48a9c301+%5E3959883f5047

----------------------------------------------------------------------------

bb6b48a9c301: FS Interface Docs: Made read_dir description clear
  
  Small change in the docs to make the explanation of read_dir
  functionality a little more clear.
  
  Change-Id: I202eb0f70b38c78962ad9ca1d267995977c04951
  Reviewed-on: https://review.haiku-os.org/c/haiku/+/2900
  Reviewed-by: Axel Dörfler <axeld@xxxxxxxxxxxxxxxx>

                                    [ CruxBox <shubhambhagat111@xxxxxxxxx> ]

----------------------------------------------------------------------------

Revision:    hrev54318
Commit:      bb6b48a9c3013e72ad79788692aba2ecb0423c1e
URL:         https://git.haiku-os.org/haiku/commit/?id=bb6b48a9c301
Author:      CruxBox <shubhambhagat111@xxxxxxxxx>
Date:        Wed Jun 10 16:50:32 2020 UTC
Committer:   Axel Dörfler <axeld@xxxxxxxxxxxxxxxx>
Commit-Date: Thu Jun 11 10:39:35 2020 UTC

----------------------------------------------------------------------------

1 file changed, 6 insertions(+), 4 deletions(-)
docs/user/drivers/fs_interface.dox | 10 ++++++----

----------------------------------------------------------------------------

diff --git a/docs/user/drivers/fs_interface.dox 
b/docs/user/drivers/fs_interface.dox
index cf27d1fa8e..7a548c892c 100644
--- a/docs/user/drivers/fs_interface.dox
+++ b/docs/user/drivers/fs_interface.dox
@@ -1406,12 +1406,14 @@
        aligned. A FS doesn't have to read more than one entry at a time, but 
it is
        recommended to support that for performance reasons.
 
-       When the function is invoked after the end of the directory has been
-       reached, it shall set the variable \a _num points to to \c 0 and return
-       \c B_OK. If the provided buffer is too small to contain even the single 
next
+       If the provided buffer is too small to contain even the single next
        entry, \c B_BUFFER_OVERFLOW shall be returned. It shall not fail, if at
        least one entry has been read, and the buffer is just too small to hold 
as
-       many entries as requested.
+       many entries as requested. When the function is invoked after the end of
+       the directory has been reached, it shall set the variable \a _num 
points to
+       \c 0 and return \c B_OK. Usually the function is invoked repeatedly 
until
+       then to get more entries. The \c cookie parameter must be used to track 
the
+       position in the directory.
 
        Note that a directory is expected to contain the special entries \c "." 
and
        \c "..", referring to the same directory and the parent directory


Other related posts:

  • » [haiku-commits] haiku: hrev54318 - docs/user/drivers - Axel Dörfler