diff --git a/src/python/README.md b/src/python/README.md index 1d83ea921d..521ac93a3c 100644 --- a/src/python/README.md +++ b/src/python/README.md @@ -3,7 +3,7 @@ -This directory contains Python scripts designed to facilitate the analysis of merge conflicts using various merge tools. The scripts allow users to recreate merges, analyze conflicts, and compare different merge algorithms' effectiveness. +This directory contains Python scripts designed to facilitate the analysis of merge conflicts using various merge tools. The scripts allow users to recreate merges, analyze conflicts, and compare different merge algorithms' across the base, conflict, and programmer merge. @@ -13,19 +13,21 @@ This directory contains Python scripts designed to facilitate the analysis of me -- `diff3_analysis.py`: This script analyzes merge conflicts for two merge tools on a given conflict. The tool that failed to merge should come first as an argument. +- `diff3_analysis.py`: This script analyzes merge conflicts for two merge tools on a given conflict. +- It is different than the src/python/replay_merge, as it performs a 3 way diff between the base, conflicting branches, and the programmer merge. + +- Outputs the differences between a pair of merge algorithms in a .txt file. -## Prerequisites +## Prerequisites -- Python 3.x installed on your system. -- Necessary Python packages installed (e.g., `pandas`, `GitPython`). +- Necessary Python packages installed inside conda or mamba environment(`pandas`, `GitPython`). diff --git a/src/python/diff3_analysis.py b/src/python/diff3_analysis.py index 6566e38ac0..b085d7b39c 100644 --- a/src/python/diff3_analysis.py +++ b/src/python/diff3_analysis.py @@ -1,5 +1,6 @@ """ Recreates a merge and outputs the diff files for two algorithms for comparison on a given conflict. +Displays base, conflicting branches, and programmer merge. See src/python/README.md for details on usage. """