diff options
| author | Dylan DPC <99973273+Dylan-DPC@users.noreply.github.com> | 2022-03-28 20:41:52 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-28 20:41:52 +0200 |
| commit | 4c8bc046b9ca828784cf9d6d48bbabb28c2ec7ec (patch) | |
| tree | edd187e3f26184f9aedf4adfa8eb7d264688dd31 | |
| parent | ce319ac1a2a6af741cb7c4b574c7d0d730f899c4 (diff) | |
| parent | d55854d484f64e7a2b570e28ff1250112b6578e2 (diff) | |
| download | rust-4c8bc046b9ca828784cf9d6d48bbabb28c2ec7ec.tar.gz rust-4c8bc046b9ca828784cf9d6d48bbabb28c2ec7ec.zip | |
Rollup merge of #95397 - dtolnay:disclaimer, r=m-ou-se
Link to std::io's platform-specific behavior disclaimer This PR adds some links in standard library documentation to point to https://doc.rust-lang.org/std/io/index.html#platform-specific-behavior. > ### Platform-specific behavior > > Many I/O functions throughout the standard library are documented to indicate what various library or syscalls they are delegated to. This is done to help applications both understand what’s happening under the hood as well as investigate any possibly unclear semantics. Note, however, that this is informative, not a binding contract. The implementation of many of these functions are subject to change over time and may call fewer or more syscalls/library functions. Many of the `std::fs` APIs already link to this disclaimer when discussing system calls.
| -rw-r--r-- | library/std/src/env.rs | 8 | ||||
| -rw-r--r-- | library/std/src/time.rs | 9 |
2 files changed, 13 insertions, 4 deletions
diff --git a/library/std/src/env.rs b/library/std/src/env.rs index 05f08c498e6..f03d298d869 100644 --- a/library/std/src/env.rs +++ b/library/std/src/env.rs @@ -25,9 +25,11 @@ use crate::sys::os as os_imp; /// /// # Platform-specific behavior /// -/// This function currently corresponds to the `getcwd` function on Unix +/// This function [currently] corresponds to the `getcwd` function on Unix /// and the `GetCurrentDirectoryW` function on Windows. /// +/// [currently]: crate::io#platform-specific-behavior +/// /// # Errors /// /// Returns an [`Err`] if the current working directory value is invalid. @@ -56,11 +58,13 @@ pub fn current_dir() -> io::Result<PathBuf> { /// /// # Platform-specific behavior /// -/// This function currently corresponds to the `chdir` function on Unix +/// This function [currently] corresponds to the `chdir` function on Unix /// and the `SetCurrentDirectoryW` function on Windows. /// /// Returns an [`Err`] if the operation fails. /// +/// [currently]: crate::io#platform-specific-behavior +/// /// # Examples /// /// ``` diff --git a/library/std/src/time.rs b/library/std/src/time.rs index 2f8eb557b4f..708e4064e06 100644 --- a/library/std/src/time.rs +++ b/library/std/src/time.rs @@ -101,7 +101,9 @@ pub use core::time::FromFloatSecsError; /// ``` /// /// # Underlying System calls -/// Currently, the following system calls are being used to get the current time using `now()`: +/// +/// The following system calls are [currently] being used by `now()` to find out +/// the current time: /// /// | Platform | System call | /// |-----------|----------------------------------------------------------------------| @@ -113,6 +115,7 @@ pub use core::time::FromFloatSecsError; /// | WASI | [__wasi_clock_time_get (Monotonic Clock)] | /// | Windows | [QueryPerformanceCounter] | /// +/// [currently]: crate::io#platform-specific-behavior /// [QueryPerformanceCounter]: https://docs.microsoft.com/en-us/windows/win32/api/profileapi/nf-profileapi-queryperformancecounter /// [`insecure_time` usercall]: https://edp.fortanix.com/docs/api/fortanix_sgx_abi/struct.Usercalls.html#method.insecure_time /// [timekeeping in SGX]: https://edp.fortanix.com/docs/concepts/rust-std/#codestdtimecode @@ -203,7 +206,8 @@ pub struct Instant(time::Instant); /// For example, on Windows the time is represented in 100 nanosecond intervals whereas Linux /// can represent nanosecond intervals. /// -/// Currently, the following system calls are being used to get the current time using `now()`: +/// The following system calls are [currently] being used by `now()` to find out +/// the current time: /// /// | Platform | System call | /// |-----------|----------------------------------------------------------------------| @@ -215,6 +219,7 @@ pub struct Instant(time::Instant); /// | WASI | [__wasi_clock_time_get (Realtime Clock)] | /// | Windows | [GetSystemTimePreciseAsFileTime] / [GetSystemTimeAsFileTime] | /// +/// [currently]: crate::io#platform-specific-behavior /// [`insecure_time` usercall]: https://edp.fortanix.com/docs/api/fortanix_sgx_abi/struct.Usercalls.html#method.insecure_time /// [timekeeping in SGX]: https://edp.fortanix.com/docs/concepts/rust-std/#codestdtimecode /// [gettimeofday]: https://man7.org/linux/man-pages/man2/gettimeofday.2.html |