From 99c169f00e65f9cf17462f6b5883f3ec51153f24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Hanuszczak?= Date: Fri, 20 Oct 2023 12:26:26 +0200 Subject: [PATCH] Update docs for `ospect::fs::mounts`. --- crates/ospect/src/fs.rs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/crates/ospect/src/fs.rs b/crates/ospect/src/fs.rs index 55a6bc97..9784929e 100644 --- a/crates/ospect/src/fs.rs +++ b/crates/ospect/src/fs.rs @@ -199,15 +199,16 @@ pub struct Mount { pub fs_type: String, } -// TODO(@panhania): Add information about Windows once it is supported. /// Returns an iterator over mounted filesystems information. /// /// The exact behaviour is system specific: /// /// * On Linux it parses `/proc/mounts` entries (or alternatives). -/// * On macOS it uses the [`getmntinfo`] call. +/// * On macOS it uses the [`getmntinfo`][1] call. +/// * On Windows it uses [volume managemend functions][2]. /// -/// [`getmntinfo`]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/getmntinfo.3.html +/// [1]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/getmntinfo.3.html +/// [2]: https://learn.microsoft.com/en-us/windows/win32/fileio/volume-management-functions pub fn mounts() -> std::io::Result>> { self::sys::mounts() }