Script improvements

src/python/replay_merge.py

@@ -268,11 +268,11 @@ def merge_replay(
                     stderr=subprocess.PIPE,
                 )
                 if len(process.stderr.decode("utf-8")) == 0:
-                    conflict_files = process.stdout.decode("utf-8")
-                    is_conflict = len(conflict_files) > 0
+                    git_conflict_files = process.stdout.decode("utf-8")
+                    is_conflict = len(git_conflict_files) > 0
                     assert (
                         is_conflict == (merge_result == MERGE_STATE.Merge_failed)
-                    ), f"merge_replay: tool{merge_tool} merge_result {merge_result} does not match conflict_files {conflict_files} at path {repo.local_repo_path}"
+                    ), f"merge_replay: tool merge result is inconsistent with `git diff --diff-filter=U`: tool={merge_tool} merge_result={merge_result} git_conflict_files={git_conflict_files} path={repo.local_repo_path}"
 
             result_df.loc[
                 merge_tool.name,
@@ -308,10 +308,11 @@ def merge_replay(
                     store_artifacts(result_df)
                 if delete_workdir:
                     delete_workdirs(result_df)
-                print("=====================================\n")
+                print("fingerprints differ; details follow.")
+                print(f"=================== start of {log_path}:")
                 with open(log_path, "r", encoding="utf-8") as f:
                     print(f.read())
-                print("=====================================\n")
+                print(f"=================== end of {log_path}.")
                 raise Exception(
                     f"fingerprints differ: after merge of {workdir} with {merge_tool}, found"
                     + f" {merge_fingerprint} but expected "

src/python/repo.py

@@ -152,11 +152,20 @@ def stdout_and_stderr(
     source: Union[subprocess.TimeoutExpired, subprocess.CompletedProcess],
 ) -> str:
     """Produces the standard output and standard error of a timedout process."""
-    explanation = "Run Command: " + " ".join(command) + "\nTimed out"
+    explanation = "Here is the output from: " + " ".join(command)
     if source.stdout:
-        explanation += "\nstdout:\n" + source.stdout.decode("utf-8", "replace")
+        explanation += (
+            "\nstdout:\n"
+            + source.stdout.decode("utf-8", "replace")
+            + "\nEnd of stdout."
+        )
     if source.stderr:
-        explanation += "\nstderr:\n" + source.stderr.decode("utf-8", "replace")
+        explanation += (
+            "\nstderr:\n"
+            + source.stderr.decode("utf-8", "replace")
+            + "\nEnd of stderr."
+        )
+    explanation += "\nEnd of output from: " + " ".join(command)
     return explanation
 
 

src/scripts/merge_tools/adjacent.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./adjacent.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/adjacent_ignorespace.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./adjacent_ignorespace.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/adjacent_plus.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./adjacent.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/git_hires_merge.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./git_hires_merge.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 set -o nounset
 

src/scripts/merge_tools/git_hires_merge_plus.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./git_hires_merge_plus.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/gitmerge.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./gitmerge.sh <clone_dir> <branch-1> <branch-2> <git_strategy>
+# usage: gitmerge.sh <clone_dir> <branch-1> <branch-2> <git_strategy>
 # Merges branch2 into branch1, in <clone_dir>, using merge strategy <git_strategy>.
 # <clone_dir> must contain a clone of a repository.
 # <git_strategy> is arguments to `git merge`, including -s and possibly -X.
@@ -19,19 +19,39 @@ branch1=$2
 branch2=$3
 git_strategy=$4
 
+VERBOSE=
+## Enable for debugging
+# VERBOSE=YES
+
+
 ## Perform merge
 
 cd "$clone_dir" || { echo "$0: cannot cd to $clone_dir"; exit 2; }
 
+if [ -n "$VERBOSE" ] ; then
+  echo "$0: about to run: git checkout $branch1 in $(pwd)"
+  echo "$0: about to run: git checkout $branch1 in $(pwd)" >&2
+fi
 git checkout "$branch1" --force
+if [ -n "$VERBOSE" ] ; then
+  echo "$0: ran: git checkout $branch1 in $(pwd)"
+  echo "$0: ran: git checkout $branch1 in $(pwd)" >&2
+fi
 git config --local merge.conflictstyle diff3
 git config --local mergetool.prompt false
 
-echo "Running: git merge --no-edit $git_strategy $branch2"
+echo "$0: about to run: git merge --no-edit $git_strategy $branch2 in $(pwd)"
+echo "$0: about to run: git merge --no-edit $git_strategy $branch2 in $(pwd)" >&2
+
 # shellcheck disable=SC2086
 git merge --no-edit $git_strategy "$branch2"
 retVal=$?
 
+if [ -n "$VERBOSE" ] ; then
+  echo "$0: ran: git merge --no-edit $git_strategy $branch2 in $(pwd)"
+  echo "$0: ran: git merge --no-edit $git_strategy $branch2 in $(pwd)" >&2
+fi
+
 # report conflicts
 if [ $retVal -ne 0 ]; then
     echo "gitmerge.sh: Conflict after running: git merge --no-edit $git_strategy $branch2"

src/scripts/merge_tools/gitmerge_ort.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./gitmerge_ort.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/gitmerge_ort_ignorespace.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./gitmerge_ort_ignorespace.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/gitmerge_recursive_histogram.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./gitmerge_recursive_histogram.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/gitmerge_recursive_histogram_plus.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./gitmerge_recursive_histogram_plus.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/gitmerge_recursive_ignorespace.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./gitmerge_recursive_ignorespace.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_DIR="$(dirname "$0")"
 clone_dir=$1

src/scripts/merge_tools/gitmerge_recursive_ignorespace_plus.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./gitmerge_recursive_ignorespace_plus.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/gitmerge_recursive_minimal.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./gitmerge_recursive_minimal.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/gitmerge_recursive_minimal_plus.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./gitmerge_recursive_minimal_plus.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/gitmerge_recursive_myers.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./gitmerge_recursive_myers.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/gitmerge_recursive_myers_plus.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./gitmerge_recursive_myers_plus.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/gitmerge_recursive_patience.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./gitmerge_recursive_patience.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/gitmerge_recursive_patience_plus.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./gitmerge_recursive_patience_plus.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/gitmerge_resolve.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# usage: ./gitmerge_resolve.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/gitmerge_resolve_plus.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./gitmerge_resolve_plus.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/imports.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./imports.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/imports_ignorespace.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./imports_ignorespace.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/intellimerge.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./intellimerge.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 # <clone_dir> must contain a clone of a repository.
 # Merges branch2 into branch1, in <clone_dir>.
 # Return code is 0 for merge success, 1 for merge failure, 2 for script failure.
@@ -44,13 +44,13 @@ git checkout "$branch1" --force
 git merge --no-edit "$branch2"
 
 # List conflicitng files
-conflict_files=$(git diff --name-only --diff-filter=U)
+git_conflict_files=$(git diff --name-only --diff-filter=U)
 
 # Initialize a flag to track conflict resolution
 conflicts_resolved=true
 
 # Iterate through conflicting files
-for file in $conflict_files; do
+for file in $git_conflict_files; do
     # Check if the conflicting file exists in the temp_out_dir
     if [ ! -f "$temp_out_dir$file" ]; then
         echo "Conflict not resolved for file: $file"
@@ -62,7 +62,7 @@ done
 if [ "$conflicts_resolved" = false ]; then
     echo "Conflict detected. Aborting the merge. Please resolve the conflicts."
     echo "All conflicting files:"
-    echo "$conflict_files"
+    echo "$git_conflict_files"
     rm -rf $temp_out_dir $temp_intellimerge_dir
     exit 1
 fi

src/scripts/merge_tools/intellimerge_plus.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./intellimerge_plus.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/ivn.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./ivn.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1

src/scripts/merge_tools/ivn_ignorespace.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-# usage: ./ivn_ignorespace.sh <clone_dir> <branch-1> <branch-2>
+# usage: <scriptname> <clone_dir> <branch-1> <branch-2>
 
 MERGE_SCRIPTS_DIR="$(cd "$(dirname "$0")" && pwd -P)"
 clone_dir=$1