Skip to content

feature: Stage 4 merge tools use /tmp view of Portage marker (issue #68) #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rich0 merged 1 commit into from
Jul 18, 2026
Merged

feature: Stage 4 merge tools use /tmp view of Portage marker (issue #68) #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 17 additions & 12 deletions cfg-update
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1132,7 +1132,9 @@ sub cleanup_merge_view_temps {
}
}

# Launch merge tool for Stage 3 with disposable /tmp views of ancestor + marker.
# Launch merge tool for Stage 3/4 with disposable /tmp views of non-live inputs.
# Stage 3: ancestor ($path_backup_new) + marker ($path_new). Stage 4: marker only
# (ancestor view is a no-op when the backup file does not exist).
# Temporarily rebinds existing $path_backup_new / $path_new for launch_tool only, then
# restores them so complete/cancel paths still use the real marker and ancestor.
sub launch_tool_with_merge_view_temps { #ARGS# ("pretend|execute","mergetool")
Expand Down Expand Up @@ -1441,7 +1443,7 @@ sub update_stage4{ #ARGS# ("pretend|execute")
if ($key =~ /v|y/) {
&tool_intro($merge_tool_name);
if ($merge_tool_name =~ /^diff$|^sdiff$/) { print "$tab"."$bar2\n"; }
&launch_tool($_[0],$merge_tool);
&launch_tool_with_merge_view_temps($_[0],$merge_tool);
if ($merge_tool_name =~ /^diff$|^sdiff$/) { print "$tab"."$bar2\n"; print "$tab"." To scroll up and down use [Shift]+[PgUp] and [Shift]+[PgDn]\n"; }
if (-e $path_merged) {
if ($tool_saves_mergefile_when_aborted =~ "no") {
Expand Down Expand Up @@ -2006,6 +2008,8 @@ sub tool_intro{ #ARGS# ("mergetoolname")
print "$tab"." press [enter] to view all merge/edit options\n";
print "$tab"." press [l],[enter] to select the left line(s) from the current file\n";
print "$tab"." press [r],[enter] to select the right line(s) from the new file\n";
print "$tab"." The right (new-file) side is a temporary copy; accidental edits there\n";
print "$tab"." are discarded. Save the merge output only.\n";
print "$tab"." When $_[0] is done, $progname will ask if you want to complete or cancel\n";
print "$tab"." the update...\n";
} elsif ($_[0] =~ /^diff3$/) {
Expand All @@ -2017,14 +2021,14 @@ sub tool_intro{ #ARGS# ("mergetoolname")
print "$tab"." In $_[0] you select the lines that you want to keep by simply\n";
print "$tab"." clicking on the colored lines. They will appear in the merge-pane.\n";
print "$tab"." When done, click the M-button to save the result, then exit $_[0]!\n";
print "$tab"." In 3-way mode the ancestor and new-file panes are temporary copies;\n";
print "$tab"." accidental edits there are discarded. Save the merge output only.\n";
print "$tab"." The new-file pane is a temporary copy (in 3-way mode the ancestor pane\n";
print "$tab"." is too); accidental edits there are discarded. Save the merge output only.\n";
print "$tab"." When you exit $_[0], $progname will finish the update.\n";
} elsif ($_[0] =~ /^kdiff3$/) {
print "$tab"." In $_[0] you select the lines that you want to keep.\n";
print "$tab"." When done, click the save button and exit $_[0]!\n";
print "$tab"." In 3-way mode the ancestor and new-file panes are temporary copies;\n";
print "$tab"." accidental edits there are discarded. Save the merge output only.\n";
print "$tab"." The new-file pane is a temporary copy (in 3-way mode the ancestor pane\n";
print "$tab"." is too); accidental edits there are discarded. Save the merge output only.\n";
print "$tab"." When you exit $_[0], $progname will finish the update...\n";
} elsif ($_[0] =~ /^kompare$/) {
print "$tab"." In $_[0] you select the lines that you want to keep.\n";
Expand All @@ -2042,25 +2046,26 @@ sub tool_intro{ #ARGS# ("mergetoolname")
print "$tab"." press [esc] return to command mode (when in edit mode)\n";
print "$tab"." press [:][q][a][!] to close $_[0] without saving\n";
print "$tab"." press [:][w][q][a] to save changes and close $_[0]\n";
print "$tab"." The right (new-file) window is a temporary copy; edit the left (live) window only.\n";
print "$tab"." When you exit $_[0], $progname will finish the update...\n";
} elsif ($_[0] =~ /^meld$/) {
print "$tab"." In $_[0] you select the lines that you want to keep.\n";
print "$tab"." When done, save the merged result over the current configfile by\n";
print "$tab"." right-clicking on the left pane and chosing \"Save\"!\n";
print "$tab"." In 3-way mode the middle (ancestor) and right (new) panes are\n";
print "$tab"." temporary copies; accidental edits there are discarded.\n";
print "$tab"." The new-file pane is a temporary copy (in 3-way mode the middle ancestor\n";
print "$tab"." pane is too); accidental edits there are discarded.\n";
print "$tab"." When you exit $_[0], $progname will finish the update...\n";
} elsif ($_[0] =~ /^tkdiff$/) {
print "$tab"." In $_[0] you select the lines that you want to keep.\n";
print "$tab"." When done, save the merged result with the \"Save & Exit\" button!\n";
print "$tab"." In 3-way mode the ancestor and new-file panes are temporary copies;\n";
print "$tab"." accidental edits there are discarded. Save the merge output only.\n";
print "$tab"." The new-file pane is a temporary copy (in 3-way mode the ancestor pane\n";
print "$tab"." is too); accidental edits there are discarded. Save the merge output only.\n";
print "$tab"." When you exit $_[0], $progname will finish the update...\n";
} elsif ($_[0] =~ /^imediff$/) {
print "$tab"." In $_[0] you select the lines that you want to keep.\n";
print "$tab"." When done, the merged result is written to the *.merge output file.\n";
print "$tab"." In 3-way mode the ancestor and new-file inputs are temporary copies;\n";
print "$tab"." accidental edits there are discarded.\n";
print "$tab"." The new-file input is a temporary copy (in 3-way mode the ancestor input\n";
print "$tab"." is too); accidental edits there are discarded.\n";
print "$tab"." When you exit $_[0], $progname will finish the update...\n";
} else {
print "$tab"." In $_[0] you select the lines that you want to keep.\n";
Expand Down
4 changes: 3 additions & 1 deletion docs/ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,12 +176,14 @@ No conflict markers → apply merged result. Conflict → defer to stage 3.

Launches the configured merge tool with ancestor, live, and new files. Requires a tool with 3-way support (meld, kdiff3, xxdiff, tkdiff, imediff).

For Stage 3, the ancestor (`$path_backup_new`) and Portage marker (`$path_new`) are each copied via `make_merge_view_temp` to disposable files under `/tmp` (or `$TMPDIR`) before the tool runs, so accidental saves on non-live panes cannot corrupt permanent backups or markers. The live file and `*.merge` output paths remain real. See issue #65. Stage 4 marker-only views are tracked in issue #68.
For Stage 3, the ancestor (`$path_backup_new`) and Portage marker (`$path_new`) are each copied via `make_merge_view_temp` to disposable files under `/tmp` (or `$TMPDIR`) before the tool runs, so accidental saves on non-live panes cannot corrupt permanent backups or markers. The live file and `*.merge` output paths remain real. See issue #65.

### Stage 4 — Manual 2-way merge (`update_stage4`)

Merges live file and `._cfg*` update when no backup exists. Works with all supported tools.

For Stage 4, the Portage marker (`$path_new`) is copied via `make_merge_view_temp` to a disposable file under `/tmp` (or `$TMPDIR`) before the interactive tool runs (same helper as Stage 3; ancestor view is a no-op when no backup ancestor exists). Accidental saves on the new-file pane cannot corrupt the real `._cfg*` marker. The live file and `*.merge` output paths remain real. See issue #68.

### Stage 5 — Manual special cases (`update_stage5`)

Interactive prompts for binaries, symlinks, and custom files.
Expand Down
144 changes: 137 additions & 7 deletions test/run-tests.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,13 +411,22 @@ case "${#files[@]}" in
echo "ANCESTOR=${files[1]}" >>"$log"
echo "NEW=${files[2]}" >>"$log"
;;
2) echo "TWO_WAY=yes" >>"$log" ;;
2)
echo "TWO_WAY=yes" >>"$log"
echo "LIVE=${files[0]}" >>"$log"
echo "NEW=${files[1]}" >>"$log"
;;
esac
# Hostile mode: overwrite tool inputs to simulate accidental pane saves (issue #65).
if [[ "${CFG_UPDATE_MOCK_TRASH_INPUTS:-}" == "1" && ${#files[@]} -eq 3 ]]; then
[[ -f "${files[1]}" ]] && echo "TRASHED-ANCESTOR" >"${files[1]}"
[[ -f "${files[2]}" ]] && echo "TRASHED-NEW" >"${files[2]}"
echo "TRASHED_INPUTS=yes" >>"$log"
# Hostile mode: overwrite tool inputs to simulate accidental pane saves (issues #65/#68).
if [[ "${CFG_UPDATE_MOCK_TRASH_INPUTS:-}" == "1" ]]; then
if [[ ${#files[@]} -eq 3 ]]; then
[[ -f "${files[1]}" ]] && echo "TRASHED-ANCESTOR" >"${files[1]}"
[[ -f "${files[2]}" ]] && echo "TRASHED-NEW" >"${files[2]}"
echo "TRASHED_INPUTS=yes" >>"$log"
elif [[ ${#files[@]} -eq 2 ]]; then
[[ -f "${files[1]}" ]] && echo "TRASHED-NEW" >"${files[1]}"
echo "TRASHED_INPUTS=yes" >>"$log"
fi
fi
if [[ -n "$outfile" && -f "${CFG_UPDATE_TEST_SANDBOX}/golden.merge" ]]; then
cp "${CFG_UPDATE_TEST_SANDBOX}/golden.merge" "$outfile"
Expand All @@ -437,13 +446,32 @@ install_mock_sdiff() {
log="${CFG_UPDATE_TEST_SANDBOX}/mock-sdiff.log"
echo "$*" >>"$log"
outfile=""
files=()
while [[ $# -gt 0 ]]; do
case "$1" in
-o) outfile="$2"; shift 2 ;;
*) shift ;;
-w) shift 2 ;; # -w WIDTH
-d) shift ;; # flag, no arg
-*) shift ;;
*) files+=("$1"); shift ;;
esac
done
# sdiff -w WIDTH -d -o OUT live new → remaining args are live/new
echo "TWO_WAY=yes" >>"$log"
if [[ ${#files[@]} -ge 2 ]]; then
echo "LIVE=${files[0]}" >>"$log"
echo "NEW=${files[1]}" >>"$log"
elif [[ ${#files[@]} -eq 1 ]]; then
echo "NEW=${files[0]}" >>"$log"
fi
# Hostile mode: trash new-file pane (issue #68).
if [[ "${CFG_UPDATE_MOCK_TRASH_INPUTS:-}" == "1" && ${#files[@]} -ge 2 ]]; then
[[ -f "${files[1]}" ]] && echo "TRASHED-NEW" >"${files[1]}"
echo "TRASHED_INPUTS=yes" >>"$log"
elif [[ "${CFG_UPDATE_MOCK_TRASH_INPUTS:-}" == "1" && ${#files[@]} -eq 1 ]]; then
[[ -f "${files[0]}" ]] && echo "TRASHED-NEW" >"${files[0]}"
echo "TRASHED_INPUTS=yes" >>"$log"
fi
if [[ -n "$outfile" && -f "${CFG_UPDATE_TEST_SANDBOX}/golden.merge" ]]; then
cp "${CFG_UPDATE_TEST_SANDBOX}/golden.merge" "$outfile"
fi
Expand Down Expand Up @@ -932,6 +960,23 @@ tier_d_execute_manual() {
"$FIXTURES/stage4-manual-2way/expected/test_manual_2way"
assert_missing "stage4 mock merge removed cfg0000 marker" \
"$SANDBOX/etc/test/._cfg0000_test_manual_2way"
# Stage 4: new-file arg is disposable /tmp view (issue #68), not real marker
local real_marker_s4
real_marker_s4="$SANDBOX/etc/test/._cfg0000_test_manual_2way"
# Marker already removed after complete; re-run path asserts with kdiff3 below.
assert_file_contains "stage4 sdiff new arg is merge-view temp" \
"$SANDBOX/mock-sdiff.log" "NEW=${SANDBOX}/tmp/cfg-update-"
if grep -q "NEW=${real_marker_s4}" "$SANDBOX/mock-sdiff.log" 2>/dev/null; then
fail "stage4 sdiff must not pass real marker path"
else
pass "stage4 sdiff did not pass real marker path"
fi
leftover="$(find "$SANDBOX/tmp" -name 'cfg-update-*' 2>/dev/null | wc -l)"
if [[ "$leftover" -eq 0 ]]; then
pass "stage4 sdiff cleaned up merge-view temps"
else
fail "stage4 sdiff left $leftover merge-view temp(s) under TMPDIR"
fi

# Stage 4: mock imediff must run 2-way merge (-a -o live new)
setup_sandbox stage4-manual-2way stage4_only
Expand All @@ -955,6 +1000,91 @@ tier_d_execute_manual() {
"$FIXTURES/stage4-manual-2way/expected/test_manual_2way"
assert_missing "stage4 mock imediff merge removed cfg0000 marker" \
"$SANDBOX/etc/test/._cfg0000_test_manual_2way"
assert_file_contains "stage4 imediff new arg is merge-view temp" \
"$SANDBOX/mock-imediff.log" "NEW=${SANDBOX}/tmp/cfg-update-"
if grep -q "NEW=${real_marker_s4}" "$SANDBOX/mock-imediff.log" 2>/dev/null; then
fail "stage4 imediff must not pass real marker path"
else
pass "stage4 imediff did not pass real marker path"
fi

# Stage 4: mock kdiff3 2-way — path assert + cleanup (issue #68)
setup_sandbox stage4-manual-2way stage4_only
install_mock_kdiff3 "$FIXTURES/stage4-manual-2way/expected/test_manual_2way"
sed -i "s|^MERGE_TOOL = .*|MERGE_TOOL = $SANDBOX/bin/kdiff3|" "$SANDBOX/etc/cfg-update.conf"
real_marker_s4="$SANDBOX/etc/test/._cfg0000_test_manual_2way"
output="$(run_cfg_update_stdin $'y\n1\ny\n1\n' -u 2>&1)" || true
# Explicit MERGE_TOOL=kdiff3: no default diff3→sdiff switch (unlike assert_stage_output).
assert_output_matches "stage4 kdiff3 mock merge: stage banner" \
"<< Stage4 >>" "$output"
assert_output_matches "stage4 kdiff3 mock merge: 2-way merge mode" \
'manual 2-way merging, starting' "$output"
assert_output_not_matches "stage4 kdiff3 mock merge: not 3-way mode" \
'manual 3-way merging, starting' "$output"
assert_output_not_matches "stage4 kdiff3 mock merge: no diff3 switch" \
'diff3 cannot be used for this stage, changing to sdiff' "$output"
assert_file_contains "stage4 kdiff3 used 2-way merge" \
"$SANDBOX/mock-kdiff3.log" "THREE_WAY=no"
assert_file_contains "stage4 kdiff3 new arg is merge-view temp" \
"$SANDBOX/mock-kdiff3.log" "NEW=${SANDBOX}/tmp/cfg-update-"
if grep -q "NEW=${real_marker_s4}" "$SANDBOX/mock-kdiff3.log" 2>/dev/null; then
fail "stage4 kdiff3 must not pass real marker path"
else
pass "stage4 kdiff3 did not pass real marker path"
fi
leftover="$(find "$SANDBOX/tmp" -name 'cfg-update-*' 2>/dev/null | wc -l)"
if [[ "$leftover" -eq 0 ]]; then
pass "stage4 kdiff3 cleaned up merge-view temps"
else
fail "stage4 kdiff3 left $leftover merge-view temp(s) under TMPDIR"
fi
assert_file_equals "stage4 kdiff3 mock merge matches golden" \
"$SANDBOX/etc/test/test_manual_2way" \
"$FIXTURES/stage4-manual-2way/expected/test_manual_2way"
assert_missing "stage4 kdiff3 mock merge removed cfg0000 marker" \
"$SANDBOX/etc/test/._cfg0000_test_manual_2way"

# Stage 4: hostile mock trashes new-file view; real marker must survive cancel
setup_sandbox stage4-manual-2way stage4_only
install_mock_kdiff3 # no golden → no $path_merged → cancel/finish prompt
sed -i "s|^MERGE_TOOL = .*|MERGE_TOOL = $SANDBOX/bin/kdiff3|" "$SANDBOX/etc/cfg-update.conf"
real_marker_s4="$SANDBOX/etc/test/._cfg0000_test_manual_2way"
local marker_before_s4 marker_after_s4
marker_before_s4="$(md5sum "$real_marker_s4" | awk '{print $1}')"
# Two markers in fixture (0000 and 0001); cancel first after tool trash, then skip rest.
output="$(CFG_UPDATE_MOCK_TRASH_INPUTS=1 run_cfg_update_stdin $'y\ns\ns\n' -u 2>&1)" || true
assert_file_contains "stage4 hostile mock trashed inputs" \
"$SANDBOX/mock-kdiff3.log" "TRASHED_INPUTS=yes"
marker_after_s4="$(md5sum "$real_marker_s4" | awk '{print $1}')"
if [[ "$marker_before_s4" == "$marker_after_s4" ]]; then
pass "stage4 hostile cancel left real marker intact"
else
fail "stage4 hostile cancel corrupted real marker"
fi
assert_file_exists "stage4 hostile cancel kept cfg marker" "$real_marker_s4"

# Stage 4: hostile mock trashes inputs; successful merge still uses real paths
setup_sandbox stage4-manual-2way stage4_only
install_mock_kdiff3 "$FIXTURES/stage4-manual-2way/expected/test_manual_2way"
sed -i "s|^MERGE_TOOL = .*|MERGE_TOOL = $SANDBOX/bin/kdiff3|" "$SANDBOX/etc/cfg-update.conf"
# Sandbox --ebuild sets tool_saves_mergefile_when_aborted=no, so confirm with [1].
# Two queued markers: complete first merge, then keep/skip second.
output="$(CFG_UPDATE_MOCK_TRASH_INPUTS=1 run_cfg_update_stdin $'y\n1\n2\n' -u 2>&1)" || true
assert_output_matches "stage4 hostile complete: stage banner" \
"<< Stage4 >>" "$output"
assert_output_matches "stage4 hostile complete: 2-way merge mode" \
'manual 2-way merging, starting' "$output"
assert_output_not_matches "stage4 hostile complete: not 3-way mode" \
'manual 3-way merging, starting' "$output"
assert_output_not_matches "stage4 hostile complete: no diff3 switch" \
'diff3 cannot be used for this stage, changing to sdiff' "$output"
assert_file_equals "stage4 hostile complete matches golden" \
"$SANDBOX/etc/test/test_manual_2way" \
"$FIXTURES/stage4-manual-2way/expected/test_manual_2way"
assert_missing "stage4 hostile complete removed cfg0000 marker" \
"$SANDBOX/etc/test/._cfg0000_test_manual_2way"
assert_file_contains "stage4 hostile complete used merge-view temps" \
"$SANDBOX/mock-kdiff3.log" "NEW=${SANDBOX}/tmp/cfg-update-"

# Stage 4: replace (MF, no ancestor — must not run stage 3/5 handlers)
setup_sandbox stage4-manual-2way stage4_only
Expand Down
Loading