about summary refs log tree commit diff
path: root/library/std/src/os/unix/mod.rs
diff options
context:
space:
mode:
authorSachin Cherian <sachinctl@protonmail.com>2021-09-17 23:23:21 +0530
committerSachin Cherian <sachinctl@protonmail.com>2021-09-17 23:23:21 +0530
commitec34aa61d6947f6bee11f13a8d0a11e61cf65b67 (patch)
tree0a138d282edb72c709a4028db839d6cc63f0bf24 /library/std/src/os/unix/mod.rs
parentc3c0f80d6081092faff801542dd82f0e2420152b (diff)
downloadrust-ec34aa61d6947f6bee11f13a8d0a11e61cf65b67.tar.gz
rust-ec34aa61d6947f6bee11f13a8d0a11e61cf65b67.zip
modify std::os docs to be more consistent
> add intra doc links
> add a usage example for the os::windows module
Diffstat (limited to 'library/std/src/os/unix/mod.rs')
-rw-r--r--library/std/src/os/unix/mod.rs7
1 files changed, 5 insertions, 2 deletions
diff --git a/library/std/src/os/unix/mod.rs b/library/std/src/os/unix/mod.rs
index 17a02595724..62f750fa607 100644
--- a/library/std/src/os/unix/mod.rs
+++ b/library/std/src/os/unix/mod.rs
@@ -4,8 +4,8 @@
 //! exposes Unix-specific functions that would otherwise be inappropriate as
 //! part of the core `std` library.
 //!
-//! It exposes more ways to deal with platform-specific strings (`OsStr`,
-//! `OsString`), allows to set permissions more granularly, extract low-level
+//! It exposes more ways to deal with platform-specific strings ([`OsStr`],
+//! [`OsString`]), allows to set permissions more granularly, extract low-level
 //! file descriptors from files and sockets, and has platform-specific helpers
 //! for spawning processes.
 //!
@@ -24,6 +24,9 @@
 //!     Ok(())
 //! }
 //! ```
+//!
+//! [`OsStr`]: crate::ffi::OsStr
+//! [`OsString`]: crate::ffi::OsString
 
 #![stable(feature = "rust1", since = "1.0.0")]
 #![doc(cfg(unix))]