about summary refs log tree commit diff
path: root/library/std/src/sys/unix/mod.rs
diff options
context:
space:
mode:
authorMartin Nordholts <enselic@gmail.com>2022-09-01 06:43:03 +0200
committerMartin Nordholts <enselic@gmail.com>2022-09-01 06:45:04 +0200
commit3810d4a3680d825448f5034262cc6ad63586b02e (patch)
treee0a48858cc2b6164b952177fef1c481297034a17 /library/std/src/sys/unix/mod.rs
parent3d1a4e4f2792948d78b3fed030e93c9c156fe35a (diff)
downloadrust-3810d4a3680d825448f5034262cc6ad63586b02e.tar.gz
rust-3810d4a3680d825448f5034262cc6ad63586b02e.zip
unix_sigpipe: Make `sigpipe` param docs long-form
Diffstat (limited to 'library/std/src/sys/unix/mod.rs')
-rw-r--r--library/std/src/sys/unix/mod.rs3
1 files changed, 1 insertions, 2 deletions
diff --git a/library/std/src/sys/unix/mod.rs b/library/std/src/sys/unix/mod.rs
index 2856dfcb370..c84e292eac1 100644
--- a/library/std/src/sys/unix/mod.rs
+++ b/library/std/src/sys/unix/mod.rs
@@ -49,8 +49,7 @@ pub fn init(argc: isize, argv: *const *const u8, _sigpipe: u8) {}
 #[cfg(not(target_os = "espidf"))]
 // SAFETY: must be called only once during runtime initialization.
 // NOTE: this is not guaranteed to run, for example when Rust code is called externally.
-// The extra parameter `sigpipe` allows rustc to generate code that instructs std whether
-// or not to ignore `SIGPIPE`.
+// See `fn init()` in `library/std/src/rt.rs` for docs on `sigpipe`.
 pub unsafe fn init(argc: isize, argv: *const *const u8, sigpipe: u8) {
     // The standard streams might be closed on application startup. To prevent
     // std::io::{stdin, stdout,stderr} objects from using other unrelated file