Skip to content

doc: clarify fs.StatFs field descriptions #62242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kovan wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −7
Open

doc: clarify fs.StatFs field descriptions #62242

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7664,7 +7664,8 @@ added:

* Type: {number|bigint}

Free blocks available to unprivileged users.
Free blocks available to unprivileged users. Multiply by `statfs.bsize`
to get the value in bytes.

#### `statfs.bfree`

Expand All @@ -7676,7 +7677,9 @@ added:

* Type: {number|bigint}

Free blocks in file system.
Free blocks in file system. This includes blocks reserved for the
superuser that are not reported by `statfs.bavail`. Multiply by
`statfs.bsize` to get the value in bytes.

#### `statfs.blocks`

Expand All @@ -7688,7 +7691,8 @@ added:

* Type: {number|bigint}

Total data blocks in file system.
Total data blocks in file system. Multiply by `statfs.bsize` to get
the total size in bytes.

#### `statfs.bsize`

Expand All @@ -7700,7 +7704,8 @@ added:

* Type: {number|bigint}

Optimal transfer block size.
Optimal transfer block size in bytes. This value is also the unit for
the `statfs.blocks`, `statfs.bfree`, and `statfs.bavail` fields.

#### `statfs.ffree`

Expand All @@ -7712,7 +7717,7 @@ added:

* Type: {number|bigint}

Free file nodes in file system.
Free file nodes (inodes) in file system.

#### `statfs.files`

Expand All @@ -7724,7 +7729,7 @@ added:

* Type: {number|bigint}

Total file nodes in file system.
Total file nodes (inodes) in file system.

#### `statfs.type`

Expand All @@ -7736,7 +7741,11 @@ added:

* Type: {number|bigint}

Type of file system.
File system type as a numeric identifier. On Linux this is the
file system magic number (e.g. `0xef53` for ext2/ext3/ext4,
`0x01021994` for tmpfs). On other platforms the value is
OS-dependent. See the `statfs(2)` man page on Linux or `statfs(2)`
on macOS for platform-specific values.

### Class: `fs.Utf8Stream`

Expand Down
Loading