about summary refs log tree commit diff
path: root/library/std/src/os
diff options
context:
space:
mode:
authorMatthias Krüger <476013+matthiaskrgr@users.noreply.github.com>2025-06-29 06:59:29 +0200
committerGitHub <noreply@github.com>2025-06-29 06:59:29 +0200
commiteef87fd9748d2c21bd99bdf04842c7244398563a (patch)
treeaf250963d2362fdd4768f819cd677abc51d7de75 /library/std/src/os
parente68f13c9d434c96fbe9cda6ed8f8eba8dabd3519 (diff)
parent45204ef4f49fb8a51c138ded8f4912c11e468b06 (diff)
downloadrust-eef87fd9748d2c21bd99bdf04842c7244398563a.tar.gz
rust-eef87fd9748d2c21bd99bdf04842c7244398563a.zip
Rollup merge of #142889 - nabijaczleweli:rusts, r=Mark-Simulacrum
Clarify doc comment on unix OpenOptions
Diffstat (limited to 'library/std/src/os')
-rw-r--r--library/std/src/os/unix/fs.rs12
1 files changed, 5 insertions, 7 deletions
diff --git a/library/std/src/os/unix/fs.rs b/library/std/src/os/unix/fs.rs
index 4f9259f39c1..b776df3dde1 100644
--- a/library/std/src/os/unix/fs.rs
+++ b/library/std/src/os/unix/fs.rs
@@ -408,24 +408,22 @@ pub trait OpenOptionsExt {
     /// Pass custom flags to the `flags` argument of `open`.
     ///
     /// The bits that define the access mode are masked out with `O_ACCMODE`, to
-    /// ensure they do not interfere with the access mode set by Rusts options.
+    /// ensure they do not interfere with the access mode set by Rust's options.
     ///
-    /// Custom flags can only set flags, not remove flags set by Rusts options.
-    /// This options overwrites any previously set custom flags.
+    /// Custom flags can only set flags, not remove flags set by Rust's options.
+    /// This function overwrites any previously-set custom flags.
     ///
     /// # Examples
     ///
     /// ```no_run
-    /// # #![feature(rustc_private)]
+    /// # mod libc { pub const O_NOFOLLOW: i32 = 0; }
     /// use std::fs::OpenOptions;
     /// use std::os::unix::fs::OpenOptionsExt;
     ///
     /// # fn main() {
     /// let mut options = OpenOptions::new();
     /// options.write(true);
-    /// if cfg!(unix) {
-    ///     options.custom_flags(libc::O_NOFOLLOW);
-    /// }
+    /// options.custom_flags(libc::O_NOFOLLOW);
     /// let file = options.open("foo.txt");
     /// # }
     /// ```