Skip to content

fstatfs and fstatvfs appear to have flipped documentation #2699

@ultrabear

Description

@ultrabear

nix::sys::statfs is documented to state that

The result is OS-dependent. For a portable alternative, see [fstatvfs](https://docs.rs/nix/latest/nix/sys/statvfs/fn.fstatvfs.html).

However, statfs returns normalized rust number types while fstatvfs, the "portable" one, returns libc derived number types that differ in practice

Portability is most often read as "common interface with less user input", so this is confusing and inverted the order in which I used these functions (and indeed caused a build failure when we later tried to build on macos, oops!)

I can PR to fix the docs, but wanted to get visibility first to see if there was some intent in the docs that should be kept while disambiguating

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions