summaryrefslogtreecommitdiff
path: root/src/dir.rs
diff options
context:
space:
mode:
authorRyan Zoeller <rtzoeller@rtzoeller.com>2022-04-07 23:17:37 -0500
committerRyan Zoeller <rtzoeller@rtzoeller.com>2022-06-26 19:36:45 -0500
commit1fa1bb19b0ba905a7d89ad3d0496d0970245a3f1 (patch)
treec8422479d09eb2fc2ac77be025b248b6210e8e5a /src/dir.rs
parent84b02b98a9e9d5f368241fefaebee2319dc058a9 (diff)
downloadnix-1fa1bb19b0ba905a7d89ad3d0496d0970245a3f1.zip
Document aliases for functions like getuid()
Add the autocfg crate as a build dependency, and introduce has_doc_alias as a conditional compilation symbol.
Diffstat (limited to 'src/dir.rs')
-rw-r--r--src/dir.rs1
1 files changed, 1 insertions, 0 deletions
diff --git a/src/dir.rs b/src/dir.rs
index c9b5af8f..8f9a2d6f 100644
--- a/src/dir.rs
+++ b/src/dir.rs
@@ -53,6 +53,7 @@ impl Dir {
}
/// Converts from a file descriptor, closing it on success or failure.
+ #[cfg_attr(has_doc_alias, doc(alias("fdopendir")))]
pub fn from_fd(fd: RawFd) -> Result<Self> {
let d = ptr::NonNull::new(unsafe { libc::fdopendir(fd) }).ok_or_else(|| {
let e = Error::last();