Rollup merge of #88805 - krhancoc:master, r=dtolnay

Clarification of default socket flags This PR outlines the decision to disable inheritance of socket objects when possible to child processes in the documentation.
rust-lang · Mar 4, 2022 · 4c70200 · 4c70200
2 parents 40d3040 + a10f095
commit 4c70200
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/library/std/src/net/mod.rs b/library/std/src/net/mod.rs
@@ -14,6 +14,10 @@
 //! * [`ToSocketAddrs`] is a trait that used for generic address resolution when interacting
 //!   with networking objects like [`TcpListener`], [`TcpStream`] or [`UdpSocket`]
 //! * Other types are return or parameter types for various methods in this module
+//!
+//! Rust disables inheritance of socket objects to child processes by default when possible.  For
+//! example, through the use of the `CLOEXEC` flag in UNIX systems or the `HANDLE_FLAG_INHERIT`
+//! flag on Windows.
 
 #![stable(feature = "rust1", since = "1.0.0")]