Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add intra-doc links and small changes to std::os to be more consistent #89051

Merged
merged 1 commit into from
Sep 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion library/std/src/os/linux/fs.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
//! Linux-specific extensions to primitives in the `std::fs` module.
//! Linux-specific extensions to primitives in the [`std::fs`] module.
//!
//! [`std::fs`]: crate::fs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


#![stable(feature = "metadata_ext", since = "1.1.0")]

Expand Down
4 changes: 3 additions & 1 deletion library/std/src/os/linux/process.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
//! Linux-specific extensions to primitives in the `std::process` module.
//! Linux-specific extensions to primitives in the [`std::process`] module.
//!
//! [`std::process`]: crate::process

#![unstable(feature = "linux_pidfd", issue = "82971")]

Expand Down
4 changes: 3 additions & 1 deletion library/std/src/os/unix/ffi/mod.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Unix-specific extension to the primitives in the `std::ffi` module.
//! Unix-specific extensions to primitives in the [`std::ffi`] module.
//!
//! # Examples
//!
Expand Down Expand Up @@ -31,6 +31,8 @@
//! let bytes = os_str.as_bytes();
//! assert_eq!(bytes, b"foo");
//! ```
//!
//! [`std::ffi`]: crate::ffi

#![stable(feature = "rust1", since = "1.0.0")]

Expand Down
4 changes: 3 additions & 1 deletion library/std/src/os/unix/fs.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
//! Unix-specific extensions to primitives in the `std::fs` module.
//! Unix-specific extensions to primitives in the [`std::fs`] module.
//!
//! [`std::fs`]: crate::fs

#![stable(feature = "rust1", since = "1.0.0")]

Expand Down
7 changes: 5 additions & 2 deletions library/std/src/os/unix/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
//!
Expand All @@ -24,6 +24,9 @@
//! Ok(())
//! }
//! ```
//!
//! [`OsStr`]: crate::ffi::OsStr
//! [`OsString`]: crate::ffi::OsString

#![stable(feature = "rust1", since = "1.0.0")]
#![doc(cfg(unix))]
Expand Down
2 changes: 1 addition & 1 deletion library/std/src/os/unix/net/mod.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Unix-specific networking functionality
//! Unix-specific networking functionality.

#![stable(feature = "unix_socket", since = "1.10.0")]

Expand Down
4 changes: 3 additions & 1 deletion library/std/src/os/unix/process.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
//! Unix-specific extensions to primitives in the `std::process` module.
//! Unix-specific extensions to primitives in the [`std::process`] module.
//!
//! [`std::process`]: crate::process

#![stable(feature = "rust1", since = "1.0.0")]

Expand Down
4 changes: 3 additions & 1 deletion library/std/src/os/unix/thread.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
//! Unix-specific extensions to primitives in the `std::thread` module.
//! Unix-specific extensions to primitives in the [`std::thread`] module.
//!
//! [`std::thread`]: crate::thread

#![stable(feature = "thread_extensions", since = "1.9.0")]

Expand Down
4 changes: 3 additions & 1 deletion library/std/src/os/wasi/ffi.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
//! WASI-specific extension to the primitives in the `std::ffi` module
//! WASI-specific extensions to primitives in the [`std::ffi`] module
//!
//! [`std::ffi`]: crate::ffi

#![stable(feature = "rust1", since = "1.0.0")]

Expand Down
4 changes: 3 additions & 1 deletion library/std/src/os/wasi/fs.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
//! WASI-specific extensions to primitives in the `std::fs` module.
//! WASI-specific extensions to primitives in the [`std::fs`] module.
//!
//! [`std::fs`]: crate::fs

#![deny(unsafe_op_in_unsafe_fn)]
#![unstable(feature = "wasi_ext", issue = "71213")]
Expand Down
3 changes: 3 additions & 0 deletions library/std/src/os/wasi/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
//! Ok(())
//! }
//! ```
//!
//! [`OsStr`]: crate::ffi::OsStr
//! [`OsString`]: crate::ffi::OsString

#![stable(feature = "rust1", since = "1.0.0")]
#![deny(unsafe_op_in_unsafe_fn)]
Expand Down
3 changes: 2 additions & 1 deletion library/std/src/os/windows/ffi.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Windows-specific extensions to the primitives in the `std::ffi` module.
//! Windows-specific extensions to primitives in the [`std::ffi`] module.
//!
//! # Overview
//!
Expand Down Expand Up @@ -49,6 +49,7 @@
//! [ill-formed-utf-16]: https://simonsapin.github.io/wtf-8/#ill-formed-utf-16
//! [`collect`]: crate::iter::Iterator::collect
//! [U+FFFD]: crate::char::REPLACEMENT_CHARACTER
//! [`std::ffi`]: crate::ffi

#![stable(feature = "rust1", since = "1.0.0")]

Expand Down
4 changes: 3 additions & 1 deletion library/std/src/os/windows/fs.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
//! Windows-specific extensions for the primitives in the `std::fs` module.
//! Windows-specific extensions to primitives in the [`std::fs`] module.
//!
//! [`std::fs`]: crate::fs

#![stable(feature = "rust1", since = "1.0.0")]

Expand Down
16 changes: 16 additions & 0 deletions library/std/src/os/windows/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,22 @@
//! the core `std` library. These extensions allow developers to use
//! `std` types and idioms with Windows in a way that the normal
//! platform-agnostic idioms would not normally support.
//!
//! # Examples
//!
//! ```no_run
//! use std::fs::File;
//! use std::os::windows::prelude::*;
jyn514 marked this conversation as resolved.
Show resolved Hide resolved
//!
//! fn main() -> std::io::Result<()> {
//! let f = File::create("foo.txt")?;
//! let handle = f.as_raw_handle();
//!
//! // use handle with native windows bindings
//!
//! Ok(())
//! }
//! ```

#![stable(feature = "rust1", since = "1.0.0")]
#![doc(cfg(windows))]
Expand Down
4 changes: 3 additions & 1 deletion library/std/src/os/windows/process.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
//! Extensions to `std::process` for Windows.
//! Windows-specific extensions to primitives in the [`std::process`] module.
//!
//! [`std::process`]: crate::process

#![stable(feature = "process_extensions", since = "1.2.0")]

Expand Down
4 changes: 3 additions & 1 deletion library/std/src/os/windows/thread.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
//! Extensions to `std::thread` for Windows.
//! Windows-specific extensions to primitives in the [`std::thread`] module.
//!
//! [`std::thread`]: crate::thread

#![stable(feature = "thread_extensions", since = "1.9.0")]

Expand Down