diff options
| author | Aris Merchant <22333129+inquisitivecrystal@users.noreply.github.com> | 2021-07-07 00:23:29 -0700 |
|---|---|---|
| committer | inquisitivecrystal <22333129+inquisitivecrystal@users.noreply.github.com> | 2021-07-09 23:24:36 -0700 |
| commit | 5022c0638dfbb83e0b38ce90f79d0fd6a4d295d6 (patch) | |
| tree | ddd03e3bb16165a013bb46aa0e2369e70b878668 | |
| parent | dc38d87505f4b1e381f143b4f34704df6a24e57e (diff) | |
| download | rust-5022c0638dfbb83e0b38ce90f79d0fd6a4d295d6.tar.gz rust-5022c0638dfbb83e0b38ce90f79d0fd6a4d295d6.zip | |
Update docs for `fs::hard_link`
| -rw-r--r-- | library/std/src/fs.rs | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/library/std/src/fs.rs b/library/std/src/fs.rs index a9ce814e2ec..fb928ea5598 100644 --- a/library/std/src/fs.rs +++ b/library/std/src/fs.rs @@ -1736,8 +1736,11 @@ pub fn copy<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<u64> { /// /// # Platform-specific behavior /// -/// This function currently corresponds to the `linkat` function with no flags -/// on Unix and the `CreateHardLink` function on Windows. +/// This function currently corresponds the `CreateHardLink` function on Windows. +/// On most Unix systems, it corresponds to the `linkat` function with no flags. +/// On Android, VxWorks, and Redox, it instead corresponds to the `link` function. +/// On MacOS, it uses the `linkat` function if it is available, but on very old +/// systems where `linkat` is not available, `link` is selected at runtime instead. /// Note that, this [may change in the future][changes]. /// /// [changes]: io#platform-specific-behavior |