Skip to content

Commit 906d58f

Browse files
committed
docs/uos: De-conditionalize statvfs() description.
It's a standard function, and it's already described (in the library intro) that for any given port, any function may be missing.
1 parent 0a861db commit 906d58f

1 file changed

Lines changed: 20 additions & 22 deletions

File tree

docs/library/uos.rst

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -61,28 +61,26 @@ Functions
6161

6262
Get the status of a file or directory.
6363

64-
.. only:: port_unix or port_pyboard or port_esp8266
65-
66-
.. function:: statvfs(path)
67-
68-
Get the status of a fileystem.
69-
70-
Returns a tuple with the filesystem information in the following order:
71-
72-
* ``f_bsize`` -- file system block size
73-
* ``f_frsize`` -- fragment size
74-
* ``f_blocks`` -- size of fs in f_frsize units
75-
* ``f_bfree`` -- number of free blocks
76-
* ``f_bavail`` -- number of free blocks for unpriviliged users
77-
* ``f_files`` -- number of inodes
78-
* ``f_ffree`` -- number of free inodes
79-
* ``f_favail`` -- number of free inodes for unpriviliged users
80-
* ``f_flag`` -- mount flags
81-
* ``f_namemax`` -- maximum filename length
82-
83-
Parameters related to inodes: ``f_files``, ``f_ffree``, ``f_avail``
84-
and the ``f_flags`` parameter may return ``0`` as they can be unavailable
85-
in a port-specific implementation.
64+
.. function:: statvfs(path)
65+
66+
Get the status of a fileystem.
67+
68+
Returns a tuple with the filesystem information in the following order:
69+
70+
* ``f_bsize`` -- file system block size
71+
* ``f_frsize`` -- fragment size
72+
* ``f_blocks`` -- size of fs in f_frsize units
73+
* ``f_bfree`` -- number of free blocks
74+
* ``f_bavail`` -- number of free blocks for unpriviliged users
75+
* ``f_files`` -- number of inodes
76+
* ``f_ffree`` -- number of free inodes
77+
* ``f_favail`` -- number of free inodes for unpriviliged users
78+
* ``f_flag`` -- mount flags
79+
* ``f_namemax`` -- maximum filename length
80+
81+
Parameters related to inodes: ``f_files``, ``f_ffree``, ``f_avail``
82+
and the ``f_flags`` parameter may return ``0`` as they can be unavailable
83+
in a port-specific implementation.
8684

8785
.. function:: sync()
8886

0 commit comments

Comments
 (0)