Auto merge of #79115 - cuviper:rust-description, r=Mark-Simulacrum

[rust.git] / library / std / src / process.rs

diff --git a/library/std/src/process.rs b/library/std/src/process.rs
index 3d238b7f764efcaf920ca5b378f3c73b27f67cae..2c7ed4614bce9e4701c3687481852d265f440eae 100644 (file)
--- a/library/std/src/process.rs
+++ b/library/std/src/process.rs
@@ -557,6 +557,11 @@ pub fn new<S: AsRef<OsStr>>(program: S) -> Command {
     ///
     /// [`args`]: Command::args
     ///
+    /// Note that the argument is not passed through a shell, but given
+    /// literally to the program. This means that shell syntax like quotes,
+    /// escaped characters, word splitting, glob patterns, substitution, etc.
+    /// have no effect.
+    ///
     /// # Examples
     ///
     /// Basic usage:
@@ -582,6 +587,11 @@ pub fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Command {
     ///
     /// [`arg`]: Command::arg
     ///
+    /// Note that the arguments are not passed through a shell, but given
+    /// literally to the program. This means that shell syntax like quotes,
+    /// escaped characters, word splitting, glob patterns, substitution, etc.
+    /// have no effect.
+    ///
     /// # Examples
     ///
     /// Basic usage:
@@ -1184,7 +1194,7 @@ pub fn inherit() -> Stdio {
     }
 
     /// This stream will be ignored. This is the equivalent of attaching the
-    /// stream to `/dev/null`
+    /// stream to `/dev/null`.
     ///
     /// # Examples
     ///