diff options
| author | Ralf Jung <post@ralfj.de> | 2020-09-12 10:43:20 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-12 10:43:20 +0200 |
| commit | 2477f070fca2cd75bb91d758d0016715ef140ec4 (patch) | |
| tree | ec99c32dd46751e864309eb4cfab8999e39e2744 /library/std/src | |
| parent | a49451c805d182d4f47096de8bd1d79f6c7af12b (diff) | |
| parent | 954361a3d4f8b87a9311b5c976b7e301f6bae1bb (diff) | |
| download | rust-2477f070fca2cd75bb91d758d0016715ef140ec4.tar.gz rust-2477f070fca2cd75bb91d758d0016715ef140ec4.zip | |
Rollup merge of #76583 - CDirkx:os-doc, r=jonas-schievink
Update `std::os` module documentation. Adds missing descriptions for the modules `std::os::linux::fs` and `std::os::windows::io`. Also adds punctuation for consistency with other descriptions.
Diffstat (limited to 'library/std/src')
| -rw-r--r-- | library/std/src/os/linux/fs.rs | 2 | ||||
| -rw-r--r-- | library/std/src/os/linux/mod.rs | 2 | ||||
| -rw-r--r-- | library/std/src/os/linux/raw.rs | 2 | ||||
| -rw-r--r-- | library/std/src/sys/unix/ext/ffi.rs | 2 | ||||
| -rw-r--r-- | library/std/src/sys/unix/ext/io.rs | 2 | ||||
| -rw-r--r-- | library/std/src/sys/unix/ext/net.rs | 4 | ||||
| -rw-r--r-- | library/std/src/sys/unix/ext/raw.rs | 2 | ||||
| -rw-r--r-- | library/std/src/sys/windows/ext/io.rs | 2 | ||||
| -rw-r--r-- | library/std/src/sys/windows/ext/raw.rs | 2 |
9 files changed, 12 insertions, 8 deletions
diff --git a/library/std/src/os/linux/fs.rs b/library/std/src/os/linux/fs.rs index 14719a9be5e..ff23c3d67e3 100644 --- a/library/std/src/os/linux/fs.rs +++ b/library/std/src/os/linux/fs.rs @@ -1,3 +1,5 @@ +//! Linux-specific extensions to primitives in the `std::fs` module. + #![stable(feature = "metadata_ext", since = "1.1.0")] use crate::fs::Metadata; diff --git a/library/std/src/os/linux/mod.rs b/library/std/src/os/linux/mod.rs index d35307162cc..f179a524336 100644 --- a/library/std/src/os/linux/mod.rs +++ b/library/std/src/os/linux/mod.rs @@ -1,4 +1,4 @@ -//! Linux-specific definitions +//! Linux-specific definitions. #![stable(feature = "raw_ext", since = "1.1.0")] diff --git a/library/std/src/os/linux/raw.rs b/library/std/src/os/linux/raw.rs index 1950ffcb21b..a007fd2b6be 100644 --- a/library/std/src/os/linux/raw.rs +++ b/library/std/src/os/linux/raw.rs @@ -1,4 +1,4 @@ -//! Linux-specific raw type definitions +//! Linux-specific raw type definitions. #![stable(feature = "raw_ext", since = "1.1.0")] #![rustc_deprecated( diff --git a/library/std/src/sys/unix/ext/ffi.rs b/library/std/src/sys/unix/ext/ffi.rs index 76b34a6b5d8..123f85deaf9 100644 --- a/library/std/src/sys/unix/ext/ffi.rs +++ b/library/std/src/sys/unix/ext/ffi.rs @@ -1,4 +1,4 @@ -//! Unix-specific extension to the primitives in the `std::ffi` module +//! Unix-specific extension to the primitives in the `std::ffi` module. //! //! # Examples //! diff --git a/library/std/src/sys/unix/ext/io.rs b/library/std/src/sys/unix/ext/io.rs index 5077e2e28d1..ec7a32b675c 100644 --- a/library/std/src/sys/unix/ext/io.rs +++ b/library/std/src/sys/unix/ext/io.rs @@ -1,4 +1,4 @@ -//! Unix-specific extensions to general I/O primitives +//! Unix-specific extensions to general I/O primitives. #![stable(feature = "rust1", since = "1.0.0")] diff --git a/library/std/src/sys/unix/ext/net.rs b/library/std/src/sys/unix/ext/net.rs index 3fbd0cb58b1..320378e30cc 100644 --- a/library/std/src/sys/unix/ext/net.rs +++ b/library/std/src/sys/unix/ext/net.rs @@ -1,6 +1,6 @@ -#![stable(feature = "unix_socket", since = "1.10.0")] +//! Unix-specific networking functionality. -//! Unix-specific networking functionality +#![stable(feature = "unix_socket", since = "1.10.0")] #[cfg(all(test, not(target_os = "emscripten")))] mod tests; diff --git a/library/std/src/sys/unix/ext/raw.rs b/library/std/src/sys/unix/ext/raw.rs index 40fa53d484f..3199a0bff0b 100644 --- a/library/std/src/sys/unix/ext/raw.rs +++ b/library/std/src/sys/unix/ext/raw.rs @@ -1,4 +1,4 @@ -//! Unix-specific primitives available on all unix platforms +//! Unix-specific primitives available on all unix platforms. #![stable(feature = "raw_ext", since = "1.1.0")] #![rustc_deprecated( diff --git a/library/std/src/sys/windows/ext/io.rs b/library/std/src/sys/windows/ext/io.rs index 4573ee58932..e75f9a4bfd5 100644 --- a/library/std/src/sys/windows/ext/io.rs +++ b/library/std/src/sys/windows/ext/io.rs @@ -1,3 +1,5 @@ +//! Windows-specific extensions to general I/O primitives. + #![stable(feature = "rust1", since = "1.0.0")] use crate::fs; diff --git a/library/std/src/sys/windows/ext/raw.rs b/library/std/src/sys/windows/ext/raw.rs index 7f2a2877828..5014e008eb5 100644 --- a/library/std/src/sys/windows/ext/raw.rs +++ b/library/std/src/sys/windows/ext/raw.rs @@ -1,4 +1,4 @@ -//! Windows-specific primitives +//! Windows-specific primitives. #![stable(feature = "raw_ext", since = "1.1.0")] |
