update

Author: tgross35

library/compiler-builtins/crates/josh-sync/src/sync.rs

@@ -1,13 +1,11 @@
 use std::net::{SocketAddr, TcpStream};
-use std::path::PathBuf;
 use std::process::{Command, Stdio, exit};
 use std::time::Duration;
 use std::{env, fs, process, thread};
 
 const DEFAULT_PR_BRANCH: &str = "update-builtins";
 
 pub struct GitSync {
-    dir: PathBuf,
     upstream_repo: String,
     upstream_ref: String,
     upstream_url: String,
@@ -16,16 +14,15 @@ pub struct GitSync {
     josh_url_base: String,
 }
 
-/// This code was adapted from the miri repository
-/// (https://github.com/rust-lang/miri/blob/6a68a79f38064c3bc30617cca4bdbfb2c336b140/miri-script/src/commands.rs#L236).
+/// This code was adapted from the miri repository, via the rustc-dev-guide
+/// (https://github.com/rust-lang/rustc-dev-guide/tree/c51adbd12d/josh-sync)
 impl GitSync {
     pub fn from_current_dir() -> anyhow::Result<Self> {
         let upstream_repo =
             env::var("UPSTREAM_ORG").unwrap_or_else(|_| "rust-lang".to_owned()) + "/rust";
         let josh_port = 42042;
 
         Ok(Self {
-            dir: std::env::current_dir()?,
             upstream_url: format!("https://github.com/{upstream_repo}/"),
             upstream_repo,
             upstream_ref: env::var("UPSTREAM_REF").unwrap_or_else(|_| "HEAD".to_owned()),
@@ -260,6 +257,7 @@ impl GitSync {
         )
     }
 
+    /// Fail if there are files that need to be checked in.
     fn ensure_clean(&self) {
         let read = self.read(["git", "status", "--untracked-files=no", "--porcelain"]);
         assert!(
@@ -268,24 +266,28 @@ impl GitSync {
         )
     }
 
+    /// Run a command from an array, passing its output through.
     fn run<'a, Args: AsRef<[&'a str]>>(&self, l: Args) {
         let l = l.as_ref();
         self.run_args(l[0], |c| c.args(&l[1..]))
     }
 
-    fn run_args(&self, prog: &str, f: impl FnOnce(&mut Command) -> &mut Command) {
-        // self.read(l.as_ref());
-        self.read_args(prog, |c| f(c.stdout(Stdio::inherit())));
-    }
-
+    /// Run a command from an array, collecting its output.
     fn read<'a, Args: AsRef<[&'a str]>>(&self, l: Args) -> String {
         let l = l.as_ref();
         self.read_args(l[0], |c| c.args(&l[1..]))
     }
 
+    /// [`run`] with configuration.
+    fn run_args(&self, prog: &str, f: impl FnOnce(&mut Command) -> &mut Command) {
+        // self.read(l.as_ref());
+        self.read_args(prog, |c| f(c.stdout(Stdio::inherit())));
+    }
+
+    /// [`read`] with configuration. All shell helpers print the command and pass stderr.
     fn read_args(&self, prog: &str, f: impl FnOnce(&mut Command) -> &mut Command) -> String {
         let mut cmd = Command::new(prog);
-        cmd.current_dir(&self.dir).stderr(Stdio::inherit());
+        cmd.stderr(Stdio::inherit());
         f(&mut cmd);
         eprintln!("+ {cmd:?}");
         let out = cmd.output().expect("command failed");