about summary refs log tree commit diff
path: root/library/std/src/env.rs
diff options
context:
space:
mode:
authorclubby789 <jamie@hill-daniel.co.uk>2025-01-17 12:53:58 +0000
committerclubby789 <jamie@hill-daniel.co.uk>2025-01-17 12:53:58 +0000
commitf7c2d1194d31f34238765afb2d5dee583e2a3cfc (patch)
treeee87da59c9f8ede4c1f3ef766f26ccb1ad28d09c /library/std/src/env.rs
parent73c0ae6aec8f3d07467dfb9339761fa2eec92a44 (diff)
downloadrust-f7c2d1194d31f34238765afb2d5dee583e2a3cfc.tar.gz
rust-f7c2d1194d31f34238765afb2d5dee583e2a3cfc.zip
doc: Point to methods on `Command` as alternatives to `set/remove_var`
Diffstat (limited to 'library/std/src/env.rs')
-rw-r--r--library/std/src/env.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/library/std/src/env.rs b/library/std/src/env.rs
index 11a29cdae62..bbd506127fb 100644
--- a/library/std/src/env.rs
+++ b/library/std/src/env.rs
@@ -336,7 +336,10 @@ impl Error for VarError {
 ///  - [Austin Group Bugzilla](https://austingroupbugs.net/view.php?id=188)
 ///  - [GNU C library Bugzilla](https://sourceware.org/bugzilla/show_bug.cgi?id=15607#c2)
 ///
+/// To pass an environment variable to a child process, you can instead use [`Command::env`].
+///
 /// [`std::net::ToSocketAddrs`]: crate::net::ToSocketAddrs
+/// [`Command::env`]: crate::process::Command::env
 ///
 /// # Panics
 ///
@@ -396,7 +399,12 @@ pub unsafe fn set_var<K: AsRef<OsStr>, V: AsRef<OsStr>>(key: K, value: V) {
 ///  - [Austin Group Bugzilla](https://austingroupbugs.net/view.php?id=188)
 ///  - [GNU C library Bugzilla](https://sourceware.org/bugzilla/show_bug.cgi?id=15607#c2)
 ///
+/// To prevent a child process from inheriting an environment variable, you can
+/// instead use [`Command::env_remove`] or [`Command::env_clear`].
+///
 /// [`std::net::ToSocketAddrs`]: crate::net::ToSocketAddrs
+/// [`Command::env_remove`]: crate::process::Command::env_remove
+/// [`Command::env_clear`]: crate::process::Command::env_clear
 ///
 /// # Panics
 ///