bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

document the platform-specific behavior of Command::current_dir

Browse source
This commit is contained in:
Jack O'Connor 2018-08-15 14:07:44 -04:00
parent 1558ae7cfd
commit 0945b74d73
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/libstd/process.rs
View file

@ -626,6 +626,14 @@ impl Command {
/// Sets the working directory for the child process.
///
/// # Platform-specific behavior
///
/// If the program path is relative (e.g. `"./script.sh"`), it's ambiguous
/// whether it should be interpreted relative to the parent's working
/// directory or relative to `current_dir`. The behavior in this case is
/// platform specific and unstable, and it's recommended to use
/// [`canonicalize`] to get an absolute program path instead.
///
/// # Examples
///
/// Basic usage:
@ -638,6 +646,8 @@ impl Command {
/// .spawn()
/// .expect("ls command failed to start");
/// ```
///
/// [`canonicalize`]: ../fs/fn.canonicalize.html
#[stable(feature = "process", since = "1.0.0")]
pub fn current_dir<P: AsRef<Path>>(&mut self, dir: P) -> &mut Command {
self.inner.cwd(dir.as_ref().as_ref());