summary refs log tree commit diff
path: root/src/libstd/process.rs
diff options
context:
space:
mode:
authorMartin Pool <mbp@sourcefrog.net>2016-11-26 09:15:33 -0800
committerMartin Pool <mbp@google.com>2016-11-30 17:10:32 -0800
commitdb936773608d1f9b24d90c87ec224a9b9f501489 (patch)
treed92f1e0c274cc20135db73f239bd232e7c0f146d /src/libstd/process.rs
parent2a44315fc72d2ab123344dd65b6b2129dff30aaa (diff)
downloadrust-db936773608d1f9b24d90c87ec224a9b9f501489.tar.gz
rust-db936773608d1f9b24d90c87ec224a9b9f501489.zip
Document that Process::command will search the PATH
Diffstat (limited to 'src/libstd/process.rs')
-rw-r--r--src/libstd/process.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/libstd/process.rs b/src/libstd/process.rs
index 9d21a76e81b..d96c5e244d7 100644
--- a/src/libstd/process.rs
+++ b/src/libstd/process.rs
@@ -253,6 +253,14 @@ impl Command {
     /// Builder methods are provided to change these defaults and
     /// otherwise configure the process.
     ///
+    /// If `program` is not an absolute path, the `PATH` will be searched in
+    /// an OS-defined way.
+    ///
+    /// The search path to be used may be controlled by setting the
+    /// `PATH` environment variable on the Command,
+    /// but this has some implementation limitations on Windows
+    /// (see https://github.com/rust-lang/rust/issues/37519).
+    ///
     /// # Examples
     ///
     /// Basic usage: