doc: clarify fs.StatFs field descriptions#62242
Open
kovan wants to merge 1 commit intonodejs:mainfrom
Open
Conversation
Clarify that bsize is in bytes and serves as the unit for the block count fields (blocks, bfree, bavail). Add "multiply by bsize" hints so users can compute sizes without guessing units. Explain that type is a file system magic number with platform-specific values. Mention that ffree/files count inodes. Fixes: nodejs#50749
nodejs-github-bot
added
doc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarify the
fs.StatFsfield descriptions:bsize: specify that the value is in bytes and serves as the unit for block count fieldsblocks,bfree,bavail: add "multiply bybsize" guidance so users can compute sizes; clarify the difference betweenbfree(includes superuser-reserved blocks) andbavail(unprivileged)type: explain that this is a file system magic number with common examples and a pointer to platform-specific man pagesfiles,ffree: note that these count inodesPicks up the work from #51301, #55279, and #59626 which all attempted to address this issue but stalled.
Fixes: #50749